Class: Aws::RDS::Types::GlobalCluster

Inherits:

Struct

Object
Struct
Aws::RDS::Types::GlobalCluster

show all

Defined in:: gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

A data type representing an Aurora global database.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#database_name ⇒ String
The default database name within the new global database cluster.
#deletion_protection ⇒ Boolean
The deletion protection setting for the new global database cluster.
#endpoint ⇒ String
The writer endpoint for the new global database cluster.
#engine ⇒ String
The Aurora database engine used by the global database cluster.
#engine_lifecycle_support ⇒ String
The lifecycle type for the global cluster.
#engine_version ⇒ String
Indicates the database engine version.
#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 (Aurora global database).
#global_cluster_arn ⇒ String
The Amazon Resource Name (ARN) for the global database cluster.
#global_cluster_identifier ⇒ String
Contains a user-supplied global database cluster identifier.
#global_cluster_members ⇒ Array<Types::GlobalClusterMember>
The list of primary and secondary clusters within the global database cluster.
#global_cluster_resource_id ⇒ String
The Amazon Web Services [partition][1]-unique, immutable identifier for the global database cluster.
#status ⇒ String
Specifies the current state of this global database cluster.
#storage_encrypted ⇒ Boolean
The storage encryption setting for the global database cluster.
#storage_encryption_type ⇒ String
The type of encryption used to protect data at rest in the global database cluster.
#tag_list ⇒ Array<Types::Tag>
A list of tags.

Instance Attribute Details

#database_name ⇒ `String`

The default database name within the new global database cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#deletion_protection ⇒ `Boolean`

The deletion protection setting for the new global database cluster.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#endpoint ⇒ `String`

The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#engine ⇒ `String`

The Aurora database engine used by the global database cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#engine_lifecycle_support ⇒ `String`

The lifecycle type for the global cluster.

For more information, see CreateGlobalCluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#engine_version ⇒ `String`

Indicates the database engine version.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :engine_lifecycle_support,
  :database_name,
  :storage_encrypted,
  :storage_encryption_type,
  :deletion_protection,
  :global_cluster_members,
  :endpoint,
  :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 (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

Returns:

(Types::FailoverState)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#global_cluster_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#global_cluster_identifier ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#global_cluster_members ⇒ `Array<Types::GlobalClusterMember>`

The list of primary and secondary clusters within the global database cluster.

Returns:

(Array<Types::GlobalClusterMember>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#global_cluster_resource_id ⇒ `String`

The Amazon Web Services partition-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#status ⇒ `String`

Specifies the current state of this global database cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#storage_encrypted ⇒ `Boolean`

The storage encryption setting for the global database cluster.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

#storage_encryption_type ⇒ `String`

The type of encryption used to protect data at rest in the global database cluster. Possible values:

none - The global database cluster is not encrypted.
sse-rds - The global database cluster is encrypted using an Amazon Web Services owned KMS key.
sse-kms - The global database cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17354

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

Class: Aws::RDS::Types::GlobalCluster

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#database_name ⇒ String

#deletion_protection ⇒ Boolean

#endpoint ⇒ String

#engine ⇒ String

#engine_lifecycle_support ⇒ String

#engine_version ⇒ String

#failover_state ⇒ Types::FailoverState

#global_cluster_arn ⇒ String

#global_cluster_identifier ⇒ String

#global_cluster_members ⇒ Array<Types::GlobalClusterMember>

#global_cluster_resource_id ⇒ String

#status ⇒ String

#storage_encrypted ⇒ Boolean

#storage_encryption_type ⇒ String

#tag_list ⇒ Array<Types::Tag>

#database_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#endpoint ⇒ `String`

#engine ⇒ `String`

#engine_lifecycle_support ⇒ `String`

#engine_version ⇒ `String`

#failover_state ⇒ `Types::FailoverState`

#global_cluster_arn ⇒ `String`

#global_cluster_identifier ⇒ `String`

#global_cluster_members ⇒ `Array<Types::GlobalClusterMember>`

#global_cluster_resource_id ⇒ `String`

#status ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#storage_encryption_type ⇒ `String`

#tag_list ⇒ `Array<Types::Tag>`