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

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

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

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)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

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

Returns:



6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#nameString

The task name.

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#service_role_arnString

The role that should be assumed when executing the task

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

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



6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#task_arnString

TaskArn is the resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the SSM Document Name/ARN. For LAMBDA tasks, it's the Function Name/ARN. For STEP_FUNCTION tasks, it's the State Machine ARN.

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

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



6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#window_idString

The Maintenance Window ID where the task is registered.

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end

#window_task_idString

The task ID.

Returns:

  • (String)


6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6960

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)
  include Aws::Structure
end