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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about a task defined for a Maintenance Window.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the task.

Returns:

  • (String)

    A description of the task.

#logging_infoTypes::LoggingInfo

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

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

  • (Types::LoggingInfo)

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

#max_concurrencyString

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

Returns:

  • (String)

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

#max_errorsString

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

Returns:

  • (String)

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

#nameString

The task name.

Returns:

  • (String)

    The task name.

#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)

    The priority of the task in the Maintenance Window.

#service_role_arnString

The role that should be assumed when executing the task

Returns:

  • (String)

    The role that should be assumed when executing the task.

#targetsArray<Types::Target>

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

Returns:

  • (Array<Types::Target>)

    The targets (either instances or tags).

#task_arnString

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it\'s the function name or ARN. For STEP_FUNCTION tasks, it\'s the state machine ARN.

Returns:

  • (String)

    The resource that the task uses during execution.

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

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

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.

Returns:

#typeString

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.

Possible values:

  • RUN_COMMAND
  • AUTOMATION
  • STEP_FUNCTIONS
  • LAMBDA

Returns:

  • (String)

    The type of task.

#window_idString

The Maintenance Window ID where the task is registered.

Returns:

  • (String)

    The Maintenance Window ID where the task is registered.

#window_task_idString

The task ID.

Returns:

  • (String)

    The task ID.