AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters
The MaintenanceWindowRunCommandParameters
property type specifies the
parameters for a RUN_COMMAND
task type for a maintenance window task in Amazon Systems Manager. This means that these parameters are the same as those for the
SendCommand
API call. For more information about SendCommand
parameters, see SendCommand in the
Amazon Systems Manager API Reference.
For information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see Viewing SSM command document content in the Amazon Systems Manager User Guide.
MaintenanceWindowRunCommandParameters
is a property of the TaskInvocationParameters property type.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CloudWatchOutputConfig" :
CloudWatchOutputConfig
, "Comment" :String
, "DocumentHash" :String
, "DocumentHashType" :String
, "DocumentVersion" :String
, "NotificationConfig" :NotificationConfig
, "OutputS3BucketName" :String
, "OutputS3KeyPrefix" :String
, "Parameters" :Json
, "ServiceRoleArn" :String
, "TimeoutSeconds" :Integer
}
YAML
CloudWatchOutputConfig:
CloudWatchOutputConfig
Comment:String
DocumentHash:String
DocumentHashType:String
DocumentVersion:String
NotificationConfig:NotificationConfig
OutputS3BucketName:String
OutputS3KeyPrefix:String
Parameters:Json
ServiceRoleArn:String
TimeoutSeconds:Integer
Properties
CloudWatchOutputConfig
-
Configuration options for sending command output to Amazon CloudWatch Logs.
Required: No
Type: CloudWatchOutputConfig
Update requires: No interruption
Comment
-
Information about the command or commands to run.
Required: No
Type: String
Maximum:
100
Update requires: No interruption
DocumentHash
-
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
DocumentHashType
-
The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
Required: No
Type: String
Allowed values:
Sha1 | Sha256
Update requires: No interruption
DocumentVersion
-
The Amazon 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 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"
Required: No
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)
Update requires: No interruption
NotificationConfig
-
Configurations for sending notifications about command status changes on a per-managed node basis.
Required: No
Type: NotificationConfig
Update requires: No interruption
OutputS3BucketName
-
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
Required: No
Type: String
Minimum:
3
Maximum:
63
Update requires: No interruption
OutputS3KeyPrefix
-
The S3 bucket subfolder.
Required: No
Type: String
Maximum:
500
Update requires: No interruption
Parameters
-
The parameters for the
RUN_COMMAND
task execution.The supported parameters are the same as those for the
SendCommand
API call. For more information, see SendCommand in the Amazon Systems Manager API Reference.Required: No
Type: Json
Update requires: No interruption
ServiceRoleArn
-
The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
Required: No
Type: String
Update requires: No interruption
TimeoutSeconds
-
If this time is reached and the command hasn't already started running, it doesn't run.
Required: No
Type: Integer
Minimum:
30
Maximum:
2592000
Update requires: No interruption