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

Note:

When making an API call, you may pass UpdateMaintenanceWindowTaskRequest data as a hash:

{
  window_id: "MaintenanceWindowId", # required
  window_task_id: "MaintenanceWindowTaskId", # required
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  task_arn: "MaintenanceWindowTaskArn",
  service_role_arn: "ServiceRole",
  task_parameters: {
    "MaintenanceWindowTaskParameterName" => {
      values: ["MaintenanceWindowTaskParameterValue"],
    },
  },
  task_invocation_parameters: {
    run_command: {
      comment: "Comment",
      document_hash: "DocumentHash",
      document_hash_type: "Sha256", # accepts Sha256, Sha1
      notification_config: {
        notification_arn: "NotificationArn",
        notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
        notification_type: "Command", # accepts Command, Invocation
      },
      output_s3_bucket_name: "S3BucketName",
      output_s3_key_prefix: "S3KeyPrefix",
      parameters: {
        "ParameterName" => ["ParameterValue"],
      },
      service_role_arn: "ServiceRole",
      timeout_seconds: 1,
    },
    automation: {
      document_version: "DocumentVersion",
      parameters: {
        "AutomationParameterKey" => ["AutomationParameterValue"],
      },
    },
    step_functions: {
      input: "MaintenanceWindowStepFunctionsInput",
      name: "MaintenanceWindowStepFunctionsName",
    },
    lambda: {
      client_context: "MaintenanceWindowLambdaClientContext",
      qualifier: "MaintenanceWindowLambdaQualifier",
      payload: "data",
    },
  },
  priority: 1,
  max_concurrency: "MaxConcurrency",
  max_errors: "MaxErrors",
  logging_info: {
    s3_bucket_name: "S3BucketName", # required
    s3_key_prefix: "S3KeyPrefix",
    s3_region: "S3Region", # required
  },
  name: "MaintenanceWindowName",
  description: "MaintenanceWindowDescription",
  replace: false,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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 RegisterTaskWithMaintenanceWndow action are also required for this API request.

• #service_role_arn ⇒ String

  The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.

• #targets ⇒ Array<Types::Target>

  The targets (either instances 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

#description ⇒ String

The new task description to specify.

Returns:

• (String)

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

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

</note>

Returns:

• (Types::LoggingInfo)

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

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

Returns:

• (String)

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

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

Returns:

• (String)

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

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

#name ⇒ String

The new task name to specify.

Returns:

• (String)

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

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

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

#replace ⇒ Boolean

If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.

Returns:

• (Boolean)

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

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

#service_role_arn ⇒ String

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

For more information, see the following topics in the in the *AWS Systems Manager User Guide*:

• Service-Linked Role Permissions for Systems Manager][1

• [Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? ][2]

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions [2]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role

Returns:

• (String)

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

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

#targets ⇒ Array<Types::Target>

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

Returns:

• (Array<Types::Target>)

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

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

#task_arn ⇒ String

The task ARN to modify.

Returns:

• (String)

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

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

Returns:

• (Types::MaintenanceWindowTaskInvocationParameters)

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

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

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

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

#window_task_id ⇒ String

The task ID to modify.

Returns:

• (String)

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

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