class Amazonite::Ssm::UpdateMaintenanceWindowTaskResult

Included Modules

Defined in:

ssm/update_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_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 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 #

The updated task description.


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

The updated task description.


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

See Object#hash(hasher)


def logging_info : LoggingInfo | Nil #

The updated logging information in Amazon S3.

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 updated logging information in Amazon S3.

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 updated MaxConcurrency value.


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

The updated MaxConcurrency value.


[View source]
def max_errors : String | Nil #

The updated MaxErrors value.


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

The updated MaxErrors value.


[View source]
def name : String | Nil #

The updated task name.


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

The updated task name.


[View source]
def priority : Int32 | Nil #

The updated priority value.


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

The updated priority value.


[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 updated target values.


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

The updated target values.


[View source]
def task_arn : String | Nil #

The updated task ARN value.


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

The updated task ARN value.


[View source]
def task_invocation_parameters : MaintenanceWindowTaskInvocationParameters | Nil #

The updated parameter values.


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

The updated parameter values.


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

The updated parameter values.

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 updated parameter values.

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 validate! : Nil #

[View source]
def window_id : String | Nil #

The ID of the maintenance window that was updated.


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

The ID of the maintenance window that was updated.


[View source]
def window_task_id : String | Nil #

The task ID of the maintenance window that was updated.


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

The task ID of the maintenance window that was updated.


[View source]