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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

A data type representing an Aurora global database.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_name ⇒ String

The default database name within the new global database cluster.

Returns:

  • (String) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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

#engine_lifecycle_support ⇒ String

The life cycle type for the global cluster.

For more information, see CreateGlobalCluster.

Returns:

  • (String) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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:



16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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:



16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :deletion_protection,
  :global_cluster_members,
  :endpoint,
  :failover_state,
  :tag_list)
  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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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,
  :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) 


16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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

#tag_list ⇒ Array<Types::Tag>

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*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:



16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
 
# File 'lib/aws-sdk-rds/types.rb', line 16287

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