Skip to content

Create Db Shard Group

rds_create_db_shard_group R Documentation

Creates a new DB shard group for Aurora Limitless Database

Description

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

Usage

rds_create_db_shard_group(DBShardGroupIdentifier, DBClusterIdentifier,
  ComputeRedundancy, MaxACU, MinACU, PubliclyAccessible)

Arguments

DBShardGroupIdentifier

[required] The name of the DB shard group.

DBClusterIdentifier

[required] The name of the primary DB cluster for the DB shard group.

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.

MaxACU

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

MinACU

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

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.

Value

A list with the following syntax: 

list(
  DBShardGroupResourceId = "string",
  DBShardGroupIdentifier = "string",
  DBClusterIdentifier = "string",
  MaxACU = 123.0,
  MinACU = 123.0,
  ComputeRedundancy = 123,
  Status = "string",
  PubliclyAccessible = TRUE|FALSE,
  Endpoint = "string"
)

Request syntax

svc$create_db_shard_group(
  DBShardGroupIdentifier = "string",
  DBClusterIdentifier = "string",
  ComputeRedundancy = 123,
  MaxACU = 123.0,
  MinACU = 123.0,
  PubliclyAccessible = TRUE|FALSE
)