Class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

Inheritance

object

CfnDomainPropsMixin.EncryptionAtRestOptionsProperty

Implements

CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty

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.OpenSearchService

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty : CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty

Syntax (vb)

Public Class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty Implements CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.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.OpenSearchService;

             var encryptionAtRestOptionsProperty = new EncryptionAtRestOptionsProperty {
                 Enabled = false,
                 KmsKeyId = "kmsKeyId"
             };

Synopsis

Constructors

EncryptionAtRestOptionsProperty()

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

Properties

Enabled	Specify `true` to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .
KmsKeyId	The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` . Required if you enable encryption at rest.

Constructors

EncryptionAtRestOptionsProperty()

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

public EncryptionAtRestOptionsProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.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.OpenSearchService;

             var encryptionAtRestOptionsProperty = new EncryptionAtRestOptionsProperty {
                 Enabled = false,
                 KmsKeyId = "kmsKeyId"
             };

Properties

Enabled

Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .

public object? Enabled { get; set; }

Property Value

object

Remarks

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html#cfn-opensearchservice-domain-encryptionatrestoptions-enabled

Type union: either bool or IResolvable

KmsKeyId

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.

public object? KmsKeyId { get; set; }

Property Value

object

Remarks

You can also use keyAlias as a value.

Type union: either string or IKeyRef

Implements

CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty