CreateDBShardGroup - Amazon Relational Database Service

CreateDBShardGroup

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterIdentifier

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

Type: String

Required: Yes

DBShardGroupIdentifier

The name of the DB shard group.

Type: String

Required: Yes

MaxACU

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

Type: Double

Required: Yes

ComputeRedundancy

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.

Type: Integer

Required: No

PubliclyAccessible

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.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

ComputeRedundancy

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.

Type: Integer

DBClusterIdentifier

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

Type: String

DBShardGroupIdentifier

The name of the DB shard group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*

DBShardGroupResourceId

The AWS Region-unique, immutable identifier for the DB shard group.

Type: String

Endpoint

The connection endpoint for the DB shard group.

Type: String

MaxACU

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

Type: Double

PubliclyAccessible

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.

Type: Boolean

Status

The status of the DB shard group.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBShardGroupAlreadyExists

The specified DB shard group name must be unique in your AWS account in the specified AWS Region.

HTTP Status Code: 400

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidMaxAcu

The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

HTTP Status Code: 400

MaxDBShardGroupLimitReached

The maximum number of DB shard groups for your AWS account in the specified AWS Region has been reached.

HTTP Status Code: 400

UnsupportedDBEngineVersion

The specified DB engine version isn't supported for Aurora Limitless Database.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: