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.

See Also:

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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.

Returns:



4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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:



4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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) 


4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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:



4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
 
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4068

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