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

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

Overview

A data type representing an Amazon DocumentDB global cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_nameString

The default database name within the new global cluster.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

The deletion protection setting for the new global cluster.

Returns:

  • (Boolean)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The Amazon DocumentDB database engine used by the global cluster.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_arnString

The Amazon Resource Name (ARN) for the global cluster.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifierString

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_membersArray<Types::GlobalClusterMember>

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

Returns:



4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_resource_idString

The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Specifies the current state of this global cluster.

Returns:

  • (String)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryptedBoolean

The storage encryption setting for the global cluster.

Returns:

  • (Boolean)


4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4102

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :database_name,
  :storage_encrypted,
  :deletion_protection,
  :global_cluster_members)
  SENSITIVE = []
  include Aws::Structure
end