software.amazon.awssdk.services.rds.model

Interface ModifyGlobalClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>, RdsRequest.Builder, SdkBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyGlobalClusterRequest

public static interface ModifyGlobalClusterRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>

Method Summary

Modifier and Type	Method and Description
ModifyGlobalClusterRequest.Builder	allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) A value that indicates whether major version upgrades are allowed.
ModifyGlobalClusterRequest.Builder	deletionProtection(Boolean deletionProtection) Indicates if the global database cluster has deletion protection enabled.
ModifyGlobalClusterRequest.Builder	engineVersion(String engineVersion) The version number of the database engine to which you want to upgrade.
ModifyGlobalClusterRequest.Builder	globalClusterIdentifier(String globalClusterIdentifier) The DB cluster identifier for the global cluster being modified.
ModifyGlobalClusterRequest.Builder	newGlobalClusterIdentifier(String newGlobalClusterIdentifier) The new cluster identifier for the global database cluster when modifying a global database cluster.
ModifyGlobalClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ModifyGlobalClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

ModifyGlobalClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

• Must match the identifier of an existing global database cluster.

Parameters:

globalClusterIdentifier - The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

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.

newGlobalClusterIdentifier

ModifyGlobalClusterRequest.Builder newGlobalClusterIdentifier(String newGlobalClusterIdentifier)

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• The first character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Parameters:

newGlobalClusterIdentifier - The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• The first character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Returns:

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

deletionProtection

ModifyGlobalClusterRequest.Builder deletionProtection(Boolean deletionProtection)

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

Parameters:

deletionProtection - Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

Returns:

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

engineVersion

ModifyGlobalClusterRequest.Builder engineVersion(String engineVersion)

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

Parameters:

engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

Returns:

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

allowMajorVersionUpgrade

ModifyGlobalClusterRequest.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

Parameters:

allowMajorVersionUpgrade - A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

Returns:

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

overrideConfiguration

ModifyGlobalClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ModifyGlobalClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder