All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyGlobalClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  ModifyGlobalClusterRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  ModifyGlobalClusterRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  Boolean	getAllowMajorVersionUpgrade () Specifies whether to allow major version upgrades.
  Boolean	getDeletionProtection () Specifies whether to enable deletion protection for the global database cluster.
  String	getEngineVersion () The version number of the database engine to which you want to upgrade.
  String	getGlobalClusterIdentifier () The cluster identifier for the global cluster to modify.
  String	getNewGlobalClusterIdentifier () The new cluster identifier for the global database cluster.
  int	hashCode ()
  Boolean	isAllowMajorVersionUpgrade () Specifies whether to allow major version upgrades.
  Boolean	isDeletionProtection () Specifies whether to enable deletion protection for the global database cluster.
  void	setAllowMajorVersionUpgrade (Boolean allowMajorVersionUpgrade) Specifies whether to allow major version upgrades.
  void	setDeletionProtection (Boolean deletionProtection) Specifies whether to enable deletion protection for the global database cluster.
  void	setEngineVersion (String engineVersion) The version number of the database engine to which you want to upgrade.
  void	setGlobalClusterIdentifier (String globalClusterIdentifier) The cluster identifier for the global cluster to modify.
  void	setNewGlobalClusterIdentifier (String newGlobalClusterIdentifier) The new cluster identifier for the global database cluster.
  String	toString () Returns a string representation of this object.
  ModifyGlobalClusterRequest	withAllowMajorVersionUpgrade (Boolean allowMajorVersionUpgrade) Specifies whether to allow major version upgrades.
  ModifyGlobalClusterRequest	withDeletionProtection (Boolean deletionProtection) Specifies whether to enable deletion protection for the global database cluster.
  ModifyGlobalClusterRequest	withEngineVersion (String engineVersion) The version number of the database engine to which you want to upgrade.
  ModifyGlobalClusterRequest	withGlobalClusterIdentifier (String globalClusterIdentifier) The cluster identifier for the global cluster to modify.
  ModifyGlobalClusterRequest	withNewGlobalClusterIdentifier (String newGlobalClusterIdentifier) The new cluster identifier for the global database cluster.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • ModifyGlobalClusterRequest

    public ModifyGlobalClusterRequest()

• Method Detail

  • setGlobalClusterIdentifier

    public void setGlobalClusterIdentifier(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.

    Parameters:

    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.

  • getGlobalClusterIdentifier

    public String getGlobalClusterIdentifier()

    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.

  • withGlobalClusterIdentifier

    public ModifyGlobalClusterRequest withGlobalClusterIdentifier(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.

    Parameters:

    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:

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

  • setNewGlobalClusterIdentifier

    public void setNewGlobalClusterIdentifier(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

    Parameters:

    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

  • getNewGlobalClusterIdentifier

    public String getNewGlobalClusterIdentifier()

    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

  • withNewGlobalClusterIdentifier

    public ModifyGlobalClusterRequest withNewGlobalClusterIdentifier(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

    Parameters:

    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:

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

  • setDeletionProtection

    public void setDeletionProtection(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.

    Parameters:

    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.

  • getDeletionProtection

    public Boolean getDeletionProtection()

    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.

  • withDeletionProtection

    public ModifyGlobalClusterRequest withDeletionProtection(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.

    Parameters:

    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:

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

  • isDeletionProtection

    public Boolean isDeletionProtection()

    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.

  • setEngineVersion

    public void setEngineVersion(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]'

    Parameters:

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

  • getEngineVersion

    public String getEngineVersion()

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

  • withEngineVersion

    public ModifyGlobalClusterRequest withEngineVersion(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]'

    Parameters:

    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:

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

  • setAllowMajorVersionUpgrade

    public void setAllowMajorVersionUpgrade(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.

    Parameters:

    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.

  • getAllowMajorVersionUpgrade

    public Boolean getAllowMajorVersionUpgrade()

    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.

  • withAllowMajorVersionUpgrade

    public ModifyGlobalClusterRequest withAllowMajorVersionUpgrade(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.

    Parameters:

    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:

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

  • isAllowMajorVersionUpgrade

    public Boolean isAllowMajorVersionUpgrade()

    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.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public ModifyGlobalClusterRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()