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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

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


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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_protection ⇒ Boolean

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

Returns:

  • (Boolean) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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 ⇒ String

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

Returns:

  • (String) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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_version ⇒ String

The engine version of the global cluster.

Returns:

  • (String) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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_identifier ⇒ String

The cluster identifier of the new global cluster.

Returns:

  • (String) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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_identifier ⇒ String

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

Returns:

  • (String) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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_encrypted ⇒ Boolean

The storage encryption setting for the new global cluster.

Returns:

  • (Boolean) 


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-docdb/types.rb', line 1305

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