You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::CreateMaintenanceWindowRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateMaintenanceWindowRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "MaintenanceWindowName", # required
  description: "MaintenanceWindowDescription",
  start_date: "MaintenanceWindowStringDateTime",
  end_date: "MaintenanceWindowStringDateTime",
  schedule: "MaintenanceWindowSchedule", # required
  schedule_timezone: "MaintenanceWindowTimezone",
  schedule_offset: 1,
  duration: 1, # required
  cutoff: 1, # required
  allow_unassociated_targets: false, # required
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targets ⇒ Boolean

Enables a maintenance window task to run 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.

Returns:

  • (Boolean) —

    Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

#client_token ⇒ String

User-provided idempotency token.

Returns:

  • (String) —

    User-provided idempotency token.

#cutoff ⇒ Integer

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

Returns:

  • (Integer) —

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

#description ⇒ String

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Returns:

  • (String) —

    An optional description for the maintenance window.

#duration ⇒ Integer

The duration of the maintenance window in hours.

Returns:

  • (Integer) —

    The duration of the maintenance window in hours.

#end_date ⇒ String

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.

Returns:

  • (String) —

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.

#name ⇒ String

The name of the maintenance window.

Returns:

  • (String) —

    The name of the maintenance window.

#schedule ⇒ String

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

Returns:

  • (String) —

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

#schedule_offset ⇒ Integer

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(0 30 23 ? * TUE#3 *)

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

Returns:

  • (Integer) —

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

#schedule_timezone ⇒ String

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.

Returns:

  • (String) —

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

#start_date ⇒ String

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.

Returns:

  • (String) —

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.

#tags ⇒ Array<Types::Tag>

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.

Returns:

  • (Array<Types::Tag>) —

    Optional metadata that you assign to a resource.