Class: Aws::SSM::Types::RegisterTaskWithMaintenanceWindowRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::RegisterTaskWithMaintenanceWindowRequest
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:task_parameters, :description]
Instance Attribute Summary collapse
-
#alarm_configuration ⇒ Types::AlarmConfiguration
The CloudWatch alarm you want to apply to your maintenance window task.
-
#client_token ⇒ String
User-provided idempotency token.
-
#cutoff_behavior ⇒ String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
#description ⇒ String
An optional description for the task.
-
#logging_info ⇒ Types::LoggingInfo
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
-
#max_concurrency ⇒ String
The maximum number of targets this task can be run for, in parallel.
-
#max_errors ⇒ String
The maximum number of errors allowed before this task stops being scheduled.
-
#name ⇒ String
An optional name for the task.
-
#priority ⇒ Integer
The priority of the task in the maintenance window, the lower the number the higher the priority.
-
#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 maintenance window targets).
-
#task_arn ⇒ String
The ARN of the task to run.
-
#task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters
The parameters that the task should use during execution.
-
#task_parameters ⇒ Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>
The parameters that should be passed to the task when it is run.
-
#task_type ⇒ String
The type of task being registered.
-
#window_id ⇒ String
The ID of the maintenance window the task should be added to.
Instance Attribute Details
#alarm_configuration ⇒ Types::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 'gems/aws-sdk-ssm/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_token ⇒ String
User-provided idempotency token.
A suitable default value is auto-generated. You should normally not need to pass this option.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_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
.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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 |
#description ⇒ String
An optional description for the task.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_info ⇒ Types::LoggingInfo
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_concurrency ⇒ String
The maximum number of targets this task can be run for, in parallel.
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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_errors ⇒ String
The maximum number of errors allowed before this task stops being scheduled.
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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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 |
#name ⇒ String
An optional name for the task.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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 |
#priority ⇒ Integer
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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_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 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:
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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 |
#targets ⇒ Array<Types::Target>
The targets (either managed nodes or maintenance window targets).
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>
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_arn ⇒ String
The ARN of the task to run.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_parameters ⇒ Hash<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.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_type ⇒ String
The type of task being registered.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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_id ⇒ String
The ID of the maintenance window the task should be added to.
15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 |
# File 'gems/aws-sdk-ssm/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 |