Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
modify-db-subnet-group
--db-subnet-group-name <value>
[--db-subnet-group-description <value>]
--subnet-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-subnet-group-name
(string)
The name for the 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
--db-subnet-group-description
(string)
The description for the subnet group.
--subnet-ids
(list)
The Amazon EC2 subnet IDs for the subnet group.
(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To modify an Amazon DocumentDB subnet group
The following modify-db-subnet-group
example modifies the subnet group sample-subnet-group
by adding the specified subnets and a new description.
aws docdb modify-db-subnet-group \
--db-subnet-group-name sample-subnet-group \
--subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \
--db-subnet-group-description "New subnet description"
Output:
{
"DBSubnetGroup": {
"DBSubnetGroupName": "sample-subnet-group",
"SubnetGroupStatus": "Complete",
"DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group",
"VpcId": "vpc-91280df6",
"DBSubnetGroupDescription": "New subnet description",
"Subnets": [
{
"SubnetIdentifier": "subnet-b3806e8f",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
},
{
"SubnetIdentifier": "subnet-53ab3636",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
},
{
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetStatus": "Active",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
}
]
}
}
For more information, see Modifying an Amazon DocumentDB Subnet Group in the Amazon DocumentDB Developer Guide.
DBSubnetGroup -> (structure)
Detailed information about a subnet group.
DBSubnetGroupName -> (string)
The name of the subnet group.
DBSubnetGroupDescription -> (string)
Provides the description of the subnet group.
VpcId -> (string)
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus -> (string)
Provides the status of the subnet group.
Subnets -> (list)
Detailed information about one or more subnets within a subnet group.
(structure)
Detailed information about a subnet.
SubnetIdentifier -> (string)
Specifies the identifier of the subnet.
SubnetAvailabilityZone -> (structure)
Specifies the Availability Zone for the subnet.
Name -> (string)
The name of the Availability Zone.
SubnetStatus -> (string)
Specifies the status of the subnet.
DBSubnetGroupArn -> (string)
The Amazon Resource Name (ARN) for the DB subnet group.