Class: Aws::DSQL::Types::GetClusterOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb

Overview

The output of a cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the retrieved cluster.

Returns:

  • (String)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time of when the cluster was created.

Returns:

  • (Time)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

Whether deletion protection is enabled in this cluster.

Returns:

  • (Boolean)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_details ⇒ Types::EncryptionDetails

The current encryption configuration details for the cluster.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The connection endpoint for the cluster.

Returns:

  • (String)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The ID of the retrieved cluster.

Returns:

  • (String)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ Array<Types::MetricGroupResponse>

The metric groups that you enabled for advanced monitoring on the cluster. If you haven't enabled any metric groups, the list is empty.

Returns:



536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_properties ⇒ Types::MultiRegionProperties

Returns the current multi-Region cluster configuration, including witness region and linked cluster information.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the retrieved cluster.

Returns:

  • (String)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Map of tags.

Returns:

  • (Hash<String,String>)


536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 536

class GetClusterOutput < Struct.new(
  :identifier,
  :arn,
  :status,
  :creation_time,
  :deletion_protection_enabled,
  :multi_region_properties,
  :tags,
  :encryption_details,
  :endpoint,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end