Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollectionProps.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnCollectionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCollectionProps>

Enclosing interface:

CfnCollectionProps

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

A builder for CfnCollectionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCollectionProps	build()	Builds the configured instance.
CfnCollectionProps.Builder	collectionGroupName(String collectionGroupName)	Sets the value of CfnCollectionProps.getCollectionGroupName()
CfnCollectionProps.Builder	description(String description)	Sets the value of CfnCollectionProps.getDescription()
CfnCollectionProps.Builder	encryptionConfig(IResolvable encryptionConfig)	Sets the value of CfnCollectionProps.getEncryptionConfig()
CfnCollectionProps.Builder	encryptionConfig(CfnCollection.EncryptionConfigProperty encryptionConfig)	Sets the value of CfnCollectionProps.getEncryptionConfig()
CfnCollectionProps.Builder	name(String name)	Sets the value of CfnCollectionProps.getName()
CfnCollectionProps.Builder	standbyReplicas(String standbyReplicas)	Sets the value of CfnCollectionProps.getStandbyReplicas()
CfnCollectionProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnCollectionProps.getTags()
CfnCollectionProps.Builder	type(String type)	Sets the value of CfnCollectionProps.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

name

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

Sets the value of CfnCollectionProps.getName()

Parameters:

name - The name of the collection. This parameter is required. 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

collectionGroupName

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

Sets the value of CfnCollectionProps.getCollectionGroupName()

Parameters:

collectionGroupName - The name of the collection group. The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

Returns:

this

description

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

Sets the value of CfnCollectionProps.getDescription()

Parameters:

description - A description of the collection.

Returns:

this

encryptionConfig

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

Sets the value of CfnCollectionProps.getEncryptionConfig()

Parameters:

encryptionConfig - The configuration to encrypt the collection.

Returns:

this

encryptionConfig

@Stability(Stable)
public CfnCollectionProps.Builder encryptionConfig(CfnCollection.EncryptionConfigProperty encryptionConfig)

Sets the value of CfnCollectionProps.getEncryptionConfig()

Parameters:

encryptionConfig - The configuration to encrypt the collection.

Returns:

this

standbyReplicas

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

Sets the value of CfnCollectionProps.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 CfnCollectionProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnCollectionProps.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 CfnCollectionProps.Builder type(String type)

Sets the value of CfnCollectionProps.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 CfnCollectionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnCollectionProps

Throws:

NullPointerException - if any required attribute was not provided