encryption_configurations

Creates, updates, deletes, gets or lists an encryption_configurations resource.

Overview

Name	encryption_configurations
Type	Resource
Id	aws.iotfleetwise.encryption_configurations

Fields

The following fields are returned by SELECT queries:

get_encryption_configuration

Name	Datatype	Description
creation_time	string (date-time)	The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
encryption_status	string	The encryption status. (PENDING, SUCCESS, FAILURE)
encryption_type	string	The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account. (KMS_BASED_ENCRYPTION, FLEETWISE_DEFAULT_ENCRYPTION)
error_message	string	The error message that describes why encryption settings couldn't be configured, if applicable.
kms_key_id	string	The ID of the KMS key that is used for encryption.
last_modification_time	string (date-time)	The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_encryption_configuration	select	region		Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
put_encryption_configuration	replace	region, encryptionType		Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise 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

get_encryption_configuration

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

SELECT
creation_time,
encryption_status,
encryption_type,
error_message,
kms_key_id,
last_modification_time
FROM aws.iotfleetwise.encryption_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_encryption_configuration

Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.

REPLACE aws.iotfleetwise.encryption_configurations
SET 
kmsKeyId = '{{ kmsKeyId }}',
encryptionType = '{{ encryptionType }}'
WHERE 
region = '{{ region }}' --required
AND encryptionType = '{{ encryptionType }}' --required
RETURNING
encryption_status,
encryption_type,
kms_key_id;