Class: Aws::SSM::Types::MaintenanceWindowTask
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::MaintenanceWindowTask
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Information about a task defined for a maintenance window.
Instance Attribute Summary collapse
-
#description ⇒ String
A description of the task.
-
#logging_info ⇒ Types::LoggingInfo
Information about an Amazon 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 ARN of the 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 instances 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
#description ⇒ String
A description of the task.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#logging_info ⇒ Types::LoggingInfo
Information about an Amazon S3 bucket to write task-level logs to.
<note markdown=“1”> ‘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.
</note>
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#max_concurrency ⇒ String
The maximum number of targets this task can be run for, in parallel.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#max_errors ⇒ String
The maximum number of errors allowed before this task stops being scheduled.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#name ⇒ String
The task name.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) 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.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#service_role_arn ⇒ String
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) 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 Systems Manager document name or ARN. For LAMBDA tasks, it’s the function name or ARN. For STEP_FUNCTIONS tasks, it’s the state machine ARN.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#task_parameters ⇒ Hash<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>
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#type ⇒ String
The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#window_id ⇒ String
The ID of the maintenance window where the task is registered.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |
#window_task_id ⇒ String
The task ID.
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 |
# File 'lib/aws-sdk-ssm/types.rb', line 11231 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) include Aws::Structure end |