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

Class CfnCollectionIndexPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.CfnCollectionIndexPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionIndexPropsMixin>

Enclosing class:

CfnCollectionIndexPropsMixin

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

A fluent builder for CfnCollectionIndexPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCollectionIndexPropsMixin	build()
static CfnCollectionIndexPropsMixin.Builder	create()
static CfnCollectionIndexPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCollectionIndexPropsMixin.Builder	id(String id)	The identifier of the collection.
CfnCollectionIndexPropsMixin.Builder	indexName(String indexName)	The name of the collection index.
CfnCollectionIndexPropsMixin.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 CfnCollectionIndexPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCollectionIndexPropsMixin.Builder.

create

@Stability(Stable)
public static CfnCollectionIndexPropsMixin.Builder create()

Returns:

a new instance of CfnCollectionIndexPropsMixin.Builder.

id

@Stability(Stable)
public CfnCollectionIndexPropsMixin.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 CfnCollectionIndexPropsMixin.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 CfnCollectionIndexPropsMixin.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 CfnCollectionIndexPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnCollectionIndexPropsMixin.