Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-apply-pending-maintenance-action

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Applies a pending maintenance action to a resource. For example, you can schedule a pending maintenance action to be applied during the next maintenance window for a DB instance.

Syntax

rds-apply-pending-maintenance-action resource-identifier

--apply-action value

--opt value

[General Options]

Options

Name Description Required

--resource-identifier value

The Amazon Resource Name (ARN) of the Amazon RDS resource (for example, a DB instance) that the pending maintenance action will be applied to.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-apply-pending-maintenance-action my-resource-identifier.

Yes

--apply-action

-a

The pending maintenance action to apply to the resource.

Yes

--opt

-o

A value that specifies a particular type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone.

Valid values:

  • immediate—Apply the maintenance action immediately.

  • next-maintenance—Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in—Cancel any existing next-maintenance opt-in requests.

Yes

Output

This command does not return any output.

Example

The following example immediately applies a pending operating system upgrade to a DB instance named mysql-db that is owned by customer 001234567890.

Copy
PROMPT> rds-apply-pending-maintenance-action arn:aws:rds:us-west-2:001234567890:db:mysql-db -a os-upgrade -o immediate