Class: Aws::RDS::Types::CreateGlobalClusterMessage

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_name ⇒ String

The name for your database of up to 64 alphanumeric characters. If you don’t specify a name, Amazon Aurora doesn’t create a database in the global database cluster.

Constraints:

  • Can’t be specified if ‘SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

^

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

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

Returns:

  • (Boolean) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The database engine to use for this global database cluster.

Valid Values: ‘aurora-mysql | aurora-postgresql`

Constraints:

  • Can’t be specified if ‘SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

^

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#engine_lifecycle_support ⇒ String

The life cycle type for this global database cluster.

<note markdown=“1”> By default, this value is set to ‘open-source-rds-extended-support`, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

</note>

This setting only applies to Aurora PostgreSQL-based global databases.

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see

Using Amazon RDS Extended Support][1

in the *Amazon Aurora User

Guide*.

Valid Values: ‘open-source-rds-extended-support | open-source-rds-extended-support-disabled`

Default: ‘open-source-rds-extended-support`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The engine version to use for this global database cluster.

Constraints:

  • Can’t be specified if ‘SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

^

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ String

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_cluster_identifier ⇒ String

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

If you provide a value for this parameter, don’t specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

  • ‘DatabaseName`

  • ‘Engine`

  • ‘EngineVersion`

  • ‘StorageEncrypted`

Returns:

  • (String) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

  • Can’t be specified if ‘SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

^

Returns:

  • (Boolean) 


6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
 
# File 'lib/aws-sdk-rds/types.rb', line 6258

class CreateGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :source_db_cluster_identifier,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :deletion_protection,
  :database_name,
  :storage_encrypted)
  SENSITIVE = []
  include Aws::Structure
end