Class: Aws::RDS::Types::ModifyGlobalClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_major_version_upgradeBoolean

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:

  • (Boolean)


19980
19981
19982
19983
19984
19985
19986
19987
19988
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19980

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection,
  :engine_version,
  :allow_major_version_upgrade)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

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:

  • (Boolean)


19980
19981
19982
19983
19984
19985
19986
19987
19988
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19980

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection,
  :engine_version,
  :allow_major_version_upgrade)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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:

  • (String)


19980
19981
19982
19983
19984
19985
19986
19987
19988
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19980

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection,
  :engine_version,
  :allow_major_version_upgrade)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifierString

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:

  • (String)


19980
19981
19982
19983
19984
19985
19986
19987
19988
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19980

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection,
  :engine_version,
  :allow_major_version_upgrade)
  SENSITIVE = []
  include Aws::Structure
end

#new_global_cluster_identifierString

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:

  • (String)


19980
19981
19982
19983
19984
19985
19986
19987
19988
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19980

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection,
  :engine_version,
  :allow_major_version_upgrade)
  SENSITIVE = []
  include Aws::Structure
end