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) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#deletion_protection ⇒ Boolean

The deletion protection setting for the new global database cluster.

Returns:

  • (Boolean) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#engine ⇒ String

The Aurora database engine used by the global database cluster.

Returns:

  • (String) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#engine_lifecycle_support ⇒ String

The life cycle type for the global cluster.

For more information, see CreateGlobalCluster.

Returns:

  • (String) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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



16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#global_cluster_arn ⇒ String

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

Returns:

  • (String) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#global_cluster_members ⇒ Array<Types::GlobalClusterMember>

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

Returns:



16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#status ⇒ String

Specifies the current state of this global database cluster.

Returns:

  • (String) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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

#storage_encrypted ⇒ Boolean

The storage encryption setting for the global database cluster.

Returns:

  • (Boolean) 


16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aws-sdk-rds/types.rb', line 16008

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