MaintenanceWindowRunCommandParameters
The parameters for a RUN_COMMAND
task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
Note
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 AWS 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
.
Contents
- CloudWatchOutputConfig
-
Configuration options for sending command output to Amazon CloudWatch Logs.
Type: CloudWatchOutputConfig object
Required: No
- Comment
-
Information about the commands to run.
Type: String
Length Constraints: Maximum length of 100.
Required: No
- DocumentHash
-
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- DocumentHashType
-
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
Type: String
Valid Values:
Sha256 | Sha1
Required: No
- DocumentVersion
-
The AWS 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 AWS 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"
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)
Required: No
- NotificationConfig
-
Configurations for sending notifications about command status changes on a per-managed node basis.
Type: NotificationConfig object
Required: No
- OutputS3BucketName
-
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: No
- OutputS3KeyPrefix
-
The S3 bucket subfolder.
Type: String
Length Constraints: Maximum length of 500.
Required: No
- Parameters
-
The parameters for the
RUN_COMMAND
task execution.Type: String to array of strings map
Required: No
- ServiceRoleArn
-
The Amazon Resource Name (ARN) of the IAM service role for AWS 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 AWS Systems Manager User Guide.
Type: String
Required: No
- TimeoutSeconds
-
If this time is reached and the command hasn't already started running, it doesn't run.
Type: Integer
Valid Range: Minimum value of 30. Maximum value of 2592000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: