delete-relational-database¶
Description¶
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 Lightsail Dev Guide .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
Synopsis¶
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>]
Options¶
--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. If false is specified, a database snapshot is created before your database is deleted.
You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false .
Default: false
--final-relational-database-snapshot-name (string)
The name of the database snapshot created if skip final snapshot is false , which is the default value for that parameter.
Note
Specifying this parameter and also specifying the skip final snapshot parameter to true 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.
Output¶
operations -> (list)
An object describing the result of your delete relational database 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 region and Availability Zone.
availabilityZone -> (string)
The Availability Zone. Follows the format us-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.