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

Class CfnIndexPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexPropsMixin>

Enclosing class:

CfnIndexPropsMixin

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

A fluent builder for CfnIndexPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIndexPropsMixin	build()
CfnIndexPropsMixin.Builder	collectionEndpoint(String collectionEndpoint)	The endpoint for the collection.
static CfnIndexPropsMixin.Builder	create()
static CfnIndexPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIndexPropsMixin.Builder	indexName(String indexName)	The name of the OpenSearch Serverless index.
CfnIndexPropsMixin.Builder	mappings(CfnIndexPropsMixin.MappingsProperty mappings)	Index mappings for the OpenSearch Serverless index.
CfnIndexPropsMixin.Builder	mappings(IResolvable mappings)	Index mappings for the OpenSearch Serverless index.
CfnIndexPropsMixin.Builder	settings(CfnIndexPropsMixin.IndexSettingsProperty settings)	Index settings for the OpenSearch Serverless index.
CfnIndexPropsMixin.Builder	settings(IResolvable settings)	Index settings for the OpenSearch Serverless 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 CfnIndexPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIndexPropsMixin.Builder.

create

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

Returns:

a new instance of CfnIndexPropsMixin.Builder.

collectionEndpoint

@Stability(Stable)
public CfnIndexPropsMixin.Builder collectionEndpoint(String collectionEndpoint)

The endpoint for the collection.

Parameters:

collectionEndpoint - The endpoint for the collection. This parameter is required.

Returns:

this

See Also:

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

indexName

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

The name of the OpenSearch Serverless index.

Parameters:

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

Returns:

this

See Also:

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

mappings

@Stability(Stable)
public CfnIndexPropsMixin.Builder mappings(IResolvable mappings)

Index mappings for the OpenSearch Serverless index.

Parameters:

mappings - Index mappings for the OpenSearch Serverless index. This parameter is required.

Returns:

this

See Also:

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

mappings

@Stability(Stable)
public CfnIndexPropsMixin.Builder mappings(CfnIndexPropsMixin.MappingsProperty mappings)

Index mappings for the OpenSearch Serverless index.

Parameters:

mappings - Index mappings for the OpenSearch Serverless index. This parameter is required.

Returns:

this

See Also:

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

settings

@Stability(Stable)
public CfnIndexPropsMixin.Builder settings(IResolvable settings)

Index settings for the OpenSearch Serverless index.

Parameters:

settings - Index settings for the OpenSearch Serverless index. This parameter is required.

Returns:

this

See Also:

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

settings

@Stability(Stable)
public CfnIndexPropsMixin.Builder settings(CfnIndexPropsMixin.IndexSettingsProperty settings)

Index settings for the OpenSearch Serverless index.

Parameters:

settings - Index settings for the OpenSearch Serverless index. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIndexPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnIndexPropsMixin.