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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateMaintenanceWindowRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targetsBoolean

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)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#client_tokenString

User-provided idempotency token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#cutoffInteger

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

Returns:

  • (Integer)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#durationInteger

The duration of the maintenance window in hours.

Returns:

  • (Integer)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#end_dateString

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)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#nameString

The name of the maintenance window.

Returns:

  • (String)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#scheduleString

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

Returns:

  • (String)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#schedule_timezoneString

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)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#start_dateString

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)


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end

#tagsArray<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:



2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2808

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  include Aws::Structure
end