Class: Aws::SSM::Types::MaintenanceWindowIdentity

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::MaintenanceWindowIdentity

Defined in:

gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Information about the maintenance window.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #cutoff ⇒ Integer

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

• #description ⇒ String

  A description of the maintenance window.

• #duration ⇒ Integer

  The duration of the maintenance window in hours.

• #enabled ⇒ Boolean

  Indicates whether the maintenance window is enabled.

• #end_date ⇒ String

  The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

• #name ⇒ String

  The name of the maintenance window.

• #next_execution_time ⇒ String

  The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

• #schedule ⇒ String

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

• #schedule_offset ⇒ Integer

  The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

• #schedule_timezone ⇒ String

  The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

• #start_date ⇒ String

  The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

• #window_id ⇒ String

  The ID of the maintenance window.

Instance Attribute Details

#cutoff ⇒ Integer

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)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

A description of the maintenance window.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#duration ⇒ Integer

The duration of the maintenance window in hours.

Returns:

• (Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#enabled ⇒ Boolean

Indicates whether the maintenance window is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#end_date ⇒ String

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The name of the maintenance window.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#next_execution_time ⇒ String

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#schedule ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#schedule_offset ⇒ Integer

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

Returns:

• (Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#schedule_timezone ⇒ String

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#start_date ⇒ String

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end

#window_id ⇒ String

The ID of the maintenance window.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12414

class MaintenanceWindowIdentity < Struct.new(
  :window_id,
  :name,
  :description,
  :enabled,
  :duration,
  :cutoff,
  :schedule,
  :schedule_timezone,
  :schedule_offset,
  :end_date,
  :start_date,
  :next_execution_time)
  SENSITIVE = [:description]
  include Aws::Structure
end