AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::CreateGlobalClusterMessage

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

Overview

Note:

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

{
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  source_db_cluster_identifier: "String",
  engine: "String",
  engine_version: "String",
  deletion_protection: false,
  database_name: "String",
  storage_encrypted: false,
}

Represents the input to CreateGlobalCluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_nameString

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

Returns:

  • (String)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#deletion_protectionBoolean

The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

Returns:

  • (Boolean)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#engineString

The name of the database engine to be used for this cluster.

Returns:

  • (String)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#engine_versionString

The engine version of the global cluster.

Returns:

  • (String)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#global_cluster_identifierString

The cluster identifier of the new global cluster.

Returns:

  • (String)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#source_db_cluster_identifierString

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

Returns:

  • (String)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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

#storage_encryptedBoolean

The storage encryption setting for the new global cluster.

Returns:

  • (Boolean)


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1262

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