/AWS1/CL_SSM=>CREATEMAINTENANCEWINDOW()
¶
About CreateMaintenanceWindow¶
Creates a new maintenance window.
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME
TYPE /AWS1/SSMMAINTENANCEWINDOWNAME
/AWS1/SSMMAINTENANCEWINDOWNAME
¶
The name of the maintenance window.
IV_SCHEDULE
TYPE /AWS1/SSMMAINTENANCEWINDOWSCHD
/AWS1/SSMMAINTENANCEWINDOWSCHD
¶
The schedule of the maintenance window in the form of a cron or rate expression.
IV_DURATION
TYPE /AWS1/SSMMAINTENANCEWINDOWDU00
/AWS1/SSMMAINTENANCEWINDOWDU00
¶
The duration of the maintenance window in hours.
IV_CUTOFF
TYPE /AWS1/SSMMAINTENANCEWINDOWCU00
/AWS1/SSMMAINTENANCEWINDOWCU00
¶
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
IV_ALLOWUNASSOCIATEDTARGETS
TYPE /AWS1/SSMMAINTENANCEWINDOWAL00
/AWS1/SSMMAINTENANCEWINDOWAL00
¶
Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node 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.
Optional arguments:¶
IV_DESCRIPTION
TYPE /AWS1/SSMMAINTENANCEWINDOWDESC
/AWS1/SSMMAINTENANCEWINDOWDESC
¶
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
IV_STARTDATE
TYPE /AWS1/SSMMAINTENANCEWINDOWST00
/AWS1/SSMMAINTENANCEWINDOWST00
¶
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.
IV_ENDDATE
TYPE /AWS1/SSMMAINTENANCEWINDOWST00
/AWS1/SSMMAINTENANCEWINDOWST00
¶
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.
IV_SCHEDULETIMEZONE
TYPE /AWS1/SSMMAINTENANCEWINDOWTI00
/AWS1/SSMMAINTENANCEWINDOWTI00
¶
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.
IV_SCHEDULEOFFSET
TYPE /AWS1/SSMMAINTENANCEWINDOWOFF
/AWS1/SSMMAINTENANCEWINDOWOFF
¶
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 on 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.
IV_CLIENTTOKEN
TYPE /AWS1/SSMCLIENTTOKEN
/AWS1/SSMCLIENTTOKEN
¶
User-provided idempotency token.
IT_TAGS
TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST
TT_TAGLIST
¶
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-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 operation.