Class: Aws::SSM::Types::MaintenanceWindowTask
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::MaintenanceWindowTask
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Information about a task defined for a maintenance window.
Constant Summary collapse
- SENSITIVE =
[:task_parameters, :description]
Instance Attribute Summary collapse
-
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm applied to your maintenance window task.
-
#cutoff_behavior ⇒ String
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
#description ⇒ String
A description of the task.
-
#logging_info ⇒ Types::LoggingInfo
Information about an S3 bucket to write task-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
The task name.
-
#priority ⇒ Integer
The priority of the task in the maintenance window.
-
#service_role_arn ⇒ String
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
-
#targets ⇒ Array<Types::Target>
The targets (either managed nodes or tags).
-
#task_arn ⇒ String
The resource that the task uses during execution.
-
#task_parameters ⇒ Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>
The parameters that should be passed to the task when it is run.
-
#type ⇒ String
The type of task.
-
#window_id ⇒ String
The ID of the maintenance window where the task is registered.
-
#window_task_id ⇒ String
The task ID.
Instance Attribute Details
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm applied to your maintenance window task.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#cutoff_behavior ⇒ String
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#description ⇒ String
A description of the task.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#logging_info ⇒ Types::LoggingInfo
Information about an S3 bucket to write task-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.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :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.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :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.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#name ⇒ String
The task name.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :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 that have the same priority are scheduled in parallel.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#service_role_arn ⇒ String
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The targets (either managed nodes or tags). Managed nodes are
specified using
Key=instanceids,Values=<instanceid1>,<instanceid2>
. Tags are
specified using Key=<tag name>,Values=<tag value>
.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#task_arn ⇒ String
The resource that the task uses during execution. For RUN_COMMAND
and AUTOMATION
task types, TaskArn
is the Amazon Web Services
Systems Manager (SSM document) name or ARN. For LAMBDA
tasks,
it's the function name or ARN. For STEP_FUNCTIONS
tasks, it's
the state machine ARN.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :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.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#type ⇒ String
The type of task.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#window_id ⇒ String
The ID of the maintenance window where the task is registered.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#window_task_id ⇒ String
The task ID.
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12523 class MaintenanceWindowTask < Struct.new( :window_id, :window_task_id, :task_arn, :type, :targets, :task_parameters, :priority, :logging_info, :service_role_arn, :max_concurrency, :max_errors, :name, :description, :cutoff_behavior, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |