ssm_update_maintenance_window: Updates an existing maintenance window

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

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

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Usage

1
2
3
ssm_update_maintenance_window(WindowId, Name, Description, StartDate,
  EndDate, Schedule, ScheduleTimezone, ScheduleOffset, Duration, Cutoff,
  AllowUnassociatedTargets, Enabled, Replace)

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

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 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 CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
list(
  WindowId = "string",
  Name = "string",
  Description = "string",
  StartDate = "string",
  EndDate = "string",
  Schedule = "string",
  ScheduleTimezone = "string",
  ScheduleOffset = 123,
  Duration = 123,
  Cutoff = 123,
  AllowUnassociatedTargets = TRUE|FALSE,
  Enabled = TRUE|FALSE
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
svc$update_maintenance_window(
  WindowId = "string",
  Name = "string",
  Description = "string",
  StartDate = "string",
  EndDate = "string",
  Schedule = "string",
  ScheduleTimezone = "string",
  ScheduleOffset = 123,
  Duration = 123,
  Cutoff = 123,
  AllowUnassociatedTargets = TRUE|FALSE,
  Enabled = TRUE|FALSE,
  Replace = TRUE|FALSE
)

paws.management documentation built on March 8, 2021, 1:07 a.m.