MaintenanceWindowRunCommandParameters
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
.
Types
Properties
Configuration options for sending command output to Amazon CloudWatch Logs.
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
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:
Configurations for sending notifications about command status changes on a per-managed node basis.
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
The S3 bucket subfolder.
The parameters for the RUN_COMMAND
task execution.
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
.
If this time is reached and the command hasn't already started running, it doesn't run.