AWS plugin

For more information about what this plugin does and the data streams it retrieves, see:


Monitor your AWS environment, including EC2, Lambda Functions, CloudWatch and more.

How to add the data source

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Before you start

Authentication types

SquaredUp supports IAM User and IAM Role based authentication when configuring the AWS data source. What You will need to set up the plugin will change depending on which authentication method you choose.

While IAM User authentication gives you all the permissions associated with that user, IAM Role authentication provides a much more granular approach and instead restricts you to the permissions associated with a configured role.

You will need:

  • One of the following:
    • The Access key ID and Secret access key of an IAM user with programmatic access (IAM User based).
    • The Role Arn (Amazon resource name) and External ID of an IAM role with programmatic access (IAM Role based). See AWS IAM Role configuration for SquaredUp for detailed instructions on creating IAM roles for use with this plugin.
  • The AWS Account ID and Target Regions for your AWS resources.

Roles / users with programmatic access

You will need to configure a new or existing role / user (depending on your authentication type) with a ReadOnlyAccess AWS managed policy. This policy provides the necessary rights for the integration to function. Alternatively, this policy can also be used as a starting point for a custom policy if, for example, sensitive services need to be removed.

Warning: While it is possible to use a custom policy, restricting access can severely impact the usability of the plugin such as preventing the use of scoped data streams. The ability to search for objects can also be impacted

A small number of data streams do require additional access rights such as the AmazonTimestreamReadOnlyAccess AWS managed policy (required for the Timestream Query data stream), which are documented in the corresponding data stream sections of this article.

See AWS credentials - Programmatic access ,Creating an IAM user in your AWS account and Creating a role to delegate permissions to an IAM user.

Configuring the data source

  1. Authentication Type:
    Select one of the following options depending on your chosen authentication method:
    • IAM User Based: You must enter the Access Key ID and Secret Access Key of the IAM user with programmatic access.
    • IAM Role Based: You must enter the Role Arn and External ID of the IAM roll.
      For detailed instructions on configuring IAM roles for this plugin, see AWS IAM Role configuration for SquaredUp.
  2. Input the Target Regions for your AWS resources, i.e. us-east-2, eu-west-1
  3. Enter the AWS Account ID
  4. Enter an Account name to help you remember which account and credentials you have used above. For example, you might type prod to remind you that you used the production account details.
  5. Install Sample Dashboards:
    Select whether you would like to install sample dashboards with the data source. By default, this is set to on.

  6. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

  7. Click Test and add to validate the data source configuration.

    You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

    The index time will depend on the size of your AWS environment.

Using the AWS data streams

Data streams

The following data streams are installed with this plugin.

See also:

Tips for using the AWS Data Streams

This data source comes with several data streams that you can use in the tiles on your dashboards. Here you'll find tips and ideas for using these data streams to display the data you're interested in.

Writing a custom data stream (advanced users)

  1. In SquaredUp, browse to Settings > Advanced > Data Streams.
  2. Click Add custom data stream.
  3. Add your custom data stream by entering the following settings:
    1. Name:
      Enter a display name for your data stream.

      The display name is the name that you use to identify your data stream in SquaredUp. It has no technical impact and doesn't need to be referenced in the data stream's code.

    2. Data source:
      Choose the data source this data stream is for.
      After you've chosen the data source the Entry Point field displays.
    3. Entry Point:
      Specify the data stream entry point and enter the Code below.
      To find out which entry point to select and get code examples for the Code field, see the help below.
  4. Click Save to save your data stream.

Was this article helpful?

Have more questions or facing an issue?