Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollectionIndex.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnCollectionIndex.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionIndex>

Enclosing class:

CfnCollectionIndex

@Stability(Stable)
public static final class CfnCollectionIndex.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCollectionIndex>

A fluent builder for CfnCollectionIndex.

Method Summary

Modifier and Type	Method	Description
CfnCollectionIndex	build()
static CfnCollectionIndex.Builder	create(software.constructs.Construct scope, String id)
CfnCollectionIndex.Builder	id(String id)	The identifier of the collection.
CfnCollectionIndex.Builder	indexName(String indexName)	The name of the collection index.
CfnCollectionIndex.Builder	indexSchema(String indexSchema)	The Mappings for the collection index.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCollectionIndex.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnCollectionIndex.Builder.

id

@Stability(Stable)
public CfnCollectionIndex.Builder id(String id)

The identifier of the collection.

Parameters:

id - The identifier of the collection. This parameter is required.

Returns:

this

See Also:

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

indexName

@Stability(Stable)
public CfnCollectionIndex.Builder indexName(String indexName)

The name of the collection index.

Parameters:

indexName - The name of the collection index. This parameter is required.

Returns:

this

See Also:

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

indexSchema

@Stability(Stable)
public CfnCollectionIndex.Builder indexSchema(String indexSchema)

The Mappings for the collection index.

Parameters:

indexSchema - The Mappings for the collection index. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCollectionIndex build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCollectionIndex>

Returns:

a newly built instance of CfnCollectionIndex.