CfnEncryptionConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnEncryptionConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

Retrieves the encryption configuration for resources and data of your AWS account in AWS IoT Core .

For more information, see Data encryption at rest in the AWS IoT Core Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-encryptionconfiguration.html
CloudformationResource:: AWS::IoT::EncryptionConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

cfn_encryption_configuration_props_mixin = iot_mixins.CfnEncryptionConfigurationPropsMixin(iot_mixins.CfnEncryptionConfigurationMixinProps(
    encryption_type="encryptionType",
    kms_access_role_arn="kmsAccessRoleArn",
    kms_key_arn="kmsKeyArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::EncryptionConfiguration.

Parameters:

props (Union[CfnEncryptionConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['encryptionType', 'kmsAccessRoleArn', 'kmsKeyArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigurationDetailsProperty

class CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty(*, configuration_status=None, error_code=None, error_message=None)

Bases: object

The encryption configuration details that include the status information of the AWS Key Management Service ( AWS ) key and the AWS access role.

Parameters:

configuration_status (Optional[str]) – The health status of KMS key and AWS access role. If either KMS key or AWS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
error_code (Optional[str]) – The error code that indicates either the KMS key or the AWS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
error_message (Optional[str]) – The detailed error message that corresponds to the errorCode .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

configuration_details_property = iot_mixins.CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty(
    configuration_status="configurationStatus",
    error_code="errorCode",
    error_message="errorMessage"
)

Attributes

configuration_status

The health status of KMS key and AWS access role.

If either KMS key or AWS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-configurationstatus

error_code

The error code that indicates either the KMS key or the AWS access role is UNHEALTHY .

Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errorcode

error_message

The detailed error message that corresponds to the errorCode .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errormessage