CfnCollectionProps Struct
Properties for defining a CfnCollection.
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 cfnCollectionProps: opensearchserverless.CfnCollectionProps = {
name: 'name',
// the properties below are optional
collectionGroupName: 'collectionGroupName',
deletionProtection: 'deletionProtection',
description: 'description',
encryptionConfig: {
awsOwnedKey: false,
kmsKeyArn: 'kmsKeyArn',
},
standbyReplicas: 'standbyReplicas',
tags: [{
key: 'key',
value: 'value',
}],
type: 'type',
vectorOptions: {
serverlessVectorAcceleration: 'serverlessVectorAcceleration',
},
};
python
from aws_cdk import CfnTag
# 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
cfn_collection_props = opensearchserverless.CfnCollectionProps(
name="name",
# the properties below are optional
collection_group_name="collectionGroupName",
deletion_protection="deletionProtection",
description="description",
encryption_config=opensearchserverless.CfnCollection.EncryptionConfigProperty(
aws_owned_key=False,
kms_key_arn="kmsKeyArn"
),
standby_replicas="standbyReplicas",
tags=[CfnTag(
key="key",
value="value"
)],
type="type",
vector_options=opensearchserverless.CfnCollection.VectorOptionsProperty(
serverless_vector_acceleration="serverlessVectorAcceleration"
)
)
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.*;
CfnCollectionProps cfnCollectionProps = CfnCollectionProps.builder()
.name("name")
// the properties below are optional
.collectionGroupName("collectionGroupName")
.deletionProtection("deletionProtection")
.description("description")
.encryptionConfig(EncryptionConfigProperty.builder()
.awsOwnedKey(false)
.kmsKeyArn("kmsKeyArn")
.build())
.standbyReplicas("standbyReplicas")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.type("type")
.vectorOptions(VectorOptionsProperty.builder()
.serverlessVectorAcceleration("serverlessVectorAcceleration")
.build())
.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 cfnCollectionProps = new CfnCollectionProps {
Name = "name",
// the properties below are optional
CollectionGroupName = "collectionGroupName",
DeletionProtection = "deletionProtection",
Description = "description",
EncryptionConfig = new EncryptionConfigProperty {
AwsOwnedKey = false,
KmsKeyArn = "kmsKeyArn"
},
StandbyReplicas = "standbyReplicas",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type",
VectorOptions = new VectorOptionsProperty {
ServerlessVectorAcceleration = "serverlessVectorAcceleration"
}
};
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"
cfnCollectionProps := &CfnCollectionProps{
Name: jsii.String("name"),
// the properties below are optional
CollectionGroupName: jsii.String("collectionGroupName"),
DeletionProtection: jsii.String("deletionProtection"),
Description: jsii.String("description"),
EncryptionConfig: &EncryptionConfigProperty{
AwsOwnedKey: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
StandbyReplicas: jsii.String("standbyReplicas"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Type: jsii.String("type"),
VectorOptions: &VectorOptionsProperty{
ServerlessVectorAcceleration: jsii.String("serverlessVectorAcceleration"),
},
}
Properties
collectionGroupNameoptionalstringcollection_group_nameoptionalstrcollectionGroupNameoptionalStringCollectionGroupNameoptionalstringCollectionGroupNameoptional*string#The name of the collection group to associate with the collection.
deletionProtectionoptionalstringdeletion_protectionoptionalstrdeletionProtectionoptionalStringDeletionProtectionoptionalstringDeletionProtectionoptional*string#The deletion protection state of the collection.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the collection.
encryptionConfigoptionalIResolvable | CfnCollection.EncryptionConfigPropertyencryption_configoptionaltyping.Union[IResolvable, EncryptionConfigProperty]encryptionConfigoptionalIResolvableEncryptionConfigoptionalIResolvableEncryptionConfigoptionalinterface{}#Encryption settings for the collection.
The name of the collection.
Collection names must meet the following criteria:
- Starts with a lowercase letter
- Unique to your account and AWS Region
- Contains between 3 and 28 characters
- Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)
standbyReplicasoptionalstringstandby_replicasoptionalstrstandbyReplicasoptionalStringStandbyReplicasoptionalstringStandbyReplicasoptional*string#Indicates whether to use standby replicas for the collection.
You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An arbitrary set of tags (key–value pairs) to associate with the collection.
For more information, see Tag .
The type of collection.
Possible values are SEARCH , TIMESERIES , and VECTORSEARCH . For more information, see Choosing a collection type .
vectorOptionsoptionalIResolvable | CfnCollection.VectorOptionsPropertyvector_optionsoptionaltyping.Union[IResolvable, VectorOptionsProperty]vectorOptionsoptionalIResolvableVectorOptionsoptionalIResolvableVectorOptionsoptionalinterface{}#Vector search configuration options for the collection.