Skip to content
AWS for Query.Farm

aws.rds.describe_db_shard_groups

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_shard_groups;

Description

Describes existing Aurora Limitless Database DB shard groups.

Table Definition

Column NameColumn Data Type
db_shard_group_identifier Input Column

The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DB shard group identifier.

VARCHAR
filters Input Column

A filter that specifies one or more DB shard groups to describe.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
marker Input Column

A pagination token that can be used in a later DescribeDBClusters request.

VARCHAR
max_records Input Column

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
db_shard_groups

Contains a list of DB shard groups for the user.

STRUCT(
    "db_shard_group_resource_id" VARCHAR,
    "db_shard_group_identifier" VARCHAR,
    "db_cluster_identifier" VARCHAR,
    "max_acu" DOUBLE,
    "min_acu" DOUBLE,
    "compute_redundancy" BIGINT,
    "status" VARCHAR,
    "publicly_accessible" BOOLEAN,
    "endpoint" VARCHAR
)[]
Show child fields
db_shard_groups[]
Show child fields
db_shard_groups[].compute_redundancy

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

  • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

  • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

  • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

db_shard_groups[].db_cluster_identifier

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

db_shard_groups[].db_shard_group_identifier

The name of the DB shard group.

db_shard_groups[].db_shard_group_resource_id

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

db_shard_groups[].endpoint

The connection endpoint for the DB shard group.

db_shard_groups[].max_acu

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

db_shard_groups[].min_acu

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

db_shard_groups[].publicly_accessible

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.

db_shard_groups[].status

The status of the DB shard group.