Amazon DocumentDB
Developer Guide

ModifyDBSubnetGroup

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

Request Parameters

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

DBSubnetGroupName

The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Type: String

Required: Yes

SubnetIds.SubnetIdentifier.N

The Amazon EC2 subnet IDs for the DB subnet group.

Type: Array of strings

Required: Yes

DBSubnetGroupDescription

The description for the DB subnet group.

Type: String

Required: No

Response Elements

The following element is returned by the service.

DBSubnetGroup

Detailed information about a DB subnet group.

Type: DBSubnetGroup object

Errors

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

DBSubnetGroupDoesNotCoverEnoughAZs

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

HTTP Status Code: 400

DBSubnetGroupNotFoundFault

DBSubnetGroupName doesn't refer to an existing DB subnet group.

HTTP Status Code: 404

DBSubnetQuotaExceededFault

The request would cause you to exceed the allowed number of subnets in a DB subnet group.

HTTP Status Code: 400

InvalidSubnet

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

HTTP Status Code: 400

SubnetAlreadyInUse

The DB subnet is already in use in the Availability Zone.

HTTP Status Code: 400

See Also

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