Skip to content
v2.278.0

EncryptionConfigProperty Struct ​

Encryption settings for the collection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const encryptionConfigProperty: opensearchserverless.CfnCollection.EncryptionConfigProperty = {
  awsOwnedKey: false,
  kmsKeyArn: 'kmsKeyArn',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opensearchserverless as opensearchserverless

encryption_config_property = opensearchserverless.CfnCollection.EncryptionConfigProperty(
    aws_owned_key=False,
    kms_key_arn="kmsKeyArn"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.opensearchserverless.*;

EncryptionConfigProperty encryptionConfigProperty = EncryptionConfigProperty.builder()
        .awsOwnedKey(false)
        .kmsKeyArn("kmsKeyArn")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpenSearchServerless;

var encryptionConfigProperty = new EncryptionConfigProperty {
    AwsOwnedKey = false,
    KmsKeyArn = "kmsKeyArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionConfigProperty := &EncryptionConfigProperty{
	AwsOwnedKey: jsii.Boolean(false),
	KmsKeyArn: jsii.String("kmsKeyArn"),
}

Properties ​

awsOwnedKeyoptionalboolean | IResolvableaws_owned_keyoptionaltyping.Union[bool, IResolvable]awsOwnedKeyoptionalBooleanAwsOwnedKeyoptionalboolAwsOwnedKeyoptionalinterface{} #
Indicates whether to use an AWS owned key for encryption.
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string #
Key Management Service key used to encrypt the collection.