View a markdown version of this page

Install agents using Amazon CLI with SSM commands - Amazon CloudWatch
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 (PDF).

Install agents using Amazon CLI with SSM commands

You can use the Amazon Command Line Interface to send Amazon Systems Manager commands to install and activate Network Flow Monitor agents on your EC2 instances. This method is useful for scripted or automated deployments.

Step 1: Install the agent

Use the following Amazon CLI command to install the Network Flow Monitor agent on one or more EC2 instances using the AWS-ConfigureAWSPackage SSM document:

aws ssm send-command --document-name "AWS-ConfigureAWSPackage" \
  --parameters '{"action":["Install"],"installationType":["Uninstall and reinstall"],"name":["AmazonCloudWatchNetworkFlowMonitorAgent"],"version":[""],"additionalArguments":["{}"]}' \
  --targets "Key=instanceids,Values=i-1234567890abcdef0"

Replace i-1234567890abcdef0 with the instance ID (or IDs) where you want to install the agent. You can specify multiple instance IDs separated by commas.

Step 2: Activate the agent

After the installation completes, activate the agent so it begins sending performance metrics to the Network Flow Monitor backend. Activating the agent incurs billing costs. For more information about pricing, see the Amazon CloudWatch pricing page.

aws ssm send-command --document-name "AmazonCloudWatch-NetworkFlowMonitorManageAgent" \
  --parameters '{"Action":["Activate"]}' \
  --targets "Key=instanceids,Values=i-1234567890abcdef0"

After the agent is activated, it begins collecting and sending performance metrics. You should see data on the Workload insights page within approximately 20 minutes.