Class: Aws::SSM::Types::GetMaintenanceWindowTaskResult

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetMaintenanceWindowTaskResult

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:task_parameters, :description]

Instance Attribute Summary

• #alarm_configuration ⇒ Types::AlarmConfiguration

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

• #cutoff_behavior ⇒ String

  The action to take on tasks when the maintenance window cutoff time is reached.

• #description ⇒ String

  The retrieved task description.

• #logging_info ⇒ Types::LoggingInfo

  The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

• #max_concurrency ⇒ String

  The maximum number of targets allowed to run this task in parallel.

• #max_errors ⇒ String

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

• #name ⇒ String

  The retrieved task name.

• #priority ⇒ Integer

  The priority of the task when it runs.

• #service_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.

• #targets ⇒ Array<Types::Target>

  The targets where the task should run.

• #task_arn ⇒ String

  The resource that the task used during execution.

• #task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

  The parameters to pass to the task when it runs.

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

  The parameters to pass to the task when it runs.

• #task_type ⇒ String

  The type of task to run.

• #window_id ⇒ String

  The retrieved maintenance window ID.

• #window_task_id ⇒ String

  The retrieved maintenance window task ID.

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

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

Returns:

• (Types::AlarmConfiguration)

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

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

#cutoff_behavior ⇒ String

The action to take on tasks when the maintenance window cutoff time is reached. ‘CONTINUE_TASK` means that tasks continue to run. For Automation, Lambda, Step Functions tasks, `CANCEL_TASK` means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, `CANCEL_TASK` means the system attempts to stop the task by sending a `CancelCommand` operation.

Returns:

• (String)

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

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

#description ⇒ String

The retrieved task description.

Returns:

• (String)

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

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

#logging_info ⇒ Types::LoggingInfo

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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

• (Types::LoggingInfo)

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

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

#max_concurrency ⇒ String

The maximum number of targets allowed to run this task in parallel.

<note markdown=“1”> 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`, which may be reported in the response to this command. This value doesn’t affect the running of your task and can be ignored.

</note>

Returns:

• (String)

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

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

#max_errors ⇒ String

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

<note markdown=“1”> 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`, which may be reported in the response to this command. This value doesn’t affect the running of your task and can be ignored.

</note>

Returns:

• (String)

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

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

#name ⇒ String

The retrieved task name.

Returns:

• (String)

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

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

#priority ⇒ Integer

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

• (Integer)

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

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

#service_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run ‘RegisterTaskWithMaintenanceWindow`.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows] in the in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html

Returns:

• (String)

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

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

#targets ⇒ Array<Types::Target>

The targets where the task should run.

Returns:

• (Array<Types::Target>)

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

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

#task_arn ⇒ String

The resource that the task used during execution. For ‘RUN_COMMAND` and `AUTOMATION` task types, the value of `TaskArn` is the SSM document name/ARN. For `LAMBDA` tasks, the value is the function name/ARN. For `STEP_FUNCTIONS` tasks, the value is the state machine ARN.

Returns:

• (String)

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

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

#task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it runs.

Returns:

• (Types::MaintenanceWindowTaskInvocationParameters)

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

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

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

The parameters to pass to the task when it runs.

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

Returns:

• (Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>)

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

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

#task_type ⇒ String

The type of task to run.

Returns:

• (String)

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

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

#window_id ⇒ String

The retrieved maintenance window ID.

Returns:

• (String)

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

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

#window_task_id ⇒ String

The retrieved maintenance window task ID.

Returns:

• (String)

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

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