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.
Deletes a database in Amazon Lightsail.
The delete relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
delete-relational-database
--relational-database-name <value>
[--skip-final-snapshot | --no-skip-final-snapshot]
[--final-relational-database-snapshot-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--relational-database-name
(string)
The name of the database that you are deleting.
--skip-final-snapshot
| --no-skip-final-snapshot
(boolean)
Determines whether a final database snapshot is created before your database is deleted. If
true
is specified, no database snapshot is created. Iffalse
is specified, a database snapshot is created before your database is deleted.You must specify the
final relational database snapshot name
parameter if theskip final snapshot
parameter isfalse
.Default:
false
--final-relational-database-snapshot-name
(string)
The name of the database snapshot created if
skip final snapshot
isfalse
, which is the default value for that parameter.Note
Specifying this parameter and also specifying the
skip final snapshot
parameter totrue
results in an error.Constraints:
- Must contain from 2 to 255 alphanumeric characters, or hyphens.
- The first and last character must be a letter or number.
--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.
To delete a managed database
The following delete-relational-database
example deletes the specified managed database.
aws lightsail delete-relational-database \
--relational-database-name Database-1
Output:
{
"operations": [
{
"id": "3b0c41c1-053d-46f0-92a3-14f76141dc86",
"resourceName": "Database-1",
"resourceType": "RelationalDatabase",
"createdAt": 1569875210.999,
"location": {
"availabilityZone": "us-west-2a",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationType": "DeleteRelationalDatabase",
"status": "Started",
"statusChangedAt": 1569875210.999
},
{
"id": "01ddeae8-a87a-4a4b-a1f3-092c71bf9180",
"resourceName": "Database-1",
"resourceType": "RelationalDatabase",
"createdAt": 1569875211.029,
"location": {
"availabilityZone": "us-west-2a",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "Database-1-FinalSnapshot-1569875210793",
"operationType": "CreateRelationalDatabaseSnapshot",
"status": "Started",
"statusChangedAt": 1569875211.029
},
{
"id": "74d73681-30e8-4532-974e-1f23cd3f9f73",
"resourceName": "Database-1-FinalSnapshot-1569875210793",
"resourceType": "RelationalDatabaseSnapshot",
"createdAt": 1569875211.029,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"isTerminal": false,
"operationDetails": "Database-1",
"operationType": "CreateRelationalDatabaseSnapshot",
"status": "Started",
"statusChangedAt": 1569875211.029
}
]
}
operations -> (list)
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
(structure)
Describes the API operation.
id -> (string)
The ID of the operation.resourceName -> (string)
The resource name.resourceType -> (string)
The resource type.createdAt -> (timestamp)
The timestamp when the operation was initialized (e.g.,1479816991.349
).location -> (structure)
The Amazon Web Services Region and Availability Zone.
availabilityZone -> (string)
The Availability Zone. Follows the formatus-east-2a
(case-sensitive).regionName -> (string)
The AWS Region name.isTerminal -> (boolean)
A Boolean value indicating whether the operation is terminal.operationDetails -> (string)
Details about the operation (e.g.,Debian-1GB-Ohio-1
).operationType -> (string)
The type of operation.status -> (string)
The status of the operation.statusChangedAt -> (timestamp)
The timestamp when the status was changed (e.g.,1479816991.349
).errorCode -> (string)
The error code.errorDetails -> (string)
The error details.