default_encryption_configurations
Creates, updates, deletes, gets or lists a default_encryption_configurations resource.
Overview
| Name | default_encryption_configurations |
| Type | Resource |
| Id | aws.iot_managed_integrations.default_encryption_configurations |
Fields
The following fields are returned by SELECT queries:
- get_default_encryption_configuration
| Name | Datatype | Description |
|---|---|---|
configuration_status | object | Provides the status of the default encryption configuration for an Amazon Web Services account. |
encryption_type | string | The type of encryption used for the encryption configuration. (MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION, CUSTOMER_KEY_ENCRYPTION) |
kms_key_arn | string | The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION. (pattern: <code>arn:aws:kms:[0-9a-zA-Z-]+:[0-9]+:key/[0-9a-zA-Z-]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_default_encryption_configuration | select | region | Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide. | |
put_default_encryption_configuration | replace | region, encryptionType | Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User 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
- get_default_encryption_configuration
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.
SELECT
configuration_status,
encryption_type,
kms_key_arn
FROM aws.iot_managed_integrations.default_encryption_configurations
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_default_encryption_configuration
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.
REPLACE aws.iot_managed_integrations.default_encryption_configurations
SET
encryptionType = '{{ encryptionType }}',
kmsKeyArn = '{{ kmsKeyArn }}'
WHERE
region = '{{ region }}' --required
AND encryptionType = '{{ encryptionType }}' --required
RETURNING
configuration_status,
encryption_type,
kms_key_arn;