Package software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless

Interface CfnCollectionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollectionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.020Z")
@Stability(Stable)
public interface CfnCollectionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCollectionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.*;
 CfnCollectionMixinProps cfnCollectionMixinProps = CfnCollectionMixinProps.builder()
         .collectionGroupName("collectionGroupName")
         .description("description")
         .encryptionConfig(EncryptionConfigProperty.builder()
                 .awsOwnedKey(false)
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .name("name")
         .standbyReplicas("standbyReplicas")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCollectionMixinProps.Builder	builder()
default String	getCollectionGroupName()	The name of the collection group to associate with the collection.
default String	getDescription()	A description of the collection.
default Object	getEncryptionConfig()	Encryption settings for the collection.
default String	getName()	The name of the collection.
default String	getStandbyReplicas()	Indicates whether to use standby replicas for the collection.
default List<CfnTag>	getTags()	An arbitrary set of tags (key–value pairs) to associate with the collection.
default String	getType()	The type of collection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionGroupName

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

The name of the collection group to associate with the collection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-collectiongroupname

getDescription

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

A description of the collection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-description

getEncryptionConfig

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

Encryption settings for the collection.

Returns union: either IResolvable or CfnCollectionPropsMixin.EncryptionConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-encryptionconfig

getName

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

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 (-)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-name

getStandbyReplicas

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-standbyreplicas

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An arbitrary set of tags (key–value pairs) to associate with the collection.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-tags

getType

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

The type of collection.

Possible values are SEARCH , TIMESERIES , and VECTORSEARCH . For more information, see Choosing a collection type .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-type

builder

@Stability(Stable)
static CfnCollectionMixinProps.Builder builder()

Returns:

a CfnCollectionMixinProps.Builder of CfnCollectionMixinProps