get-relational-database¶
Description¶
Returns information about a specific database in Amazon Lightsail.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-relational-database
--relational-database-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--relational-database-name (string)
The name of the database that you are looking up.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To get information about a relational database
The following get-relational-database example displays details about the specified relational database.
aws lightsail get-relational-database \
--relational-database-name Database-1
Output:
{
"relationalDatabase": {
"name": "Database-1",
"arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4",
"supportCode": "6EXAMPLE3362/ls-9EXAMPLE8ad863723b62cc8901a8aa6e794ae0d2",
"createdAt": 1571259453.795,
"location": {
"availabilityZone": "us-west-2a",
"regionName": "us-west-2"
},
"resourceType": "RelationalDatabase",
"tags": [],
"relationalDatabaseBlueprintId": "mysql_8_0",
"relationalDatabaseBundleId": "micro_1_0",
"masterDatabaseName": "dbmaster",
"hardware": {
"cpuCount": 1,
"diskSizeInGb": 40,
"ramSizeInGb": 1.0
},
"state": "available",
"backupRetentionEnabled": false,
"pendingModifiedValues": {},
"engine": "mysql",
"engineVersion": "8.0.16",
"masterUsername": "dbmasteruser",
"parameterApplyStatus": "in-sync",
"preferredBackupWindow": "10:01-10:31",
"preferredMaintenanceWindow": "sat:11:14-sat:11:44",
"publiclyAccessible": true,
"masterEndpoint": {
"port": 3306,
"address": "ls-9EXAMPLE8ad863723b62ccEXAMPLEa6e794ae0d2.czowadgeezqi.us-west-2.rds.amazonaws.com"
},
"pendingMaintenanceActions": []
}
}
Output¶
relationalDatabase -> (structure)
An object describing the specified database.
name -> (string)
The unique name of the database resource in Lightsail.
arn -> (string)
The Amazon Resource Name (ARN) of the database.
supportCode -> (string)
The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt -> (timestamp)
The timestamp when the database was created. Formatted in Unix time.
location -> (structure)
The Region name and Availability Zone where the database is located.
availabilityZone -> (string)
The Availability Zone. Follows the format
us-east-2a(case-sensitive).regionName -> (string)
The AWS Region name.
resourceType -> (string)
The Lightsail resource type for the database (for example,
RelationalDatabase).tags -> (list)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide .
(structure)
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Lightsail Dev Guide .
key -> (string)
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value -> (string)
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
relationalDatabaseBlueprintId -> (string)
The blueprint ID for the database. A blueprint describes the major engine version of a database.
relationalDatabaseBundleId -> (string)
The bundle ID for the database. A bundle describes the performance specifications for your database.
masterDatabaseName -> (string)
The name of the master database created when the Lightsail database resource is created.
hardware -> (structure)
Describes the hardware of the database.
cpuCount -> (integer)
The number of vCPUs for the database.
diskSizeInGb -> (integer)
The size of the disk for the database.
ramSizeInGb -> (float)
The amount of RAM in GB for the database.
state -> (string)
Describes the current state of the database.
secondaryAvailabilityZone -> (string)
Describes the secondary Availability Zone of a high availability database.
The secondary database is used for failover support of a high availability database.
backupRetentionEnabled -> (boolean)
A Boolean value indicating whether automated backup retention is enabled for the database.
pendingModifiedValues -> (structure)
Describes pending database value modifications.
masterUserPassword -> (string)
The password for the master user of the database.
engineVersion -> (string)
The database engine version.
backupRetentionEnabled -> (boolean)
A Boolean value indicating whether automated backup retention is enabled.
engine -> (string)
The database software (for example,
MySQL).engineVersion -> (string)
The database engine version (for example,
5.7.23).latestRestorableTime -> (timestamp)
The latest point in time to which the database can be restored. Formatted in Unix time.
masterUsername -> (string)
The master user name of the database.
parameterApplyStatus -> (string)
The status of parameter updates for the database.
preferredBackupWindow -> (string)
The daily time range during which automated backups are created for the database (for example,
16:00-16:30).preferredMaintenanceWindow -> (string)
The weekly time range during which system maintenance can occur on the database.
In the format
ddd:hh24:mi-ddd:hh24:mi. For example,Tue:17:00-Tue:17:30.publiclyAccessible -> (boolean)
A Boolean value indicating whether the database is publicly accessible.
masterEndpoint -> (structure)
The master endpoint for the database.
port -> (integer)
Specifies the port that the database is listening on.
address -> (string)
Specifies the DNS address of the database.
pendingMaintenanceActions -> (list)
Describes the pending maintenance actions for the database.
(structure)
Describes a pending database maintenance action.
action -> (string)
The type of pending database maintenance action.
description -> (string)
Additional detail about the pending database maintenance action.
currentApplyDate -> (timestamp)
The effective date of the pending database maintenance action.
caCertificateIdentifier -> (string)
The certificate associated with the database.