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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
  schedule_offset: 1,
  duration: 1, # required
  cutoff: 1, # required
  allow_unassociated_targets: false, # required
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targetsBoolean

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.

Returns:

  • (Boolean)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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

#cutoffInteger

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

Returns:

  • (Integer)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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

#durationInteger

The duration of the maintenance window in hours.

Returns:

  • (Integer)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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

#nameString

The name of the maintenance window.

Returns:

  • (String)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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

#scheduleString

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

Returns:

  • (String)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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

#schedule_offsetInteger

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.

Returns:

  • (Integer)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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”, “UTC”, or “Asia/Seoul”. For more information, see the [Time Zone Database] on the IANA website.

[1]: www.iana.org/time-zones

Returns:

  • (String)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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)

3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token,
  :tags)
  SENSITIVE = [:description]
  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-value pairs:

  • `Key=TaskType,Value=AgentUpdate`

  • `Key=OS,Value=Windows`

  • `Key=Environment,Value=Production`

<note markdown=“1”> To add tags to an existing maintenance window, use the AddTagsToResource operation.

</note>

Returns:


3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-ssm/types.rb', line 3936

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