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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the task.

Returns:

  • (String) —

    A description of the task.

#logging_info ⇒ Types::LoggingInfo

Information about an 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:

#max_concurrency ⇒ String

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_errors ⇒ String

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.

#name ⇒ String

The task name.

Returns:

  • (String) —

    The task name.

#priority ⇒ Integer

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_arn ⇒ String

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

Returns:

  • (String) —

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

#targets ⇒ Array<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_arn ⇒ String

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_FUNCTIONS tasks, it\'s the state machine ARN.

Returns:

  • (String) —

    The resource that the task uses during execution.

#task_parameters ⇒ Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>

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

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:

#type ⇒ String

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

Possible values:

  • RUN_COMMAND
  • AUTOMATION
  • STEP_FUNCTIONS
  • LAMBDA

Returns:

  • (String) —

    The type of task.

#window_id ⇒ String

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

Returns:

  • (String) —

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

#window_task_id ⇒ String

The task ID.

Returns:

  • (String) —

    The task ID.