Interface FailoverGlobalClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<FailoverGlobalClusterRequest.Builder,
,FailoverGlobalClusterRequest> RdsRequest.Builder
,SdkBuilder<FailoverGlobalClusterRequest.Builder,
,FailoverGlobalClusterRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
FailoverGlobalClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionallowDataLoss
(Boolean allowDataLoss) Specifies whether to allow data loss for this global database cluster operation.globalClusterIdentifier
(String globalClusterIdentifier) The identifier of the global database cluster (Aurora global database) this operation should apply to.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.switchover
(Boolean switchover) Specifies whether to switch over this global database cluster.targetDbClusterIdentifier
(String targetDbClusterIdentifier) The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
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
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.
Constraints:
-
Must match the identifier of an existing global database cluster.
- Parameters:
globalClusterIdentifier
- The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.Constraints:
-
Must match the identifier of an existing global database cluster.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
targetDbClusterIdentifier
The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
- Parameters:
targetDbClusterIdentifier
- The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowDataLoss
Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify
AllowDataLoss
, the global database cluster operation defaults to a switchover.Constraints:
-
Can't be specified together with the
Switchover
parameter.
- Parameters:
allowDataLoss
- Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.If you don't specify
AllowDataLoss
, the global database cluster operation defaults to a switchover.Constraints:
-
Can't be specified together with the
Switchover
parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
switchover
Specifies whether to switch over this global database cluster.
Constraints:
-
Can't be specified together with the
AllowDataLoss
parameter.
- Parameters:
switchover
- Specifies whether to switch over this global database cluster.Constraints:
-
Can't be specified together with the
AllowDataLoss
parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
FailoverGlobalClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
FailoverGlobalClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-