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",
  schedule: "MaintenanceWindowSchedule",
  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)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :schedule,
  :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)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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

#descriptionString

An optional description for the update request.

Returns:

  • (String)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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

#durationInteger

The duration of the Maintenance Window in hours.

Returns:

  • (Integer)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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

#enabledBoolean

Whether the Maintenance Window is enabled.

Returns:

  • (Boolean)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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

#nameString

The name of the Maintenance Window.

Returns:

  • (String)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :schedule,
  :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)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

class UpdateMaintenanceWindowRequest < Struct.new(
  :window_id,
  :name,
  :description,
  :schedule,
  :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)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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

#window_idString

The ID of the Maintenance Window to update.

Returns:

  • (String)


9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9508

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