AWS-ConfigureCloudWatchOnEC2Instance - Amazon Systems Manager Automation runbook reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS-ConfigureCloudWatchOnEC2Instance

Description

Enable or disable Amazon CloudWatch detailed monitoring on managed instances.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • AutomationAssumeRole

    Type: String

    Description: (Optional) The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.

  • InstanceId

    Type: String

    Description: (Required) The ID of the Amazon EC2 instance on which you want to enable CloudWatch monitoring.

  • properties

    Type: String

    Description: (Optional) This parameter is not supported. It is listed here for backwards compatibility.

  • status

    Valid values: Enabled | Disabled

    Description: (Optional) Specifies whether to enable or disable CloudWatch.

    Default: Enabled

Document Steps

configureCloudWatch - Configures CloudWatch on the Amazon EC2 instance with the given status.

Outputs

This automation has no output.