ModifyDBShardGroup - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ModifyDBShardGroup

Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.

Request Parameters

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

DBShardGroupIdentifier

The name of the DB shard group to modify.

Type: String

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

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

Required: Yes

ComputeRedundancy

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.

Type: Integer

Required: No

MaxACU

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

Type: Double

Required: No

MinACU

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

Type: Double

Required: No

Response Elements

The following elements are returned by the service.

ComputeRedundancy

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.

Type: Integer

DBClusterIdentifier

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

Type: String

DBShardGroupArn

The Amazon Resource Name (ARN) 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 Amazon Web Services 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

MinACU

The minimum 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

TagList.Tag.N

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.

Type: Array of Tag objects

Errors

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

DBShardGroupAlreadyExists

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

HTTP Status Code: 400

DBShardGroupNotFound

The specified DB shard group name wasn't found.

HTTP Status Code: 404

InvalidDBClusterStateFault

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

HTTP Status Code: 400

See Also

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