Skip to contents

Updates an existing maintenance window

Source: R/ssm_operations.R
ssm_update_maintenance_window.Rd

Updates an existing maintenance window. Only specified parameters are modified.

See https://www.paws-r-sdk.com/docs/ssm_update_maintenance_window/ for full documentation.

Usage

ssm_update_maintenance_window(
  WindowId,
  Name = NULL,
  Description = NULL,
  StartDate = NULL,
  EndDate = NULL,
  Schedule = NULL,
  ScheduleTimezone = NULL,
  ScheduleOffset = NULL,
  Duration = NULL,
  Cutoff = NULL,
  AllowUnassociatedTargets = NULL,
  Enabled = NULL,
  Replace = NULL
)

Arguments

WindowId

[required] The ID of the maintenance window to update.

Name

The name of the maintenance window.

Description

An optional description for the update request.

StartDate

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

EndDate

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Schedule

The schedule of the maintenance window in the form of a cron or rate expression.

ScheduleTimezone

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

ScheduleOffset

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Duration

The duration of the maintenance window in hours.

Cutoff

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

AllowUnassociatedTargets

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Enabled

Whether the maintenance window is enabled.

Replace

If True, then all fields that are required by the create_maintenance_window operation are also required for this API request. Optional fields that aren't specified are set to null.