abc

abc

abc is helper library to use aws api via CLI.

Overview

abc is a helper library including several sub commands.
It wraps, pipes and extends AWS API.

Table of Contents

• Install
• Credentials and Permissions
• Usage
  • abc ami
  • abc cfn unused-exports
  • abc cfn purge-stack
  • abc lambda stats
• License
• Contributing

Install

You can install binaries from releases,
or pull repository and build the binaries yourself.

If you build yourself:
Prerequisition

• Git
• Go

mkdir $HOME/src
cd $HOME/src
git clone https://github.com/Blue-Pix/abc.git
cd abc
go install

Credentials and Permissions

You have to set aws credentials in advance.
Which policy to use depends on sub command type.

For example, abc ami command querying latest Amazon Linux AMI, requires following policy.

• ssm:GetParametersByPath

Without option, we use your default aws credentials.
You can also pass --region and --profile option like aws cli.

Usage

To list all sub commands, type abc help.

abc ami

List latest Amazon Linux AMI.
You can also query it by version, virtualization type, cpu architecture, storage type and if minimal or not.

If you looking for the AMI composed of Amazon Linux 2, hvm, x86_64, gp2:

$ abc ami -v 2 -V hvm -a x86_64 -s gp2 | jq '.'
[
  {
    "os": "amzn",
    "version": "2",
    "virtualization_type": "hvm",
    "arch": "x86_64",
    "storage": "gp2",
    "minimal": false,
    "id": "ami-0f310fced6141e627",
    "arn": "arn:aws:ssm:ap-northeast-1::parameter/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2"
  }
]

Originally, it returns 10~15 AMIs, as parameter path is /aws/service/ami-amazon-linux-latest and search sub directory recursively.
If you wanna spare time to find the path of the AMI, use this helper and query it!

abc cfn unused-exports

List Cloudformation's exports, which not used in any stack.
It prints name and exporting_stack as csv with header.

Example:

There is a stack named abc-sample-stack with following template.

AWSTemplateFormatVersion: "2010-09-09"
Parameters:
  PJ:
    Description: project identifier
    Type: String
    Default: abc
Resources:
  Queue1:
    Type: AWS::SQS::Queue
    Properties: 
      QueueName: !Sub ${PJ}-queue1
  Queue2:
    Type: AWS::SQS::Queue
    Properties: 
      QueueName: !Sub ${PJ}-queue2
Outputs:
  Queue1:
    Value: !GetAtt Queue1.Arn
    Export:
      Name: !Sub ${PJ}-queue1-arn
  Queue2:
    Value: !GetAtt Queue2.Arn
    Export:
      Name: !Sub ${PJ}-queue2-arn

$ abc cfn unused-exports
[{"name":"abc-queue1-arn","exporting_stack":"abc-sample-stack"},{"name":"abc-queue2-arn","exporting_stack":"abc-sample-stack"}]

abc cfn purge-stack

Force Delete for Cloudformation's stack.
AWS does not support for deletion of some resources, such as ECR repostiory including images.
This command pre-performs image cleanup, and then stack deletion.
There may be other use cases, but currently only ECR deletion supported.

Example:

$ abc cfn purge-stack --stack-name abc-sample-stack
All images in abc-ecr-1 successfully deleted.
Perform delete-stack is in progress asynchronously.
Please check deletion status by yourself.

abc lambda stats

Count Lambda functions by runtime.
By default, as markdown table format.

$ abc lambda stats
|         RUNTIME          | COUNT |
|--------------------------|-------|
| nodejs12.x               |     2 |
| nodejs8.10（Deprecated） |     1 |
| python3.6                |     2 |
| ruby2.5                  |     8 |
| ruby2.7                  |     2 |

There is --verbose (-v) option.

$ abc lambda stats --verbose
|         RUNTIME          | COUNT |           FUNCTIONS           |
|--------------------------|-------|-------------------------------|
| nodejs12.x               |     2 | sample-nodejs-12-function-1   |
|                          |       | sample-nodejs-12-function-2   |
| nodejs8.10（Deprecated） |     1 | sample-nodejs-8-function      |
| python3.6                |     2 | sample-python-36-function-1,  |
|                          |       | sample-pytohn-36-function-2   |
| ruby2.5                  |     8 | sample-ruby-25-function-1,    |
|                          |       | sample-ruby-25-function-2,    |
|                          |       | sample-ruby-25-function-3,    |
|                          |       | sample-ruby-25-function-4,    |
|                          |       | sample-ruby-25-function-5,    |
|                          |       | sample-ruby-25-function-6,    |
|                          |       | sample-ruby-25-function-7,    |
|                          |       | sample-ruby-25-function-8     |
| ruby2.7                  |     2 | sample-ruby-27-function-1,    |
|                          |       | sample-ruby-27-function-2     |

JSON format also supported.

$ abc lambda stats --format json | jq "."
[
  {
    "runtime": "nodejs12.x",
    "count": 2,
    "deprecated": false
  },
  {
    "runtime": "nodejs8.10",
    "count": 1,
    "deprecated": true
  },
  {
    "runtime": "python3.6",
    "count": 2,
    "deprecated": false
  },
  {
    "runtime": "ruby2.5",
    "count": 8,
    "deprecated": false
  },
  {
    "runtime": "ruby2.7",
    "count": 2,
    "deprecated": false
  }
]

Note: Deprecated means the runtime, which no longer supported by AWS.

As of today (2020-06-09), the following runtimes have been deprecated:

• dotnetcore1.0
• dotnetcore2.0
• nodejs（=Node.js0.10）
• nodejs4.3
• nodejs4.3-edge
• nodejs6.10
• nodejs8.10

License

This code is made available under the Apache License 2.0.

Contributing

Feel free to open issues 🎉