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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

A data type representing an Aurora global database.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #engine ⇒ String

  The Aurora database engine used by the global database 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 failover process for this 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 cluster IDs for secondary clusters within the global database cluster.

• #global_cluster_resource_id ⇒ String

  The Amazon Web Services Region-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.

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 14079

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)
  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 14079

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)
  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 14079

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)
  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 14079

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)
  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 failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

Returns:

• (Types::FailoverState)

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

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)
  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 14079

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)
  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 14079

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

#global_cluster_members ⇒ Array<Types::GlobalClusterMember>

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

Returns:

• (Array<Types::GlobalClusterMember>)

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

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

#global_cluster_resource_id ⇒ String

The Amazon Web Services Region-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 14079

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)
  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 14079

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)
  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 14079

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