Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollection.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnCollection.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollection>

Enclosing class:

CfnCollection

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

A fluent builder for CfnCollection.

Method Summary

Modifier and Type	Method	Description
CfnCollection	build()
static CfnCollection.Builder	create(software.constructs.Construct scope, String id)
CfnCollection.Builder	description(String description)	A description of the collection.
CfnCollection.Builder	name(String name)	The name of the collection.
CfnCollection.Builder	standbyReplicas(String standbyReplicas)	Indicates whether to use standby replicas for the collection.
CfnCollection.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key–value pairs) to associate with the collection.
CfnCollection.Builder	type(String type)	The type of collection.

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 CfnCollection.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 CfnCollection.Builder.

name

@Stability(Stable)
public CfnCollection.Builder name(String name)

The name of the collection.

Collection names must meet the following criteria:

• Starts with a lowercase letter
• Unique to your account and AWS Region
• Contains between 3 and 28 characters
• Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)

Parameters:

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

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnCollection.Builder description(String description)

A description of the collection.

Parameters:

description - A description of the collection. This parameter is required.

Returns:

this

See Also:

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

standbyReplicas

@Stability(Stable)
public CfnCollection.Builder standbyReplicas(String standbyReplicas)

Indicates whether to use standby replicas for the collection.

You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.

Parameters:

standbyReplicas - Indicates whether to use standby replicas for the collection. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnCollection.Builder tags(List<? extends CfnTag> tags)

An arbitrary set of tags (key–value pairs) to associate with the collection.

For more information, see Tag .

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the collection. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnCollection.Builder type(String type)

The type of collection.

Possible values are SEARCH , TIMESERIES , and VECTORSEARCH . For more information, see Choosing a collection type .

Parameters:

type - The type of collection. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCollection build()

Specified by:

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

Returns:

a newly built instance of CfnCollection.