encryption_configurations

Creates, updates, deletes or gets an encryption_configuration resource or lists encryption_configurations in a region

Overview

Name	encryption_configurations
Type	Resource
Description	Resource Type definition for AWS::IoT::EncryptionConfiguration
Id	awscc.iot.encryption_configurations

Fields

get (all properties)

Name	Datatype	Description
account_id	string
encryption_type	string
kms_access_role_arn	string
kms_key_arn	string
▶configuration_details	object
last_modified_date	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	encryption_configurations	INSERT	EncryptionType, region
delete_resource	encryption_configurations	DELETE	Identifier, region
update_resource	encryption_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	encryption_configurations_list_only	SELECT	region
get_resource	encryption_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual encryption_configuration.

SELECT
  region,
  account_id,
  encryption_type,
  kms_access_role_arn,
  kms_key_arn,
  configuration_details,
  last_modified_date
FROM awscc.iot.encryption_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all encryption_configurations in a region.

SELECT
  region,
  account_id
FROM awscc.iot.encryption_configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iot.encryption_configurations (
  EncryptionType,
  region
)
SELECT
  '{{ encryption_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iot.encryption_configurations (
  EncryptionType,
  KmsAccessRoleArn,
  KmsKeyArn,
  region
)
SELECT
  '{{ encryption_type }}',
  '{{ kms_access_role_arn }}',
  '{{ kms_key_arn }}',
  '{{ 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: encryption_configuration
  props:
    - name: encryption_type
      value: '{{ encryption_type }}'
    - name: kms_access_role_arn
      value: '{{ kms_access_role_arn }}'
    - name: kms_key_arn
      value: '{{ kms_key_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.encryption_configurations
SET PatchDocument = string('{{ {
    "EncryptionType": encryption_type,
    "KmsAccessRoleArn": kms_access_role_arn,
    "KmsKeyArn": kms_key_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iot.encryption_configurations
WHERE
  Identifier = '{{ account_id }}' 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 encryption_configurations resource, the following permissions are required:

Create

iot:UpdateEncryptionConfiguration,
iot:DescribeEncryptionConfiguration,
kms:Encrypt,
kms:Decrypt,
kms:DescribeKey,
iam:PassRole

Read

iot:DescribeEncryptionConfiguration

Update

iot:UpdateEncryptionConfiguration,
iot:DescribeEncryptionConfiguration,
kms:Encrypt,
kms:Decrypt,
kms:DescribeKey,
iam:PassRole

Delete

iot:UpdateEncryptionConfiguration,
iot:DescribeEncryptionConfiguration,
kms:Decrypt

List

iot:DescribeEncryptionConfiguration