interface EncryptionAtRestOptionsProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.OpenSearchService.CfnDomain.EncryptionAtRestOptionsProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_EncryptionAtRestOptionsProperty |
 Java | software.amazon.awscdk.services.opensearchservice.CfnDomain.EncryptionAtRestOptionsProperty |
 Python | aws_cdk.aws_opensearchservice.CfnDomain.EncryptionAtRestOptionsProperty |
 TypeScript | aws-cdk-lib » aws_opensearchservice » CfnDomain » EncryptionAtRestOptionsProperty |
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const encryptionAtRestOptionsProperty: opensearchservice.CfnDomain.EncryptionAtRestOptionsProperty = {
enabled: false,
kmsKeyId: 'kmsKeyId',
};
Properties
| Name | Type | Description |
|---|---|---|
| enabled? | boolean | IResolvable | Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput . |
| kms | string | The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest. |
enabled?
Type:
boolean | IResolvable
(optional)
Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .
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.
kmsKeyId?
Type:
string
(optional)
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.
You can also use keyAlias as a value.
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.