Skip to content

DBShardGroup

Source code in docs_src/capo_rds/types/db_shard_group.py
class DBShardGroup(TypedDict, closed=True):
    db_shard_group_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services Region-unique, immutable identifier for the DB shard group.</p>"""
    db_shard_group_identifier: NotRequired[
        "capo_rds.types.db_shard_group_identifier.DBShardGroupIdentifier"
    ]
    """<p>The name of the DB shard group.</p>"""
    db_cluster_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the primary DB cluster for the DB shard group.</p>"""
    max_acu: NotRequired["capo_rds.types.double_optional.DoubleOptional"]
    """<p>The maximum capacity of the DB shard group in Aurora capacity units (ACUs).</p>"""
    min_acu: NotRequired["capo_rds.types.double_optional.DoubleOptional"]
    """<p>The minimum capacity of the DB shard group in Aurora capacity units (ACUs).</p>"""
    compute_redundancy: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:</p> <ul> <li> <p>0 - Creates a DB shard group without a standby DB shard group. This is the default value.</p> </li> <li> <p>1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).</p> </li> <li> <p>2 - Creates a DB shard group with two standby DB shard groups in two different AZs.</p> </li> </ul>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of the DB shard group.</p>"""
    publicly_accessible: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Indicates whether the DB shard group is publicly accessible.</p> <p>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.</p> <p>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.</p> <p>For more information, see <a>CreateDBShardGroup</a>.</p> <p>This setting is only for Aurora Limitless Database.</p>"""
    endpoint: NotRequired["capo_rds.types.string.String"]
    """<p>The connection endpoint for the DB shard group.</p>"""
    db_shard_group_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB shard group.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]

compute_redundancy instance-attribute

compute_redundancy: NotRequired[IntegerOptional]

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.

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[String]

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

db_shard_group_arn instance-attribute

db_shard_group_arn: NotRequired[String]

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

db_shard_group_identifier instance-attribute

db_shard_group_identifier: NotRequired[DBShardGroupIdentifier]

The name of the DB shard group.

db_shard_group_resource_id instance-attribute

db_shard_group_resource_id: NotRequired[String]

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

endpoint instance-attribute

endpoint: NotRequired[String]

The connection endpoint for the DB shard group.

max_acu instance-attribute

max_acu: NotRequired[DoubleOptional]

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

min_acu instance-attribute

min_acu: NotRequired[DoubleOptional]

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

publicly_accessible instance-attribute

publicly_accessible: NotRequired[BooleanOptional]

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.

status instance-attribute

status: NotRequired[String]

The status of the DB shard group.

tag_list instance-attribute

tag_list: NotRequired[TagList]