Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . docdb ]

delete-db-subnet-group

Description

Deletes a subnet group.

Note

The specified database subnet group must not be associated with any DB instances.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-db-subnet-group
--db-subnet-group-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--db-subnet-group-name (string)

The name of the database subnet group to delete.

Note

You can't delete the default subnet group.

Constraints:

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

Example: mySubnetgroup

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Examples

To delete an Amazon DocumentDB subnet group

The following delete-db-subnet-group example deletes the Amazon DocumentDB subnet group sample-subnet-group.

aws docdb delete-db-subnet-group \
    --db-subnet-group-name sample-subnet-group

This command produces no output.

For more information, see Deleting an Amazon DocumentDB Subnet Group in the Amazon DocumentDB Developer Guide.

Output

None