[ aws . lightsail ]



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

Parameter updates don’t cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot . Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters 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.


--relational-database-name <value>
--parameters <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--relational-database-name (string)

The name of your database for which to update parameters.

--parameters (list)

The database parameters to update.


Describes the parameters of a database.

allowedValues -> (string)

Specifies the valid range of values for the parameter.

applyMethod -> (string)

Indicates when parameter updates are applied.

Can be immediate or pending-reboot .

applyType -> (string)

Specifies the engine-specific parameter type.

dataType -> (string)

Specifies the valid data type for the parameter.

description -> (string)

Provides a description of the parameter.

isModifiable -> (boolean)

A Boolean value indicating whether the parameter can be modified.

parameterName -> (string)

Specifies the name of the parameter.

parameterValue -> (string)

Specifies the value of the parameter.

Shorthand Syntax:

allowedValues=string,applyMethod=string,applyType=string,dataType=string,description=string,isModifiable=boolean,parameterName=string,parameterValue=string ...

JSON Syntax:

    "allowedValues": "string",
    "applyMethod": "string",
    "applyType": "string",
    "dataType": "string",
    "description": "string",
    "isModifiable": true|false,
    "parameterName": "string",
    "parameterValue": "string"

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


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.


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.