Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollectionIndex

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opensearchserverless.CfnCollectionIndex

All Implemented Interfaces:

IInspectable, IEnvironmentAware, ICollectionIndexRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-04T12:52:17.238Z")
@Stability(Stable)
public class CfnCollectionIndex
extends CfnResource
implements IInspectable, ICollectionIndexRef

Resource schema for AWS::OpenSearchServerless::CollectionIndex.

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.*;
 CfnCollectionIndex cfnCollectionIndex = CfnCollectionIndex.Builder.create(this, "MyCfnCollectionIndex")
         .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	Class	Description
static final class	CfnCollectionIndex.Builder	A fluent builder for CfnCollectionIndex.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.opensearchserverless.ICollectionIndexRef

ICollectionIndexRef.Jsii$Default, ICollectionIndexRef.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCollectionIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCollectionIndex(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCollectionIndex(software.constructs.Construct scope, String id, CfnCollectionIndexProps props)	Create a new AWS::OpenSearchServerless::CollectionIndex.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
CollectionIndexReference	getCollectionIndexRef()	A reference to a CollectionIndex resource.
String	getId()	The identifier of the collection.
String	getIndexName()	The name of the collection index.
String	getIndexSchema()	The Mappings for the collection index.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnCollectionIndex(Object x)	Checks whether the given object is a CfnCollectionIndex.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setId(String value)	The identifier of the collection.
void	setIndexName(String value)	The name of the collection index.
void	setIndexSchema(String value)	The Mappings for the collection index.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCollectionIndex

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

CfnCollectionIndex

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

CfnCollectionIndex

@Stability(Stable)
public CfnCollectionIndex(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCollectionIndexProps props)

Create a new AWS::OpenSearchServerless::CollectionIndex.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnCollectionIndex

@Stability(Stable)
@NotNull
public static Boolean isCfnCollectionIndex(@NotNull
 Object x)

Checks whether the given object is a CfnCollectionIndex.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getCollectionIndexRef

@Stability(Stable)
@NotNull
public CollectionIndexReference getCollectionIndexRef()

A reference to a CollectionIndex resource.

Specified by:

getCollectionIndexRef in interface ICollectionIndexRef

getId

@Stability(Stable)
@NotNull
public String getId()

The identifier of the collection.

setId

@Stability(Stable)
public void setId(@NotNull
 String value)

The identifier of the collection.

getIndexName

@Stability(Stable)
@NotNull
public String getIndexName()

The name of the collection index.

setIndexName

@Stability(Stable)
public void setIndexName(@NotNull
 String value)

The name of the collection index.

getIndexSchema

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

The Mappings for the collection index.

setIndexSchema

@Stability(Stable)
public void setIndexSchema(@Nullable
 String value)

The Mappings for the collection index.