Class: Aws::SSM::Types::MaintenanceWindowTask

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Information about a task defined for a maintenance window.

Constant Summary collapse

SENSITIVE =
[:task_parameters, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

The details for the CloudWatch alarm applied to your maintenance window task.


14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#cutoff_behaviorString

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#descriptionString

A description of the task.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

Information about an S3 bucket to write task-level logs to.

<note markdown=“1”> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

</note>

Returns:


14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_concurrencyString

The maximum number of targets this task can be run for, in parallel.

<note markdown=“1”> Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a [targetless task] You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't

supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_errorsString

The maximum number of errors allowed before this task stops being scheduled.

<note markdown=“1”> Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a [targetless task] You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't

supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#nameString

The task name.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#priorityInteger

The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

  • (Integer)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#service_role_arnString

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either managed nodes or tags). Managed nodes are specified using `Key=instanceids,Values=<instanceid1>,<instanceid2>`. Tags are specified using `Key=<tag name>,Values=<tag value>`.

Returns:


14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_arnString

The resource that the task uses during execution. For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the Amazon Web Services Systems Manager (SSM document) name or ARN. For `LAMBDA` tasks, it's the function name or ARN. For `STEP_FUNCTIONS` tasks, it's the state machine ARN.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters that should be passed to the task when it is run.

<note markdown=“1”> `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

</note>

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#typeString

The type of task.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_idString

The ID of the maintenance window where the task is registered.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_task_idString

The task ID.

Returns:

  • (String)

14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
# File 'lib/aws-sdk-ssm/types.rb', line 14118

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end