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

Class CfnCollectionPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionPropsMixin>

Enclosing class:

CfnCollectionPropsMixin

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

A fluent builder for CfnCollectionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCollectionPropsMixin	build()
CfnCollectionPropsMixin.Builder	collectionGroupName(String collectionGroupName)	The name of the collection group to associate with the collection.
static CfnCollectionPropsMixin.Builder	create()
static CfnCollectionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCollectionPropsMixin.Builder	description(String description)	A description of the collection.
CfnCollectionPropsMixin.Builder	encryptionConfig(CfnCollectionPropsMixin.EncryptionConfigProperty encryptionConfig)	Encryption settings for the collection.
CfnCollectionPropsMixin.Builder	encryptionConfig(IResolvable encryptionConfig)	Encryption settings for the collection.
CfnCollectionPropsMixin.Builder	name(String name)	The name of the collection.
CfnCollectionPropsMixin.Builder	standbyReplicas(String standbyReplicas)	Indicates whether to use standby replicas for the collection.
CfnCollectionPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key–value pairs) to associate with the collection.
CfnCollectionPropsMixin.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 CfnCollectionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCollectionPropsMixin.Builder.

create

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

Returns:

a new instance of CfnCollectionPropsMixin.Builder.

collectionGroupName

@Stability(Stable)
public CfnCollectionPropsMixin.Builder collectionGroupName(String collectionGroupName)

The name of the collection group to associate with the collection.

Parameters:

collectionGroupName - The name of the collection group 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-collectiongroupname

description

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

encryptionConfig

@Stability(Stable)
public CfnCollectionPropsMixin.Builder encryptionConfig(IResolvable encryptionConfig)

Encryption settings for the collection.

Parameters:

encryptionConfig - Encryption settings 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-encryptionconfig

encryptionConfig

@Stability(Stable)
public CfnCollectionPropsMixin.Builder encryptionConfig(CfnCollectionPropsMixin.EncryptionConfigProperty encryptionConfig)

Encryption settings for the collection.

Parameters:

encryptionConfig - Encryption settings 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-encryptionconfig

name

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

standbyReplicas

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

Specified by:

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

Returns:

a newly built instance of CfnCollectionPropsMixin.