Package software.amazon.awscdk.services.opensearchserverless

Interface CfnCollectionIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollectionIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-04T12:52:17.238Z")
@Stability(Stable)
public interface CfnCollectionIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCollectionIndex.

Example:

 // 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.*;
 CfnCollectionIndexProps cfnCollectionIndexProps = CfnCollectionIndexProps.builder()
         .id("id")
         .indexName("indexName")
         // the properties below are optional
         .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	CfnCollectionIndexProps.Builder	A builder for CfnCollectionIndexProps
static final class	CfnCollectionIndexProps.Jsii$Proxy	An implementation for CfnCollectionIndexProps

Method Summary

Modifier and Type	Method	Description
static CfnCollectionIndexProps.Builder	builder()
String	getId()	The identifier of the collection.
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)
@NotNull
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)
@NotNull
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 CfnCollectionIndexProps.Builder builder()

Returns:

a CfnCollectionIndexProps.Builder of CfnCollectionIndexProps