interface EncryptionAtRestOptionsProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty |
 Java | software.amazon.awscdk.services.elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty |
 Python | aws_cdk.aws_elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty |
 TypeScript | @aws-cdk/aws-elasticsearch » CfnDomain » EncryptionAtRestOptionsProperty |
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
The
AWS::Elasticsearch::Domainresource is being replaced by the AWS::OpenSearchService::Domain 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 New resource types in the Amazon OpenSearch Service Developer Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elasticsearch from '@aws-cdk/aws-elasticsearch';
const encryptionAtRestOptionsProperty: elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty = {
enabled: false,
kmsKeyId: 'kmsKeyId',
};
Properties
| Name | Type | Description |
|---|---|---|
| enabled? | boolean | IResolvable | Specify true to enable encryption at rest. |
| kms | string | The KMS key ID. |
enabled?
Type:
boolean | IResolvable
(optional)
Specify true to enable encryption at rest.
kmsKeyId?
Type:
string
(optional)
The KMS key ID.
Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.