AWS Documentation » AWS CloudFormation » User Guide » AWS Systems Manager Resource Type Reference » AWS::SSM::MaintenanceWindowTask » AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters

Filter View: All JSON YAML

AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters

The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a Maintenance Window task in AWS Systems Manager.

MaintenanceWindowRunCommandParameters is a property of the TaskInvocationParameters property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Comment" : String,
  "DocumentHash" : String,
  "DocumentHashType" : String,
  "NotificationConfig" : NotificationConfig,
  "OutputS3BucketName" : String,
  "OutputS3KeyPrefix" : String,
  "Parameters" : Json,
  "ServiceRoleArn" : String,
  "TimeoutSeconds" : Integer
}

YAML

  Comment : String
  DocumentHash : String
  DocumentHashType : String
  NotificationConfig : NotificationConfig
  OutputS3BucketName : String
  OutputS3KeyPrefix : String
  Parameters : Json
  ServiceRoleArn : String
  TimeoutSeconds : Integer

Properties

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

NotificationConfig

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

Required: No

Type: NotificationConfig

Update requires: No interruption

OutputS3BucketName

The name of the Amazon S3 bucket.

Required: No

Type: String

Minimum: 3

Maximum: 63

Update requires: No interruption

OutputS3KeyPrefix

The Amazon S3 bucket subfolder.

Required: No

Type: String

Maximum: 500

Update requires: No interruption

Parameters

The parameters for the RUN_COMMAND task execution.

Required: No

Type: Json

Update requires: No interruption

ServiceRoleArn

The IAM service role to assume during task execution.

Required: No

Type: String

Update requires: No interruption

TimeoutSeconds

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

Required: No

Type: Integer

Minimum: 30

Maximum: 2592000

Update requires: No interruption