[ aws . lightsail ]

get-relational-database-master-user-password

Description

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-relational-database-master-user-password
--relational-database-name <value>
[--password-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--relational-database-name (string)

The name of your database for which to get the master user password.

--password-version (string)

The password version to return.

Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT . After the PENDING password rotates to CURRENT , the PENDING password is no longer available.

Default: CURRENT

Possible values:

• CURRENT

• PREVIOUS

• PENDING

--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 the master user password for a relational database

The following get-relational-database-master-user-password example returns information about the master user password for the specified relational database.

aws lightsail get-relational-database-master-user-password \
    --relational-database-name Database-1

Output:

{
    "masterUserPassword": "VEXAMPLEec.9qvx,_t<)Wkf)kwboM,>2",
    "createdAt": 1571259453.959
}

Output

masterUserPassword -> (string)

The master user password for the password version specified.

createdAt -> (timestamp)

The timestamp when the specified version of the master user password was created.