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

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

Overview

Note:

When making an API call, you may pass ModifyGlobalClusterMessage data as a hash:

{
  global_cluster_identifier: "String",
  new_global_cluster_identifier: "String",
  deletion_protection: false,
  engine_version: "String",
  allow_major_version_upgrade: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_major_version_upgradeBoolean

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:

  • (Boolean)


17092
17093
17094
17095
17096
17097
17098
17099
17100
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17092

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

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

Returns:

  • (Boolean)


17092
17093
17094
17095
17096
17097
17098
17099
17100
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17092

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. 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 (for MySQL 5.6-compatible Aurora), use the following command:

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

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), 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, use the following command:

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

Returns:

  • (String)


17092
17093
17094
17095
17096
17097
17098
17099
17100
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17092

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 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:

  • (String)


17092
17093
17094
17095
17096
17097
17098
17099
17100
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17092

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 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:

  • (String)


17092
17093
17094
17095
17096
17097
17098
17099
17100
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17092

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