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

Class CfnCollectionMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionMixinProps>

Enclosing interface:

CfnCollectionMixinProps

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

A builder for CfnCollectionMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCollectionMixinProps	build()	Builds the configured instance.
CfnCollectionMixinProps.Builder	collectionGroupName(String collectionGroupName)	Sets the value of CfnCollectionMixinProps.getCollectionGroupName()
CfnCollectionMixinProps.Builder	description(String description)	Sets the value of CfnCollectionMixinProps.getDescription()
CfnCollectionMixinProps.Builder	encryptionConfig(CfnCollectionPropsMixin.EncryptionConfigProperty encryptionConfig)	Sets the value of CfnCollectionMixinProps.getEncryptionConfig()
CfnCollectionMixinProps.Builder	encryptionConfig(IResolvable encryptionConfig)	Sets the value of CfnCollectionMixinProps.getEncryptionConfig()
CfnCollectionMixinProps.Builder	name(String name)	Sets the value of CfnCollectionMixinProps.getName()
CfnCollectionMixinProps.Builder	standbyReplicas(String standbyReplicas)	Sets the value of CfnCollectionMixinProps.getStandbyReplicas()
CfnCollectionMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnCollectionMixinProps.getTags()
CfnCollectionMixinProps.Builder	type(String type)	Sets the value of CfnCollectionMixinProps.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

collectionGroupName

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

Sets the value of CfnCollectionMixinProps.getCollectionGroupName()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnCollectionMixinProps.getDescription()

Parameters:

description - A description of the collection.

Returns:

this

encryptionConfig

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

Sets the value of CfnCollectionMixinProps.getEncryptionConfig()

Parameters:

encryptionConfig - Encryption settings for the collection.

Returns:

this

encryptionConfig

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

Sets the value of CfnCollectionMixinProps.getEncryptionConfig()

Parameters:

encryptionConfig - Encryption settings for the collection.

Returns:

this

name

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

Sets the value of CfnCollectionMixinProps.getName()

Parameters:

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 (-)

Returns:

this

standbyReplicas

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

Sets the value of CfnCollectionMixinProps.getStandbyReplicas()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnCollectionMixinProps.getTags()

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the collection. For more information, see Tag .

Returns:

this

type

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

Sets the value of CfnCollectionMixinProps.getType()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCollectionMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnCollectionMixinProps

Throws:

NullPointerException - if any required attribute was not provided