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",
  schedule: "MaintenanceWindowSchedule", # required
  duration: 1, # required
  cutoff: 1, # required
  allow_unassociated_targets: false, # required
  client_token: "ClientToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unassociated_targetsBoolean

Enables a Maintenance Window task to execute 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)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :schedule,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token)
  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)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :schedule,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token)
  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)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

class CreateMaintenanceWindowRequest < Struct.new(
  :name,
  :description,
  :schedule,
  :duration,
  :cutoff,
  :allow_unassociated_targets,
  :client_token)
  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)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

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

#durationInteger

The duration of the Maintenance Window in hours.

Returns:

  • (Integer)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

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

#nameString

The name of the Maintenance Window.

Returns:

  • (String)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

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

#scheduleString

The schedule of the Maintenance Window in the form of a cron or rate expression.

Returns:

  • (String)


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1735

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