[ aws . docdb ]

delete-db-instance

Description

Deletes a previously provisioned instance.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-db-instance
--db-instance-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-instance-identifier (string)

The instance identifier for the instance to be deleted. This parameter isn’t case sensitive.

Constraints:

  • Must match the name of an existing instance.

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

Examples

To delete an Amazon DocumentDB instance

The following delete-db-instance example deletes the Amazon DocumentDB instance sample-cluster-instance-2.

aws docdb delete-db-instance \
    --db-instance-identifier sample-cluster-instance-2

Output:

{
    "DBInstance": {
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-91280df6",
            "SubnetGroupStatus": "Complete"
        },
        "PreferredBackupWindow": "00:00-00:30",
        "InstanceCreateTime": "2019-03-18T18:37:33.709Z",
        "DBInstanceClass": "db.r4.xlarge",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE",
        "BackupRetentionPeriod": 3,
        "Engine": "docdb",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "AutoMinorVersionUpgrade": true,
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "Endpoint": {
            "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "PendingModifiedValues": {},
        "DBInstanceStatus": "deleting",
        "PubliclyAccessible": false,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZone": "us-west-2c",
        "StorageEncrypted": false
    }
}

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

Output

DBInstance -> (structure)

Detailed information about an instance.

DBInstanceIdentifier -> (string)

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

DBInstanceClass -> (string)

Contains the name of the compute and memory capacity class of the instance.

Engine -> (string)

Provides the name of the database engine to be used for this instance.

DBInstanceStatus -> (string)

Specifies the current state of this database.

Endpoint -> (structure)

Specifies the connection endpoint.

Address -> (string)

Specifies the DNS address of the instance.

Port -> (integer)

Specifies the port that the database engine is listening on.

HostedZoneId -> (string)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

InstanceCreateTime -> (timestamp)

Provides the date and time that the instance was created.

PreferredBackupWindow -> (string)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

BackupRetentionPeriod -> (integer)

Specifies the number of days for which automatic snapshots are retained.

VpcSecurityGroups -> (list)

Provides a list of VPC security group elements that the instance belongs to.

(structure)

Used as a response element for queries on virtual private cloud (VPC) security group membership.

VpcSecurityGroupId -> (string)

The name of the VPC security group.

Status -> (string)

The status of the VPC security group.

AvailabilityZone -> (string)

Specifies the name of the Availability Zone that the instance is located in.

DBSubnetGroup -> (structure)

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the 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.

PreferredMaintenanceWindow -> (string)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

PendingModifiedValues -> (structure)

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

DBInstanceClass -> (string)

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

AllocatedStorage -> (integer)

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

MasterUserPassword -> (string)

Contains the pending or currently in-progress change of the master credentials for the instance.

Port -> (integer)

Specifies the pending port for the instance.

BackupRetentionPeriod -> (integer)

Specifies the pending number of days for which automated backups are retained.

MultiAZ -> (boolean)

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

EngineVersion -> (string)

Indicates the database engine version.

LicenseModel -> (string)

The license model for the instance.

Valid values: license-included , bring-your-own-license , general-public-license

Iops -> (integer)

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

DBInstanceIdentifier -> (string)

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

StorageType -> (string)

Specifies the storage type to be associated with the instance.

CACertificateIdentifier -> (string)

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

DBSubnetGroupName -> (string)

The new subnet group for the instance.

PendingCloudwatchLogsExports -> (structure)

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

LogTypesToEnable -> (list)

Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.

(string)

LogTypesToDisable -> (list)

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

(string)

LatestRestorableTime -> (timestamp)

Specifies the latest time to which a database can be restored with point-in-time restore.

EngineVersion -> (string)

Indicates the database engine version.

AutoMinorVersionUpgrade -> (boolean)

Indicates that minor version patches are applied automatically.

PubliclyAccessible -> (boolean)

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .

StatusInfos -> (list)

The status of a read replica. If the instance is not a read replica, this is blank.

(structure)

Provides a list of status information for an instance.

StatusType -> (string)

This value is currently “read replication .”

Normal -> (boolean)

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

Status -> (string)

Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .

Message -> (string)

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

DBClusterIdentifier -> (string)

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

StorageEncrypted -> (boolean)

Specifies whether or not the instance is encrypted.

KmsKeyId -> (string)

If StorageEncrypted is true , the AWS KMS key identifier for the encrypted instance.

DbiResourceId -> (string)

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

CACertificateIdentifier -> (string)

The identifier of the CA certificate for this DB instance.

PromotionTier -> (integer)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

DBInstanceArn -> (string)

The Amazon Resource Name (ARN) for the instance.

EnabledCloudwatchLogsExports -> (list)

A list of log types that this instance is configured to export to Amazon CloudWatch Logs.

(string)