Awesome

aws-arn

This repository contains a list of almost all (WIP) AWS services and resources with their ARN format, ID name, ID regexp, ASFF name, CloudFormation resource name and Terraform resource name, that you can use as Documentation, as a Python module or as CLI tool.

Use Cases

• Parse an ARN and get the service, resource name, region, account, and resource ID, Terraform resource name, CloudFormation resource name and ASFF resource name
• Generate ARNs for any AWS resource by passing in different parameters
  • Using service and resource name (e.g. acm and certificate)
  • Using Terraform resource name (e.g. aws_acm_certificate)
  • Using Cloudformation resource name (e.g. AWS::CertificateManager::Certificate)
  • Using ASFF resource name (e.g. AwsCertificateManagerCertificate)
• Get the ASFF Resource Name for any AWS resource
• Get the Cloudformation Resource Name for any AWS resource
• Get the Terraform Resource Name for any AWS resource

Contributing

:warning: Work in progress: This is a work in progress. Not all services and resources are included yet. Please open an issue or pull request if you find any errors or omissions.

The data is defined in the file data.py as Python dictionary.

For each service:

"acm": { # The Service Name (we follow boto3 naming conventions)
    "certificate": {  # The Resource Name (we follow boto3 naming conventions)
        "arn_format": "arn:{partition}:acm:{region}:{account}:certificate/{resource_id}", # The ARN format
        "id_name": "CertificateId",  # The Resource Id name
        "id_regexp": "([a-z0-9-]+)", # The Resource Id regexp
        "asff_name": "AwsCertificateManagerCertificate",   # The ASFF Resource Name
        "cloudformation": "AWS::CertificateManager::Certificate",  # The CloudFormation Resource Name
        "terraform": "aws_acm_certificate",  # The Terraform Resource Name
    }
},

Python Module

pip3 install aws-arn

Generate ARN

import aws_arn

# Generate ARN using service and resource name
print(aws_arn.generate_arn('i-1234568901', 'ec2', 'instance', 'us-east-1', '012345789012', 'aws'))
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using Terraform resource name
print(aws_arn.generate_arn_from_terraform('i-1234568901', 'aws_instance', 'us-east-1', '012345789012', 'aws'))
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using Cloudformation resource name
print(aws_arn.generate_arn_from_cloudformation('i-1234568901', 'AWS::EC2::Instance', 'us-east-1', '012345789012', 'aws'))
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using ASFF resource name
print(aws_arn.generate_arn_from_asff('i-1234568901', 'AwsEC2Instance', 'us-east-1', '012345789012', 'aws'))
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

Parse ARN:

import aws_arn

print(aws_arn.parse_arn('arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901'))

{
   "service":"ec2",
   "sub_service":"instance",
   "region":"us-east-1",
   "account":"012345789012",
   "resource_id":"i-1234568901",
   "asff_resource":"AwsEc2Instance",
   "terraform":"aws_instance",
   "cloudformation":"AWS::EC2::Instance"
}

CLI Tool

git clone git@github.com:gabrielsoltz/aws-arn.git
./aws-arn --help

Generate ARN

# Generate ARN using service and resource name
./aws-arn --generate-arn --id i-1234568901 --service ec2 --sub-service instance --region us-east-1 --account 012345789012 --partition aws
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using Terraform resource name
./aws-arn --generate-arn-from-terraform --id i-1234568901 --terraform aws_instance --region us-east-1 --account 012345789012 --partition aws
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using Cloudformation resource name
./aws-arn --generate-arn-from-cloudformation --id i-1234568901 --cloudformation AWS::EC2::Instance --region us-east-1 --account 012345789012 --partition aws
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

# Generate ARN using ASFF resource name
./aws-arn --generate-arn-from-asff --id i-1234568901 --asff-resource AwsEC2Instance --region us-east-1 --account 012345789012 --partition aws
arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901

Parse ARN

./aws-arn --parse-arn arn:aws:ec2:us-east-1:012345789012:instance/i-1234568901
{'service': 'ec2', 'sub_service': 'instance', 'region': 'us-east-1', 'account': '012345789012', 'resource_id': 'i-1234568901', 'asff_resource': 'AwsEc2Instance', 'terraform': 'aws_instance', 'cloudformation': 'AWS::EC2::Instance'}

Complete List of ARNs

Projects using this library

• MetaHub