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

Interface CfnCollectionIndexMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollectionIndexMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-08-19T15:41:38.080Z")
@Stability(Stable)
public interface CfnCollectionIndexMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCollectionIndexPropsMixin.

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.*;
 CfnCollectionIndexMixinProps cfnCollectionIndexMixinProps = CfnCollectionIndexMixinProps.builder()
         .id("id")
         .indexName("indexName")
         .indexSchema("indexSchema")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCollectionIndexMixinProps.Builder	builder()
default String	getId()	The identifier of the collection.
default String	getIndexName()	The name of the collection index.
default String	getIndexSchema()	The Mappings for the collection index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

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

The identifier of the collection.

See Also:

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

getIndexName

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

The name of the collection index.

See Also:

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

getIndexSchema

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

The Mappings for the collection index.

See Also:

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

builder

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

Returns:

a CfnCollectionIndexMixinProps.Builder of CfnCollectionIndexMixinProps