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

The default database name within the new global cluster.

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

The deletion protection setting for the new global cluster.

Returns:

  • (Boolean)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The Amazon DocumentDB database engine used by the global cluster.

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#failover_state ⇒ Types::FailoverState

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.



4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_arn ⇒ String

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

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ String

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

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_members ⇒ Array<Types::GlobalClusterMember>

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

Returns:



4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_resource_id ⇒ String

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

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies the current state of this global cluster.

Returns:

  • (String)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

The storage encryption setting for the global cluster.

Returns:

  • (Boolean)


4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<Types::Tag>

A list of global cluster tags.

Returns:



4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4163

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,
  :failover_state,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end