class Amazonite::Ssm::GetMaintenanceWindowTaskResult

Included Modules

Defined in:

ssm/get_maintenance_window_task_result.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, targets : Array(Target) | Nil = nil, task_arn : String | Nil = nil, service_role_arn : String | Nil = nil, task_type : MaintenanceWindowTaskType | Nil = nil, task_parameters : Hash(String, MaintenanceWindowTaskParameterValueExpression) | Nil = nil, task_invocation_parameters : MaintenanceWindowTaskInvocationParameters | Nil = nil, priority : Int32 | Nil = nil, max_concurrency : String | Nil = nil, max_errors : String | Nil = nil, logging_info : LoggingInfo | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, cutoff_behavior : MaintenanceWindowTaskCutoffBehavior | Nil = nil, alarm_configuration : AlarmConfiguration | Nil = nil) #

[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 you applied to your maintenance window task.


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

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


[View source]
def cutoff_behavior : MaintenanceWindowTaskCutoffBehavior | Nil #

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.


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

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.


[View source]
def description : String | Nil #

The retrieved task description.


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

The retrieved task description.


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

See Object#hash(hasher)


def logging_info : LoggingInfo | Nil #

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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 allowed to run this task 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.


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

The maximum number of targets allowed to run this task 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.


[View source]
def max_errors : String | Nil #

The maximum number of errors allowed before the 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.


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

The maximum number of errors allowed before the 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.


[View source]
def name : String | Nil #

The retrieved task name.


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

The retrieved task name.


[View source]
def priority : Int32 | Nil #

The priority of the task when it runs. 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 when it runs. 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 where the task should run.


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

The targets where the task should run.


[View source]
def task_arn : String | Nil #

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.


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

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.


[View source]
def task_invocation_parameters : MaintenanceWindowTaskInvocationParameters | Nil #

The parameters to pass to the task when it runs.


[View source]
def task_invocation_parameters=(task_invocation_parameters : MaintenanceWindowTaskInvocationParameters | Nil) #

The parameters to pass to the task when it runs.


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

The parameters to pass to the task when it runs.

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 to pass to the task when it runs.

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_type : MaintenanceWindowTaskType | Nil #

The type of task to run.


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

The type of task to run.


[View source]
def validate! : Nil #

[View source]
def window_id : String | Nil #

The retrieved maintenance window ID.


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

The retrieved maintenance window ID.


[View source]
def window_task_id : String | Nil #

The retrieved maintenance window task ID.


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

The retrieved maintenance window task ID.


[View source]