Package software.amazon.awssdk.services.rds.model

Class ModifyGlobalClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.ModifyGlobalClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyGlobalClusterRequest
extends RdsRequest
implements ToCopyableBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyGlobalClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowMajorVersionUpgrade()	Specifies whether to allow major version upgrades.
static ModifyGlobalClusterRequest.Builder	builder()
Boolean	deletionProtection()	Specifies whether to enable deletion protection for the global database cluster.
String	engineVersion()	The version number of the database engine to which you want to upgrade.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalClusterIdentifier()	The cluster identifier for the global cluster to modify.
int	hashCode()
String	newGlobalClusterIdentifier()	The new cluster identifier for the global database cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyGlobalClusterRequest.Builder>	serializableBuilderClass()
ModifyGlobalClusterRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

globalClusterIdentifier

public final String globalClusterIdentifier()

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

Constraints:

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

Returns:

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

Constraints:

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

newGlobalClusterIdentifier

public final String newGlobalClusterIdentifier()

The new cluster identifier for the 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:

The new cluster identifier for the 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

deletionProtection

public final Boolean deletionProtection()

Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.

Returns:

Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.

engineVersion

public final String engineVersion()

The version number of the database engine to which you want to upgrade.

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:

The version number of the database engine to which you want to upgrade.

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]'

allowMajorVersionUpgrade

public final Boolean allowMajorVersionUpgrade()

Specifies whether to allow major version upgrades.

Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a different major version than the global 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:

Specifies whether to allow major version upgrades.

Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a different major version than the global 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.

toBuilder

public ModifyGlobalClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static ModifyGlobalClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyGlobalClusterRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo