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

Class: Aws::SSM::Types::UpdateMaintenanceWindowRequest

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

Overview

Note:

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

{
  window_id: "MaintenanceWindowId", # required
  name: "MaintenanceWindowName",
  description: "MaintenanceWindowDescription",
  start_date: "MaintenanceWindowStringDateTime",
  end_date: "MaintenanceWindowStringDateTime",
  schedule: "MaintenanceWindowSchedule",
  schedule_timezone: "MaintenanceWindowTimezone",
  schedule_offset: 1,
  duration: 1,
  cutoff: 1,
  allow_unassociated_targets: false,
  enabled: false,
  replace: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targets ⇒ Boolean

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Returns:

  • (Boolean) —

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

#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 update request.

Returns:

  • (String) —

    An optional description for the update request.

#duration ⇒ Integer

The duration of the maintenance window in hours.

Returns:

  • (Integer) —

    The duration of the maintenance window in hours.

#enabled ⇒ Boolean

Whether the maintenance window is enabled.

Returns:

  • (Boolean) —

    Whether the maintenance window is enabled.

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

#replace ⇒ Boolean

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.

Returns:

  • (Boolean) —

    If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request.

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

#window_id ⇒ String

The ID of the maintenance window to update.

Returns:

  • (String) —

    The ID of the maintenance window to update.