Skip to content
Sebastian Rodriguez edited this page Sep 16, 2022 · 1 revision

Welcome to the awslimitchecker wiki!

What It Does

  • Checks current AWS resource usage against AWS ServiceQuota limits
  • Retrieves current usage
  • Compares current usage to limits
  • When available, retrieves applied (different than default) values
  • Supports explicitly setting the AWS region

Glossary

Service: an AWS service (such as S3, DynamoDB) Quota: your AWS account has default quotas, formerly referred to as limits, for each AWS service. These are generally region-specfic, but are at times account-wide. Every account has default values, but these can be increased up to an upper limit through AWS service quota console/service. Some quotas can be further increased through AWS Support. Usage: each supported quota has an associated usage, which is the amount of use for that specific quota. Quotas that are resource specific (for eg Managed node groups per cluster for EKS cluster will also have resource level usage tracking.

Requirements

To run the CLI, you will need:

  • golang 1.19 or newer

Installing

At the moment, only installation supporting is from sources (feel free to contribute other options!)

git clone https://github.com/sebasrp/awslimitchecker.git
cd awslimitchecker
go build ./... && go install ./...
awslimitchecker --help

Credentials

You will need valid AWS credentials to query the different quotas and usage. Right now we support the same credential types as the golang aws sdk (see Configuring the AWS SDK for Go V2

Required Permissions

The tool uses aws APIs to retrieve the quotas and usage values. This requires a certain number of IAM policies - which can be retrieved through the CLI command:

awslimitchecker iam

Regions

To specify the region that awslimitchecker connects to, use the -r / --region command line option. At this time awslimitchecker can only connect to one region at a time; to check limits in multiple regions, simply run the script multiple times, once per region.

Clone this wiki locally