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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateMaintenanceWindowTaskRequest as input to an Aws::Client method, you can use a vanilla 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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The new task description to specify.

Returns:

  • (String)

    The new task description to specify.

#logging_infoTypes::LoggingInfo

The new logging location in Amazon S3 to specify.

Returns:

#max_concurrencyString

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)

    The new MaxConcurrency value you want to specify.

#max_errorsString

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

Returns:

  • (String)

    The new MaxErrors value to specify.

#nameString

The new task name to specify.

Returns:

  • (String)

    The new task name to specify.

#priorityInteger

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)

    The new task priority to specify.

#replaceBoolean

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)

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

#service_role_arnString

The IAM service role ARN to modify. The system assumes this role during task execution.

Returns:

  • (String)

    The IAM service role ARN to modify.

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

    The targets (either instances or tags) to modify.

#task_arnString

The task ARN to modify.

Returns:

  • (String)

    The task ARN to modify.

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

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters to modify. 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:

#window_idString

The Maintenance Window ID that contains the task to modify.

Returns:

  • (String)

    The Maintenance Window ID that contains the task to modify.

#window_task_idString

The task ID to modify.

Returns:

  • (String)

    The task ID to modify.