Skip to content

RDS  >  Operations  >  create_db_shard_group

create_db_shard_group

Operation

create_db_shard_group async

create_db_shard_group(request: CreateDBShardGroupInput | CreateDBShardGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateDBShardGroupOutput
create_db_shard_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDBShardGroupInputDict]) -> CreateDBShardGroupOutput

Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

Valid for: Aurora DB clusters only

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateDBShardGroupOutput

An instance of CreateDBShardGroupOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateDBShardGroupInput dataclass

Bases: _SerdeShape

Dataclass for CreateDBShardGroupInput structure.

Attributes
compute_redundancy class-attribute instance-attribute
compute_redundancy: int | None = ...

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

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

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

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

db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

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

db_shard_group_identifier class-attribute instance-attribute
db_shard_group_identifier: str | None = ...

The name of the DB shard group.

max_acu class-attribute instance-attribute
max_acu: float | None = ...

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

min_acu class-attribute instance-attribute
min_acu: float | None = ...

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

publicly_accessible class-attribute instance-attribute
publicly_accessible: bool | None = ...

Specifies 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 is not 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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB shard group is private.

  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB shard group is private.

  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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.

Dictionaries

CreateDBShardGroupInputDict

Bases: TypedDict

Dictionary form of CreateDBShardGroupInput.

Attributes
compute_redundancy instance-attribute
compute_redundancy: int | None

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

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

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

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

db_cluster_identifier instance-attribute
db_cluster_identifier: Required[str]

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

db_shard_group_identifier instance-attribute
db_shard_group_identifier: Required[str]

The name of the DB shard group.

max_acu instance-attribute
max_acu: Required[float]

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

min_acu instance-attribute
min_acu: float | None

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

publicly_accessible instance-attribute
publicly_accessible: bool | None

Specifies 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 is not 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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn't have an internet gateway attached to it, the DB shard group is private.

  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn't have an internet gateway attached to it, the DB shard group is private.

  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

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.

Output

CreateDBShardGroupOutput dataclass

Bases: _SerdeShape

Contains the details for an Amazon RDS DB shard group.

Attributes

compute_redundancy class-attribute instance-attribute
compute_redundancy: int | None = ...

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 class-attribute instance-attribute
db_cluster_identifier: str | None = ...

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

db_shard_group_arn class-attribute instance-attribute
db_shard_group_arn: str | None = ...

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

db_shard_group_identifier class-attribute instance-attribute
db_shard_group_identifier: str | None = ...

The name of the DB shard group.

db_shard_group_resource_id class-attribute instance-attribute
db_shard_group_resource_id: str | None = ...

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

endpoint class-attribute instance-attribute
endpoint: str | None = ...

The connection endpoint for the DB shard group.

max_acu class-attribute instance-attribute
max_acu: float | None = ...

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

min_acu class-attribute instance-attribute
min_acu: float | None = ...

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

publicly_accessible class-attribute instance-attribute
publicly_accessible: bool | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute
status: str | None = ...

The status of the DB shard group.

tag_list class-attribute instance-attribute
tag_list: list[Tag] | None = ...

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.