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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EncryptionType, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

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 = 'us-east-1' AND data__Identifier = '<AccountId>';

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 
'{{ EncryptionType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.encryption_configurations (
 EncryptionType,
 KmsAccessRoleArn,
 KmsKeyArn,
 region
)
SELECT 
 '{{ EncryptionType }}',
 '{{ KmsAccessRoleArn }}',
 '{{ KmsKeyArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: encryption_configuration
    props:
      - name: EncryptionType
        value: '{{ EncryptionType }}'
      - name: KmsAccessRoleArn
        value: '{{ KmsAccessRoleArn }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'

DELETE example

/*+ delete */
DELETE FROM awscc.iot.encryption_configurations
WHERE data__Identifier = '<AccountId>'
AND region = 'us-east-1';

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