class Amazonite::Ssm::MaintenanceWindowRunCommandParameters

Overview

The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

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.

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.

For RUN_COMMAND tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

Included Modules

Defined in:

ssm/maintenance_window_run_command_parameters.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(comment : String | Nil = nil, cloud_watch_output_config : CloudWatchOutputConfig | Nil = nil, document_hash : String | Nil = nil, document_hash_type : DocumentHashType | Nil = nil, document_version : String | Nil = nil, notification_config : NotificationConfig | Nil = nil, output_s3_bucket_name : String | Nil = nil, output_s3_key_prefix : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, service_role_arn : String | Nil = nil, timeout_seconds : Int32 | 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 cloud_watch_output_config : CloudWatchOutputConfig | Nil #

[View source]
def cloud_watch_output_config=(cloud_watch_output_config : CloudWatchOutputConfig | Nil) #

[View source]
def comment : String | Nil #

Information about the commands to run.


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

Information about the commands to run.


[View source]
def document_hash : String | Nil #

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.


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

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.


[View source]
def document_hash_type : DocumentHashType | Nil #

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.


[View source]
def document_hash_type=(document_hash_type : DocumentHashType | Nil) #

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.


[View source]
def document_version : String | Nil #

The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"


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

The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"


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

See Object#hash(hasher)


def notification_config : NotificationConfig | Nil #

Configurations for sending notifications about command status changes on a per-managed node basis.


[View source]
def notification_config=(notification_config : NotificationConfig | Nil) #

Configurations for sending notifications about command status changes on a per-managed node basis.


[View source]
def output_s3_bucket_name : String | Nil #

The name of the Amazon Simple Storage Service (Amazon S3) bucket.


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

The name of the Amazon Simple Storage Service (Amazon S3) bucket.


[View source]
def output_s3_key_prefix : String | Nil #

The S3 bucket subfolder.


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

The S3 bucket subfolder.


[View source]
def parameters : Hash(String, Array(String)) | Nil #

The parameters for the RUN_COMMAND task execution.


[View source]
def parameters=(parameters : Hash(String, Array(String)) | Nil) #

The parameters for the RUN_COMMAND task execution.


[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 timeout_seconds : Int32 | Nil #

If this time is reached and the command hasn't already started running, it doesn't run.


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

If this time is reached and the command hasn't already started running, it doesn't run.


[View source]
def validate! : Nil #

[View source]