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

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

Overview

Constant Summary collapse

SENSITIVE =
[:task_parameters, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

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



15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#client_tokenString

User-provided idempotency token.

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

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#cutoff_behaviorString

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)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#descriptionString

An optional description for the task.

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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



15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_concurrencyString

The maximum number of targets this task can be run for, 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)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_errorsString

The maximum number of errors allowed before this 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)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#nameString

An optional name for the task.

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  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)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#service_role_arnString

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 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 [Using service-linked roles for Systems Manager] in the in the *Amazon Web Services Systems Manager User Guide*:

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either managed nodes or maintenance window targets).

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

Specify managed nodes 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>`

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

Returns:



15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_arnString

The ARN of the task to run.

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  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.



15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

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

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


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_typeString

The type of task being registered.

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_idString

The ID of the maintenance window the task should be added to.

Returns:

  • (String)


15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
# File 'lib/aws-sdk-ssm/types.rb', line 15569

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,
  :cutoff_behavior,
  :alarm_configuration)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end