Class: Aws::DocDB::Types::GlobalCluster

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::GlobalCluster

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

A data type representing an Amazon DocumentDB global cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #database_name ⇒ String

  The default database name within the new global cluster.

• #deletion_protection ⇒ Boolean

  The deletion protection setting for the new global cluster.

• #engine ⇒ String

  The Amazon DocumentDB database engine used by the global cluster.

• #engine_version ⇒ String

  Indicates the database engine version.

• #global_cluster_arn ⇒ String

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

• #global_cluster_identifier ⇒ String

  Contains a user-supplied global cluster identifier.

• #global_cluster_members ⇒ Array<Types::GlobalClusterMember>

  The list of cluster IDs for secondary clusters within the global cluster.

• #global_cluster_resource_id ⇒ String

  The Region-unique, immutable identifier for the global database cluster.

• #status ⇒ String

  Specifies the current state of this global cluster.

• #storage_encrypted ⇒ Boolean

  The storage encryption setting for the global cluster.

Instance Attribute Details

#database_name ⇒ String

The default database name within the new global cluster.

Returns:

• (String)

# File '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_protection ⇒ Boolean

The deletion protection setting for the new global cluster.

Returns:

• (Boolean)

# File '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 ⇒ String

The Amazon DocumentDB database engine used by the global cluster.

Returns:

• (String)

# File '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_version ⇒ String

Indicates the database engine version.

Returns:

• (String)

# File '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_arn ⇒ String

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

Returns:

• (String)

# File '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_identifier ⇒ String

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

Returns:

• (String)

# File '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_members ⇒ Array<Types::GlobalClusterMember>

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

Returns:

• (Array<Types::GlobalClusterMember>)

# File '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_id ⇒ String

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)

# File '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

#status ⇒ String

Specifies the current state of this global cluster.

Returns:

• (String)

# File '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_encrypted ⇒ Boolean

The storage encryption setting for the global cluster.

Returns:

• (Boolean)

# File '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