Class: Aws::SSM::Types::UpdateMaintenanceWindowTaskRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::UpdateMaintenanceWindowTaskRequest

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 CloudWatch alarm you want to apply to your maintenance window task.

• #cutoff_behavior ⇒ String

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

• #description ⇒ String

  The new task description to specify.

• #logging_info ⇒ Types::LoggingInfo

  The new logging location in Amazon S3 to specify.

• #max_concurrency ⇒ String

  The new ‘MaxConcurrency` value you want to specify.

• #max_errors ⇒ String

  The new ‘MaxErrors` value to specify.

• #name ⇒ String

  The new task name to specify.

• #priority ⇒ Integer

  The new task priority to specify.

• #replace ⇒ Boolean

  If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request.

• #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 (either managed nodes or tags) to modify.

• #task_arn ⇒ String

  The task ARN to modify.

• #task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

  The parameters that the task should use during execution.

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

  The parameters to modify.

• #window_id ⇒ String

  The maintenance window ID that contains the task to modify.

• #window_task_id ⇒ String

  The task ID to modify.

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

The CloudWatch alarm you want to apply to your maintenance window task.

Returns:

• (Types::AlarmConfiguration)

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

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

#cutoff_behavior ⇒ String

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

• ‘CONTINUE_TASK`: When the cutoff time is reached, any tasks that are running continue. The default value.

• ‘CANCEL_TASK`:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is ‘TIMED_OUT`.

Returns:

• (String)

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

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

#description ⇒ String

The new task description to specify.

Returns:

• (String)

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

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

#logging_info ⇒ Types::LoggingInfo

The new logging location in Amazon S3 to specify.

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

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

#max_concurrency ⇒ String

The new ‘MaxConcurrency` value you want to specify. `MaxConcurrency` is the number of targets that are allowed to run this task, 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)

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

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

#max_errors ⇒ String

The new ‘MaxErrors` value to specify. `MaxErrors` is the maximum number of errors that are allowed before the 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)

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

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

#name ⇒ String

The new task name to specify.

Returns:

• (String)

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

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

#priority ⇒ Integer

The new task priority to specify. 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 19368

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

#replace ⇒ Boolean

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren’t specified are set to null.

Returns:

• (Boolean)

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

class UpdateMaintenanceWindowTaskRequest < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :replace,
  :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 19368

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

#targets ⇒ Array<Types::Target>

The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format ‘Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified using the format ` Key=tag_name,Values=tag_value`.

<note markdown=“1”> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see [Registering maintenance window tasks without targets] in the *Amazon Web Services Systems Manager User Guide*.

</note>

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

Returns:

• (Array<Types::Target>)

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

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

#task_arn ⇒ String

The task ARN to modify.

Returns:

• (String)

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

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

#task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in ‘TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you don’t specify again are removed. For example, suppose that when you registered a Run Command task, you specified ‘TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.

Returns:

• (Types::MaintenanceWindowTaskInvocationParameters)

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

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

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

The parameters to modify.

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

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Returns:

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

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

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

#window_id ⇒ String

The maintenance window ID that contains the task to modify.

Returns:

• (String)

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

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

#window_task_id ⇒ String

The task ID to modify.

Returns:

• (String)

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

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