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

Class CfnCollectionPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.CfnCollectionPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.021Z")
@Stability(Stable)
public class CfnCollectionPropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies an OpenSearch Serverless collection.

For more information, see Creating and managing Amazon OpenSearch Serverless collections in the Amazon OpenSearch Service Developer Guide .

You must create a matching encryption policy in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the DependsOn attribute. See Examples for a sample template. Otherwise the encryption policy must already exist before you create the collection.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnCollectionPropsMixin cfnCollectionPropsMixin = CfnCollectionPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnCollectionPropsMixin.Builder	A fluent builder for CfnCollectionPropsMixin.
static interface	CfnCollectionPropsMixin.EncryptionConfigProperty	Encryption settings for the collection.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnCollectionPropsMixin(CfnCollectionMixinProps props)	Create a mixin to apply properties to AWS::OpenSearchServerless::Collection.
	CfnCollectionPropsMixin(CfnCollectionMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::OpenSearchServerless::Collection.
protected	CfnCollectionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCollectionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnCollectionMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnCollectionPropsMixin

protected CfnCollectionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnCollectionPropsMixin

protected CfnCollectionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCollectionPropsMixin

@Stability(Stable)
public CfnCollectionPropsMixin(@NotNull
 CfnCollectionMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::OpenSearchServerless::Collection.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnCollectionPropsMixin

@Stability(Stable)
public CfnCollectionPropsMixin(@NotNull
 CfnCollectionMixinProps props)

Create a mixin to apply properties to AWS::OpenSearchServerless::Collection.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnCollectionMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()