software.amazon.awssdk.services.docdb.model

Interface GlobalCluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GlobalCluster.Builder,GlobalCluster>, SdkBuilder<GlobalCluster.Builder,GlobalCluster>, SdkPojo

Enclosing class:

GlobalCluster

public static interface GlobalCluster.Builder
extends SdkPojo, CopyableBuilder<GlobalCluster.Builder,GlobalCluster>

Method Summary

Modifier and Type	Method and Description
GlobalCluster.Builder	databaseName(String databaseName) The default database name within the new global cluster.
GlobalCluster.Builder	deletionProtection(Boolean deletionProtection) The deletion protection setting for the new global cluster.
GlobalCluster.Builder	engine(String engine) The Amazon DocumentDB database engine used by the global cluster.
GlobalCluster.Builder	engineVersion(String engineVersion) Indicates the database engine version.
GlobalCluster.Builder	globalClusterArn(String globalClusterArn) The Amazon Resource Name (ARN) for the global cluster.
GlobalCluster.Builder	globalClusterIdentifier(String globalClusterIdentifier) Contains a user-supplied global cluster identifier.
GlobalCluster.Builder	globalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
GlobalCluster.Builder	globalClusterMembers(Consumer<GlobalClusterMember.Builder>... globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
GlobalCluster.Builder	globalClusterMembers(GlobalClusterMember... globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
GlobalCluster.Builder	globalClusterResourceId(String globalClusterResourceId) The Amazon Web Services Region-unique, immutable identifier for the global database cluster.
GlobalCluster.Builder	status(String status) Specifies the current state of this global cluster.
GlobalCluster.Builder	storageEncrypted(Boolean storageEncrypted) The storage encryption setting for the global cluster.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

globalClusterIdentifier

GlobalCluster.Builder globalClusterIdentifier(String globalClusterIdentifier)

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

Parameters:

globalClusterIdentifier - Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterResourceId

GlobalCluster.Builder globalClusterResourceId(String globalClusterResourceId)

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

Parameters:

globalClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterArn

GlobalCluster.Builder globalClusterArn(String globalClusterArn)

The Amazon Resource Name (ARN) for the global cluster.

Parameters:

globalClusterArn - The Amazon Resource Name (ARN) for the global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GlobalCluster.Builder status(String status)

Specifies the current state of this global cluster.

Parameters:

status - Specifies the current state of this global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

engine

GlobalCluster.Builder engine(String engine)

The Amazon DocumentDB database engine used by the global cluster.

Parameters:

engine - The Amazon DocumentDB database engine used by the global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

GlobalCluster.Builder engineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

GlobalCluster.Builder databaseName(String databaseName)

The default database name within the new global cluster.

Parameters:

databaseName - The default database name within the new global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageEncrypted

GlobalCluster.Builder storageEncrypted(Boolean storageEncrypted)

The storage encryption setting for the global cluster.

Parameters:

storageEncrypted - The storage encryption setting for the global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

deletionProtection

GlobalCluster.Builder deletionProtection(Boolean deletionProtection)

The deletion protection setting for the new global cluster.

Parameters:

deletionProtection - The deletion protection setting for the new global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterMembers

GlobalCluster.Builder globalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

Parameters:

globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterMembers

GlobalCluster.Builder globalClusterMembers(GlobalClusterMember... globalClusterMembers)

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

Parameters:

globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterMembers

GlobalCluster.Builder globalClusterMembers(Consumer<GlobalClusterMember.Builder>... globalClusterMembers)

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

This is a convenience method that creates an instance of the GlobalClusterMember.Builder avoiding the need to create one manually via GlobalClusterMember.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #globalClusterMembers(List).

Parameters:

globalClusterMembers - a consumer that will call methods on GlobalClusterMember.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#globalClusterMembers(java.util.Collection)