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

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

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 UpdateMaintenanceWindowRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targetsBoolean

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

Returns:

  • (Boolean)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  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)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#descriptionString

An optional description for the update request.

Returns:

  • (String)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#durationInteger

The duration of the maintenance window in hours.

Returns:

  • (Integer)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#enabledBoolean

Whether the maintenance window is enabled.

Returns:

  • (Boolean)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  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)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#nameString

The name of the maintenance window.

Returns:

  • (String)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#replaceBoolean

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)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#scheduleString

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

Returns:

  • (String)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  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)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#start_dateString

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)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end

#window_idString

The ID of the maintenance window to update.

Returns:

  • (String)


15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15540

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :start_date,
  :end_date,
  :schedule,
  :schedule_timezone,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :enabled,
  :replace)
  include Aws::Structure
end