Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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.

[ aws . lightsail ]

update-relational-database

Description

Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update 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

  update-relational-database
--relational-database-name <value>
[--master-user-password <value>]
[--rotate-master-user-password | --no-rotate-master-user-password]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--enable-backup-retention | --no-enable-backup-retention]
[--disable-backup-retention | --no-disable-backup-retention]
[--publicly-accessible | --no-publicly-accessible]
[--apply-immediately | --no-apply-immediately]
[--ca-certificate-identifier <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--relational-database-name (string)

The name of your database to update.

--master-user-password (string)

The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

--rotate-master-user-password | --no-rotate-master-user-password (boolean)

When true , the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

--preferred-backup-window (string)

The daily time range during which automated backups are created for your database if automated backups are enabled.

Constraints:

  • Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30
  • Specified in Coordinated Universal Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

--preferred-maintenance-window (string)

The weekly time range during which system maintenance can occur on your database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.
  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
  • Must be at least 30 minutes.
  • Specified in Coordinated Universal Time (UTC).
  • Example: Tue:17:00-Tue:17:30

--enable-backup-retention | --no-enable-backup-retention (boolean)

When true , enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

--disable-backup-retention | --no-disable-backup-retention (boolean)

When true , disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

--publicly-accessible | --no-publicly-accessible (boolean)

Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

--apply-immediately | --no-apply-immediately (boolean)

When true , applies changes immediately. When false , applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

--ca-certificate-identifier (string)

Indicates the certificate that needs to be associated with the database.

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