paws.management (version 0.1.0)

ssm_create_maintenance_window: Creates a new Maintenance Window

Description

Creates a new Maintenance Window.

Usage

ssm_create_maintenance_window(Name, Description, StartDate, EndDate,
  Schedule, ScheduleTimezone, Duration, Cutoff, AllowUnassociatedTargets,
  ClientToken, Tags)

Arguments

Name

[required] The name of the Maintenance Window.

Description

An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.

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.

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

[required] 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", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Duration

[required] The duration of the Maintenance Window in hours.

Cutoff

[required] The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

AllowUnassociatedTargets

[required] Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window

If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.

ClientToken

User-provided idempotency token.

Tags

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Maintenance Window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing Maintenance Window, use the AddTagsToResource action.

Request syntax

svc$create_maintenance_window(
  Name = "string",
  Description = "string",
  StartDate = "string",
  EndDate = "string",
  Schedule = "string",
  ScheduleTimezone = "string",
  Duration = 123,
  Cutoff = 123,
  AllowUnassociatedTargets = TRUE|FALSE,
  ClientToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)