class Amazonite::Ssm::MaintenanceWindowTask

Overview

Information about a task defined for a maintenance window.

Included Modules

Defined in:

ssm/maintenance_window_task.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(window_id : String | Nil = nil, window_task_id : String | Nil = nil, task_arn : String | Nil = nil, type : MaintenanceWindowTaskType | Nil = nil, targets : Array(Target) | Nil = nil, task_parameters : Hash(String, MaintenanceWindowTaskParameterValueExpression) | Nil = nil, priority : Int32 | Nil = nil, logging_info : LoggingInfo | Nil = nil, service_role_arn : String | Nil = nil, max_concurrency : String | Nil = nil, max_errors : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, cutoff_behavior : MaintenanceWindowTaskCutoffBehavior | Nil = nil, alarm_configuration : AlarmConfiguration | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def alarm_configuration : AlarmConfiguration | Nil #

The details for the CloudWatch alarm applied to your maintenance window task.


[View source]
def alarm_configuration=(alarm_configuration : AlarmConfiguration | Nil) #

The details for the CloudWatch alarm applied to your maintenance window task.


[View source]
def cutoff_behavior : MaintenanceWindowTaskCutoffBehavior | Nil #

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.


[View source]
def cutoff_behavior=(cutoff_behavior : MaintenanceWindowTaskCutoffBehavior | Nil) #

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.


[View source]
def description : String | Nil #

A description of the task.


[View source]
def description=(description : String | Nil) #

A description of the task.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def logging_info : LoggingInfo | Nil #

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.


[View source]
def logging_info=(logging_info : LoggingInfo | Nil) #

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.


[View source]
def max_concurrency : String | Nil #

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

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.


[View source]
def max_concurrency=(max_concurrency : String | Nil) #

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

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.


[View source]
def max_errors : String | Nil #

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

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.


[View source]
def max_errors=(max_errors : String | Nil) #

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

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.


[View source]
def name : String | Nil #

The task name.


[View source]
def name=(name : String | Nil) #

The task name.


[View source]
def priority : Int32 | Nil #

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.


[View source]
def priority=(priority : Int32 | Nil) #

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.


[View source]
def service_role_arn : String | Nil #

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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.


[View source]
def service_role_arn=(service_role_arn : String | Nil) #

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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.


[View source]
def targets : Array(Target) | Nil #

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values=,. Tags are specified using Key=,Values=.


[View source]
def targets=(targets : Array(Target) | Nil) #

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values=,. Tags are specified using Key=,Values=.


[View source]
def task_arn : String | Nil #

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.

Maintenance Window does not validate the TaskArn when you register a task. A successful registration does not guarantee that the TaskArn is valid.


[View source]
def task_arn=(task_arn : String | Nil) #

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.

Maintenance Window does not validate the TaskArn when you register a task. A successful registration does not guarantee that the TaskArn is valid.


[View source]
def task_parameters : Hash(String, MaintenanceWindowTaskParameterValueExpression) | Nil #

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.


[View source]
def task_parameters=(task_parameters : Hash(String, MaintenanceWindowTaskParameterValueExpression) | Nil) #

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.


[View source]
def type : MaintenanceWindowTaskType | Nil #

The type of task.


[View source]
def type=(type : MaintenanceWindowTaskType | Nil) #

The type of task.


[View source]
def validate! : Nil #

[View source]
def window_id : String | Nil #

The ID of the maintenance window where the task is registered.


[View source]
def window_id=(window_id : String | Nil) #

The ID of the maintenance window where the task is registered.


[View source]
def window_task_id : String | Nil #

The task ID.


[View source]
def window_task_id=(window_task_id : String | Nil) #

The task ID.


[View source]