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
- MaxACU
-
The maximum 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 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.
- DBShardGroupAlreadyExists
-
The specified DB shard group name must be unique in your AWS account in the specified AWS 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
- InvalidMaxAcu
-
The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
