Skip to content

Apply Pending Maintenance Action

rds_apply_pending_maintenance_action R Documentation

Applies a pending maintenance action to a resource (for example, to a DB instance)

Description

Applies a pending maintenance action to a resource (for example, to a DB instance).

Usage

rds_apply_pending_maintenance_action(ResourceIdentifier, ApplyAction,
  OptInType)

Arguments

ResourceIdentifier

[required] The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

ApplyAction

[required] The pending maintenance action to apply to this resource.

Valid Values:

  • ca-certificate-rotation

  • db-upgrade

  • hardware-maintenance

  • os-upgrade

  • system-update

For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.

OptInType

[required] A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't 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.

Value

A list with the following syntax: 

list(
  ResourcePendingMaintenanceActions = list(
    ResourceIdentifier = "string",
    PendingMaintenanceActionDetails = list(
      list(
        Action = "string",
        AutoAppliedAfterDate = as.POSIXct(
          "2015-01-01"
        ),
        ForcedApplyDate = as.POSIXct(
          "2015-01-01"
        ),
        OptInStatus = "string",
        CurrentApplyDate = as.POSIXct(
          "2015-01-01"
        ),
        Description = "string"
      )
    )
  )
)

Request syntax

svc$apply_pending_maintenance_action(
  ResourceIdentifier = "string",
  ApplyAction = "string",
  OptInType = "string"
)

Examples

## Not run: 
# This example immediately applies a pending system update to a DB
# instance.
svc$apply_pending_maintenance_action(
  ApplyAction = "system-update",
  OptInType = "immediate",
  ResourceIdentifier = "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
)

## End(Not run)