Interface GlobalCluster.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GlobalCluster.Builder,
,GlobalCluster> SdkBuilder<GlobalCluster.Builder,
,GlobalCluster> SdkPojo
- Enclosing class:
GlobalCluster
-
Method Summary
Modifier and TypeMethodDescriptiondatabaseName
(String databaseName) The default database name within the new global cluster.deletionProtection
(Boolean deletionProtection) The deletion protection setting for the new global cluster.The Amazon DocumentDB database engine used by the global cluster.engineVersion
(String engineVersion) Indicates the database engine version.globalClusterArn
(String globalClusterArn) The Amazon Resource Name (ARN) for the global cluster.globalClusterIdentifier
(String globalClusterIdentifier) Contains a user-supplied global cluster identifier.globalClusterMembers
(Collection<GlobalClusterMember> globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.globalClusterMembers
(Consumer<GlobalClusterMember.Builder>... globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.globalClusterMembers
(GlobalClusterMember... globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.globalClusterResourceId
(String globalClusterResourceId) The Amazon Web Services Region-unique, immutable identifier for the global database cluster.Specifies the current state of this global cluster.storageEncrypted
(Boolean storageEncrypted) The storage encryption setting for the global cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
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 theGlobalClusterMember.Builder
avoiding the need to create one manually viaGlobalClusterMember.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toglobalClusterMembers(List<GlobalClusterMember>)
.- Parameters:
globalClusterMembers
- a consumer that will call methods onGlobalClusterMember.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-