Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollectionGroup.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnCollectionGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionGroup>

Enclosing class:

CfnCollectionGroup

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

A fluent builder for CfnCollectionGroup.

Method Summary

Modifier and Type	Method	Description
CfnCollectionGroup	build()
CfnCollectionGroup.Builder	capacityLimits(IResolvable capacityLimits)
CfnCollectionGroup.Builder	capacityLimits(CfnCollectionGroup.CapacityLimitsProperty capacityLimits)
static CfnCollectionGroup.Builder	create(software.constructs.Construct scope, String id)
CfnCollectionGroup.Builder	description(String description)	The description of the collection group.
CfnCollectionGroup.Builder	generation(String generation)	The generation of Amazon OpenSearch Serverless for the collection group.
CfnCollectionGroup.Builder	name(String name)	The name of the collection group.
CfnCollectionGroup.Builder	standbyReplicas(String standbyReplicas)	Indicates whether standby replicas are used for the collection group.
CfnCollectionGroup.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

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

name

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

The name of the collection group.

Parameters:

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

Returns:

this

See Also:

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

standbyReplicas

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

Indicates whether standby replicas are used for the collection group.

Parameters:

standbyReplicas - Indicates whether standby replicas are used for the collection group. This parameter is required.

Returns:

this

See Also:

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

capacityLimits

@Stability(Stable)
public CfnCollectionGroup.Builder capacityLimits(IResolvable capacityLimits)

Parameters:

capacityLimits - This parameter is required.

Returns:

this

See Also:

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

capacityLimits

@Stability(Stable)
public CfnCollectionGroup.Builder capacityLimits(CfnCollectionGroup.CapacityLimitsProperty capacityLimits)

Parameters:

capacityLimits - This parameter is required.

Returns:

this

See Also:

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

description

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

The description of the collection group.

Parameters:

description - The description of the collection group. This parameter is required.

Returns:

this

See Also:

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

generation

@Stability(Stable)
public CfnCollectionGroup.Builder generation(String generation)

The generation of Amazon OpenSearch Serverless for the collection group.

Valid values are CLASSIC and NEXTGEN.

Parameters:

generation - The generation of Amazon OpenSearch Serverless for the collection group. This parameter is required.

Returns:

this

See Also:

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

tags

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

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCollectionGroup build()

Specified by:

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

Returns:

a newly built instance of CfnCollectionGroup.