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
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.Elasticsearch.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty : CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty
Syntax (vb)
Public Class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty Implements CfnDomainPropsMixin.IEncryptionAtRestOptionsProperty
Remarks
The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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.Mixins.Preview.AWS.Elasticsearch.Mixins;

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

The KMS key ID.

Constructors

EncryptionAtRestOptionsProperty()

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

public EncryptionAtRestOptionsProperty()
Remarks
The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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.Mixins.Preview.AWS.Elasticsearch.Mixins;

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

Properties

Enabled

Specify true to enable encryption at rest.

public object? Enabled { get; set; }
Property Value

object

Remarks

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

Type union: either bool or IResolvable

KmsKeyId

The KMS key ID.

public string? KmsKeyId { get; set; }
Property Value

string

Remarks

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

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

Implements