Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.EncryptionAtRestOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.EncryptionAtRestOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.EncryptionAtRestOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.opensearchservice.*;
 EncryptionAtRestOptionsProperty encryptionAtRestOptionsProperty = EncryptionAtRestOptionsProperty.builder()
         .enabled(false)
         .kmsKeyId("kmsKeyId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.EncryptionAtRestOptionsProperty.Builder	A builder for CfnDomain.EncryptionAtRestOptionsProperty
static final class	CfnDomain.EncryptionAtRestOptionsProperty.Jsii$Proxy	An implementation for CfnDomain.EncryptionAtRestOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.EncryptionAtRestOptionsProperty.Builder	builder()
default Object	getEnabled()	Specify true to enable encryption at rest.
default String	getKmsKeyId()	The KMS key ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

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.

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDomain.EncryptionAtRestOptionsProperty.Builder builder()

Returns:

a CfnDomain.EncryptionAtRestOptionsProperty.Builder of CfnDomain.EncryptionAtRestOptionsProperty