encryption_configurations
Creates, updates, deletes, gets or lists an encryption_configurations resource.
Overview
| Name | encryption_configurations |
| Type | Resource |
| Id | aws.iot.encryption_configurations |
Fields
The following fields are returned by SELECT queries:
- describe_encryption_configuration
| Name | Datatype | Description |
|---|---|---|
configuration_details | object | The encryption configuration details that include the status information of the KMS key and the KMS access role. |
encryption_type | string | The type of the KMS key. (CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY) |
kms_access_role_arn | string | The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Web Services IoT Core to call KMS on behalf of the customer. |
kms_key_arn | string | The ARN of the customer managed KMS key. |
last_modified_date | string (date-time) | The date when encryption configuration is last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_encryption_configuration | select | region | Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide. | |
update_encryption_configuration | update | region, encryptionType | Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account. Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_encryption_configuration
Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
SELECT
configuration_details,
encryption_type,
kms_access_role_arn,
kms_key_arn,
last_modified_date
FROM aws.iot.encryption_configurations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_encryption_configuration
Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account. Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
UPDATE aws.iot.encryption_configurations
SET
encryptionType = '{{ encryptionType }}',
kmsKeyArn = '{{ kmsKeyArn }}',
kmsAccessRoleArn = '{{ kmsAccessRoleArn }}'
WHERE
region = '{{ region }}' --required
AND encryptionType = '{{ encryptionType }}' --required;