Class: Aws::Neptune::Types::GlobalCluster

Inherits:

Struct

• Object
• Struct
• Aws::Neptune::Types::GlobalCluster

Includes:

Structure

Defined in:

lib/aws-sdk-neptune/types.rb

Overview

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #deletion_protection ⇒ Boolean

  The deletion protection setting for the global database.

• #engine ⇒ String

  The Neptune database engine used by the global database (‘“neptune”`).

• #engine_version ⇒ String

  The Neptune engine version used by the global database.

• #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 (Neptune global database).

• #global_cluster_arn ⇒ String

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

• #global_cluster_identifier ⇒ String

  Contains a user-supplied global database cluster identifier.

• #global_cluster_members ⇒ Array<Types::GlobalClusterMember>

  A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

• #global_cluster_resource_id ⇒ String

  An immutable identifier for the global database that is unique within in all regions.

• #status ⇒ String

  Specifies the current state of this global database.

• #storage_encrypted ⇒ Boolean

  The storage encryption setting for the global database.

Instance Attribute Details

#deletion_protection ⇒ Boolean

The deletion protection setting for the global database.

Returns:

• (Boolean)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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

#engine ⇒ String

The Neptune database engine used by the global database (‘“neptune”`).

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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

#engine_version ⇒ String

The Neptune engine version used by the global database.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :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 (Neptune global database). This object is empty unless the ‘SwitchoverGlobalCluster` or `FailoverGlobalCluster` operation was called on this global cluster.

Returns:

• (Types::FailoverState)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :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.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :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.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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

#global_cluster_members ⇒ Array<Types::GlobalClusterMember>

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

Returns:

• (Array<Types::GlobalClusterMember>)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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

#global_cluster_resource_id ⇒ String

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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

#status ⇒ String

Specifies the current state of this global database.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

class GlobalCluster < Struct.new(
  :global_cluster_identifier,
  :global_cluster_resource_id,
  :global_cluster_arn,
  :status,
  :engine,
  :engine_version,
  :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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-neptune/types.rb', line 5429

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