default_encryption_configurations

Creates, updates, deletes, gets or lists a default_encryption_configurations resource.

Overview

Name	default_encryption_configurations
Type	Resource
Id	aws.iotsitewise.default_encryption_configurations

Fields

The following fields are returned by SELECT queries:

describe_default_encryption_configuration

Name	Datatype	Description
configuration_status	object	The status of the account configuration. This contains the ConfigurationState. If there's an error, it also contains the ErrorDetails.
encryption_type	string	The type of encryption used for the encryption configuration. (SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION)
kms_key_arn	string	The key ARN of the customer managed key used for KMS encryption if you use KMS_BASED_ENCRYPTION. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_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 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 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

describe_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 IoT SiteWise User Guide.

SELECT
configuration_status,
encryption_type,
kms_key_arn
FROM aws.iotsitewise.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 IoT SiteWise User Guide.

REPLACE aws.iotsitewise.default_encryption_configurations
SET 
encryptionType = '{{ encryptionType }}',
kmsKeyId = '{{ kmsKeyId }}'
WHERE 
region = '{{ region }}' --required
AND encryptionType = '{{ encryptionType }}' --required
RETURNING
configuration_status,
encryption_type,
kms_key_arn;