Class CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty

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

Inheritance

object

CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty

Implements

CfnEncryptionConfigurationPropsMixin.IConfigurationDetailsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoT

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty : CfnEncryptionConfigurationPropsMixin.IConfigurationDetailsProperty

Syntax (vb)

Public Class CfnEncryptionConfigurationPropsMixin.ConfigurationDetailsProperty Implements CfnEncryptionConfigurationPropsMixin.IConfigurationDetailsProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var configurationDetailsProperty = new ConfigurationDetailsProperty {
                 ConfigurationStatus = "configurationStatus",
                 ErrorCode = "errorCode",
                 ErrorMessage = "errorMessage"
             };

Synopsis

Constructors

ConfigurationDetailsProperty()

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

Properties

ConfigurationStatus	The health status of KMS key and AWS access role.
ErrorCode	The error code that indicates either the KMS key or the AWS access role is `UNHEALTHY` .
ErrorMessage	The detailed error message that corresponds to the `errorCode` .

Constructors

ConfigurationDetailsProperty()

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

public ConfigurationDetailsProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var configurationDetailsProperty = new ConfigurationDetailsProperty {
                 ConfigurationStatus = "configurationStatus",
                 ErrorCode = "errorCode",
                 ErrorMessage = "errorMessage"
             };

Properties

ConfigurationStatus

The health status of KMS key and AWS access role.

public string? ConfigurationStatus { get; set; }

Property Value

string

Remarks

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

ErrorCode

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

public string? ErrorCode { get; set; }

Property Value

string

Remarks

Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .

ErrorMessage

The detailed error message that corresponds to the errorCode .

public string? ErrorMessage { get; set; }