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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-neptune/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protectionBoolean

The deletion protection setting for the global database.

Returns:

  • (Boolean)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#engineString

The Neptune database engine used by the global database ("neptune").

Returns:

  • (String)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#engine_versionString

The Neptune engine version used by the global database.

Returns:

  • (String)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#global_cluster_arnString

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

Returns:

  • (String)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

Returns:

  • (String)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#global_cluster_membersArray<Types::GlobalClusterMember>

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

Returns:



5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#global_cluster_resource_idString

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)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#statusString

Specifies the current state of this global database.

Returns:

  • (String)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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

#storage_encryptedBoolean

The storage encryption setting for the global database.

Returns:

  • (Boolean)


5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 5309

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