| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SSM.CreateMaintenanceWindow
Description
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.
Synopsis
- data CreateMaintenanceWindow = CreateMaintenanceWindow' {}
- newCreateMaintenanceWindow :: Text -> Text -> Natural -> Natural -> Bool -> CreateMaintenanceWindow
- createMaintenanceWindow_clientToken :: Lens' CreateMaintenanceWindow (Maybe Text)
- createMaintenanceWindow_scheduleOffset :: Lens' CreateMaintenanceWindow (Maybe Natural)
- createMaintenanceWindow_endDate :: Lens' CreateMaintenanceWindow (Maybe Text)
- createMaintenanceWindow_scheduleTimezone :: Lens' CreateMaintenanceWindow (Maybe Text)
- createMaintenanceWindow_startDate :: Lens' CreateMaintenanceWindow (Maybe Text)
- createMaintenanceWindow_description :: Lens' CreateMaintenanceWindow (Maybe Text)
- createMaintenanceWindow_tags :: Lens' CreateMaintenanceWindow (Maybe [Tag])
- createMaintenanceWindow_name :: Lens' CreateMaintenanceWindow Text
- createMaintenanceWindow_schedule :: Lens' CreateMaintenanceWindow Text
- createMaintenanceWindow_duration :: Lens' CreateMaintenanceWindow Natural
- createMaintenanceWindow_cutoff :: Lens' CreateMaintenanceWindow Natural
- createMaintenanceWindow_allowUnassociatedTargets :: Lens' CreateMaintenanceWindow Bool
- data CreateMaintenanceWindowResponse = CreateMaintenanceWindowResponse' {
- windowId :: Maybe Text
- httpStatus :: Int
- newCreateMaintenanceWindowResponse :: Int -> CreateMaintenanceWindowResponse
- createMaintenanceWindowResponse_windowId :: Lens' CreateMaintenanceWindowResponse (Maybe Text)
- createMaintenanceWindowResponse_httpStatus :: Lens' CreateMaintenanceWindowResponse Int
Creating a Request
data CreateMaintenanceWindow Source #
See: newCreateMaintenanceWindow smart constructor.
Constructors
| CreateMaintenanceWindow' | |
Fields
| |
Instances
newCreateMaintenanceWindow Source #
Create a value of CreateMaintenanceWindow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateMaintenanceWindow', createMaintenanceWindow_clientToken - User-provided idempotency token.
$sel:scheduleOffset:CreateMaintenanceWindow', createMaintenanceWindow_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 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.
$sel:endDate:CreateMaintenanceWindow', createMaintenanceWindow_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.
$sel:scheduleTimezone:CreateMaintenanceWindow', createMaintenanceWindow_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.
$sel:startDate:CreateMaintenanceWindow', createMaintenanceWindow_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.
$sel:description:CreateMaintenanceWindow', createMaintenanceWindow_description - An optional description for the maintenance window. We recommend
specifying a description to help you organize your maintenance windows.
$sel:tags:CreateMaintenanceWindow', createMaintenanceWindow_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-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.
$sel:name:CreateMaintenanceWindow', createMaintenanceWindow_name - The name of the maintenance window.
$sel:schedule:CreateMaintenanceWindow', createMaintenanceWindow_schedule - The schedule of the maintenance window in the form of a cron or rate
expression.
$sel:duration:CreateMaintenanceWindow', createMaintenanceWindow_duration - The duration of the maintenance window in hours.
$sel:cutoff:CreateMaintenanceWindow', createMaintenanceWindow_cutoff - The number of hours before the end of the maintenance window that Amazon
Web Services Systems Manager stops scheduling new tasks for execution.
$sel:allowUnassociatedTargets:CreateMaintenanceWindow', createMaintenanceWindow_allowUnassociatedTargets - Enables a maintenance window task to run on managed instances, even if
you haven't 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.
Request Lenses
createMaintenanceWindow_clientToken :: Lens' CreateMaintenanceWindow (Maybe Text) Source #
User-provided idempotency token.
createMaintenanceWindow_scheduleOffset :: Lens' CreateMaintenanceWindow (Maybe Natural) Source #
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.
createMaintenanceWindow_endDate :: Lens' CreateMaintenanceWindow (Maybe Text) Source #
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.
createMaintenanceWindow_scheduleTimezone :: Lens' CreateMaintenanceWindow (Maybe Text) Source #
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.
createMaintenanceWindow_startDate :: Lens' CreateMaintenanceWindow (Maybe Text) Source #
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.
createMaintenanceWindow_description :: Lens' CreateMaintenanceWindow (Maybe Text) Source #
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
createMaintenanceWindow_tags :: Lens' CreateMaintenanceWindow (Maybe [Tag]) Source #
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.
createMaintenanceWindow_name :: Lens' CreateMaintenanceWindow Text Source #
The name of the maintenance window.
createMaintenanceWindow_schedule :: Lens' CreateMaintenanceWindow Text Source #
The schedule of the maintenance window in the form of a cron or rate expression.
createMaintenanceWindow_duration :: Lens' CreateMaintenanceWindow Natural Source #
The duration of the maintenance window in hours.
createMaintenanceWindow_cutoff :: Lens' CreateMaintenanceWindow Natural Source #
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
createMaintenanceWindow_allowUnassociatedTargets :: Lens' CreateMaintenanceWindow Bool Source #
Enables a maintenance window task to run on managed instances, even if you haven't 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.
Destructuring the Response
data CreateMaintenanceWindowResponse Source #
See: newCreateMaintenanceWindowResponse smart constructor.
Constructors
| CreateMaintenanceWindowResponse' | |
Fields
| |
Instances
newCreateMaintenanceWindowResponse Source #
Create a value of CreateMaintenanceWindowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:windowId:CreateMaintenanceWindowResponse', createMaintenanceWindowResponse_windowId - The ID of the created maintenance window.
$sel:httpStatus:CreateMaintenanceWindowResponse', createMaintenanceWindowResponse_httpStatus - The response's http status code.
Response Lenses
createMaintenanceWindowResponse_windowId :: Lens' CreateMaintenanceWindowResponse (Maybe Text) Source #
The ID of the created maintenance window.
createMaintenanceWindowResponse_httpStatus :: Lens' CreateMaintenanceWindowResponse Int Source #
The response's http status code.