Class: Aws::RDS::Types::DBShardGroup

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DBShardGroup

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Contains the details for an Amazon RDS DB shard group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute_redundancy ⇒ Integer

  Specifies whether to create standby DB shard groups for the DB shard group.

• #db_cluster_identifier ⇒ String

  The name of the primary DB cluster for the DB shard group.

• #db_shard_group_arn ⇒ String

  The Amazon Resource Name (ARN) for the DB shard group.

• #db_shard_group_identifier ⇒ String

  The name of the DB shard group.

• #db_shard_group_resource_id ⇒ String

  The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

• #endpoint ⇒ String

  The connection endpoint for the DB shard group.

• #max_acu ⇒ Float

  The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

• #min_acu ⇒ Float

  The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

• #publicly_accessible ⇒ Boolean

  Indicates whether the DB shard group is publicly accessible.

• #status ⇒ String

  The status of the DB shard group.

• #tag_list ⇒ Array<Types::Tag>

  A list of tags.

Instance Attribute Details

#compute_redundancy ⇒ Integer

Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

• 0 - Creates a DB shard group without a standby DB shard group. This is the default value.

• 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

• 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

Returns:

• (Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

The name of the primary DB cluster for the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_shard_group_arn ⇒ String

The Amazon Resource Name (ARN) for the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_shard_group_identifier ⇒ String

The name of the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_shard_group_resource_id ⇒ String

The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The connection endpoint for the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#max_acu ⇒ Float

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

Returns:

• (Float)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#min_acu ⇒ Float

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

Returns:

• (Float)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Indicates whether the DB shard group is publicly accessible.

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

For more information, see CreateDBShardGroup.

This setting is only for Aurora Limitless Database.

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the DB shard group.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<Types::Tag>

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10778

class DBShardGroup < Struct.new(
  :db_shard_group_resource_id,
  :db_shard_group_identifier,
  :db_cluster_identifier,
  :max_acu,
  :min_acu,
  :compute_redundancy,
  :status,
  :publicly_accessible,
  :endpoint,
  :db_shard_group_arn,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end