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

Class: Aws::SSM::Types::RegisterTaskWithMaintenanceWindowRequest

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

Overview

Note:

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

{
  window_id: "MaintenanceWindowId", # required
  targets: [ # required
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  task_arn: "MaintenanceWindowTaskArn", # required
  service_role_arn: "ServiceRole",
  task_type: "RUN_COMMAND", # required, accepts RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA
  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", # required
  max_errors: "MaxErrors", # required
  logging_info: {
    s3_bucket_name: "S3BucketName", # required
    s3_key_prefix: "S3KeyPrefix",
    s3_region: "S3Region", # required
  },
  name: "MaintenanceWindowName",
  description: "MaintenanceWindowDescription",
  client_token: "ClientToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

User-provided idempotency token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#descriptionString

An optional description for the task.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

A structure containing information about an Amazon S3 bucket to write instance-level logs to.

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.

Returns:



11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#nameString

An optional name for the task.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#priorityInteger

The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Returns:

  • (Integer)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#service_role_arnString

The role to assume when running the Maintenance Window task.

If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.

For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either instances or Maintenance Window targets).

Specify instances using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify Maintenance Window targets using the following format:

Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>

Returns:



11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#task_arnString

The ARN of the task to run.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

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



11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

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

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.



11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#task_typeString

The type of task being registered.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end

#window_idString

The ID of the Maintenance Window the task should be added to.

Returns:

  • (String)


11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11634

class RegisterTaskWithMaintenanceWindowRequest < Struct.new(
  :window_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :client_token)
  include Aws::Structure
end