Add support for CloudWatch output config in SSM RunCommand task (#420)

Author: hieuxlu

.changes/next-release/Feature-2e4545c5-a2ab-4416-a8bc-9327daeccdcc.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Add support for CloudWatch output config in SSM RunCommand task"
+}

src/tasks/SystemsManagerRunCommand/TaskOperations.ts

@@ -38,6 +38,15 @@ export class TaskOperations {
         if (this.taskParameters.documentParameters) {
             request.Parameters = JSON.parse(this.taskParameters.documentParameters)
         }
+        if (this.taskParameters.cloudWatchOutputEnabled) {
+            request.CloudWatchOutputConfig = {
+                CloudWatchOutputEnabled: true
+            }
+
+            if (this.taskParameters.cloudWatchLogGroupName) {
+                request.CloudWatchOutputConfig.CloudWatchLogGroupName = this.taskParameters.cloudWatchLogGroupName
+            }
+        }
 
         switch (this.taskParameters.instanceSelector) {
             case fromInstanceIds:

src/tasks/SystemsManagerRunCommand/TaskParameters.ts

@@ -29,6 +29,8 @@ export interface TaskParameters {
     notificationType: string | undefined
     outputS3BucketName: string
     outputS3KeyPrefix: string
+    cloudWatchOutputEnabled: boolean;
+    cloudWatchLogGroupName: string;
     commandIdOutputVariable: string
 }
 
@@ -48,6 +50,8 @@ export function buildTaskParameters(): TaskParameters {
         notificationType: getInputOptional('notificationType'),
         outputS3BucketName: getInputOrEmpty('outputS3BucketName'),
         outputS3KeyPrefix: getInputOrEmpty('outputS3KeyPrefix'),
+        cloudWatchOutputEnabled: tl.getBoolInput('cloudWatchOutputEnabled'),
+        cloudWatchLogGroupName: getInputOrEmpty('cloudWatchLogGroupName'),
         commandIdOutputVariable: getInputOrEmpty('commandIdOutputVariable'),
         instanceIds: [],
         instanceTags: [],

src/tasks/SystemsManagerRunCommand/task.json

@@ -26,6 +26,11 @@
             "displayName": "S3 Output",
             "isExpanded": false
         },
+        {
+            "name": "cloudWatchOutput",
+            "displayName": "CloudWatch Options",
+            "isExpanded": false
+        },
         {
             "name": "diagnostic",
             "displayName": "Diagnostic",
@@ -227,6 +232,25 @@
             "helpMarkDown": "The name of a variable that will contain the unique ID assigned to the command. The command ID can be used future references to the request.",
             "required": false
         },
+        {
+            "name": "cloudWatchOutputEnabled",
+            "label": "Enable CloudWatch Logs",
+            "type": "boolean",
+            "required": false,
+            "defaultValue": false,
+            "groupName": "cloudWatchOutput",
+            "helpMarkDown": "Enables Systems Manager to send command output to CloudWatch Logs."
+        },
+        {
+            "name": "cloudWatchLogGroupName",
+            "label": "CloudWatch Log Group Name",
+            "type": "string",
+            "required": false,
+            "defaultValue": "",
+            "groupName": "cloudWatchOutput",
+            "visibleRule": "cloudWatchOutputEnabled = true",
+            "helpMarkDown": "The name of the CloudWatch log group where you want to send command output. If you don’t specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: <em>aws/ssm/<systems_manager_document_name></em>."
+        },
         {
             "name": "logRequest",
             "type": "boolean",

tests/taskTests/systemsManagerRunCommand/systemsManagerRunCommand-test.ts

@@ -34,6 +34,8 @@ const defaultTaskParameters: TaskParameters = {
     notificationType: '',
     outputS3BucketName: '',
     outputS3KeyPrefix: '',
+    cloudWatchOutputEnabled: false,
+    cloudWatchLogGroupName: '',
     commandIdOutputVariable: ''
 }
 
@@ -132,6 +134,40 @@ describe('Systems Manager Run Command', () => {
         expect(ssm.sendCommand).toBeCalledTimes(1)
     })
 
+    test('Adds Cloudwatch output config if it exists', async () => {
+        expect.assertions(2)
+        const ssm = new SSM() as any
+        ssm.sendCommand = jest.fn(args => {
+            expect(args.CloudWatchOutputConfig.CloudWatchLogGroupName).toBe('cloudWatchLogGroupName')
+
+            return systemsManagerFails
+        })
+        const taskParameters: TaskParameters = { ...defaultTaskParameters, cloudWatchOutputEnabled: true }
+        taskParameters.cloudWatchLogGroupName = 'cloudWatchLogGroupName'
+        const taskOperations = new TaskOperations(ssm, taskParameters)
+        try {
+            await taskOperations.execute()
+        } catch (e) {}
+        expect(ssm.sendCommand).toBeCalledTimes(1)
+    })
+
+    test('Do not add Cloudwatch output config if CloudWatch output is disabled', async () => {
+        expect.assertions(2)
+        const ssm = new SSM() as any
+        ssm.sendCommand = jest.fn(args => {
+            expect(args.CloudWatchOutputConfig).toBeFalsy()
+
+            return systemsManagerFails
+        })
+        const taskParameters: TaskParameters = { ...defaultTaskParameters }
+        taskParameters.cloudWatchLogGroupName = 'cloudWatchLogGroupName'
+        const taskOperations = new TaskOperations(ssm, taskParameters)
+        try {
+            await taskOperations.execute()
+        } catch (e) {}
+        expect(ssm.sendCommand).toBeCalledTimes(1)
+    })
+
     test('Happy path', async () => {
         expect.assertions(1)
         const ssm = new SSM() as any