dimensions

Creates, updates, deletes or gets a dimension resource or lists dimensions in a region

Overview

Name	dimensions
Type	Resource
Description	A dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Id	awscc.iot.dimensions

Fields

get (all properties)

Name	Datatype	Description
name	string	A unique identifier for the dimension.
type	string	Specifies the type of the dimension.
string_values	array	Specifies the value or list of values for the dimension.
▶tags	array	Metadata that can be used to manage the dimension.
arn	string	The ARN (Amazon resource name) of the created dimension.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	A unique identifier for the dimension.
region	string	AWS region.

For more information, see AWS::IoT::Dimension.

Methods

Name	Resource	Accessible by	Required Params
create_resource	dimensions	INSERT	Type, StringValues, region
delete_resource	dimensions	DELETE	Identifier, region
update_resource	dimensions	UPDATE	Identifier, PatchDocument, region
list_resources	dimensions_list_only	SELECT	region
get_resource	dimensions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dimension.

SELECT
  region,
  name,
  type,
  string_values,
  tags,
  arn
FROM awscc.iot.dimensions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all dimensions in a region.

SELECT
  region,
  name
FROM awscc.iot.dimensions_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new dimension resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iot.dimensions (
  Type,
  StringValues,
  region
)
SELECT
  '{{ type }}',
  '{{ string_values }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iot.dimensions (
  Name,
  Type,
  StringValues,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ string_values }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: dimension
  props:
    - name: name
      value: '{{ name }}'
    - name: type
      value: '{{ type }}'
    - name: string_values
      value:
        - '{{ string_values[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a dimension resource, using stack-deploy.

/*+ update */
UPDATE awscc.iot.dimensions
SET PatchDocument = string('{{ {
    "StringValues": string_values,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iot.dimensions
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the dimensions resource, the following permissions are required:

Create

iot:CreateDimension,
iot:TagResource

Read

iot:DescribeDimension,
iot:ListTagsForResource

Update

iot:UpdateDimension,
iot:ListTagsForResource,
iot:UntagResource,
iot:TagResource

Delete

iot:DescribeDimension,
iot:DeleteDimension

List

iot:ListDimensions