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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#database_nameString

The default database name within the new global database cluster.

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_protectionBoolean

The deletion protection setting for the new global database cluster.

Returns:

  • (Boolean)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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

#engineString

The Aurora database engine used by the global database cluster.

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_versionString

Indicates the database engine version.

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_stateTypes::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).



12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_arnString

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

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_identifierString

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

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_membersArray<Types::GlobalClusterMember>

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

Returns:



12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_idString

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 customer master key (CMK) for the DB cluster is accessed.

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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

#statusString

Specifies the current state of this global database cluster.

Returns:

  • (String)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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_encryptedBoolean

The storage encryption setting for the global database cluster.

Returns:

  • (Boolean)


12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12884

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