Releases: aws-samples/aws-auto-inventory
0.2.0
Changelog
Improvements
- Use of Dev Containers for development
Features
- Allow users to use AWS environment variables, making the use of AWS profile optional.
Bug Fixes
- General improvements.
What's Changed
- Bump numpy from 1.20.0 to 1.22.0 by @dependabot in #9
- Feature/aws credentials by @valter-silva-au in #12
- Release 0.2.0 by @valter-silva-au in #13
New Contributors
- @dependabot made their first contribution in #9
Full Changelog: 0.1.3...0.2.0
0.1.2
Improvements
#5: Upgrade urllib3
version
#6: Print the file path of the report generated
#7: Build the project on Github
Full Changelog: 0.1.0...0.1.2
0.1.0
You will need to create a config.yaml
file in order to tell the tool how to generate your inventory, here are the default search paths for each platform:
- OS X:
~/.config/aws-auto-inventory/config.yaml
or~/Library/Application Support/aws-auto-inventory/config.yaml
- Other Unix:
$XDG_CONFIG_HOME/aws-auto-inventory/config.yaml
or~/.config/aws-auto-inventory/config.yaml
- Windows:
%APPDATA%\aws-auto-inventory\config.yaml
where theAPPDATA
environment variable falls back to%HOME%\AppData\Roaming\config.yaml
if undefined
You can use the config-sample as an example. A snippet can be found below:
inventories:
- name: your-inventory-name
aws:
profile: your-aws-profile
region:
- us-east-1
excel:
transpose: true
sheets:
- name: EC2 # sheet name on Excel
service: ec2 # the boto3 client of an AWS service
function: describe_instances # the client method of the service defined above
result_key: Reservations # [optional]: The first key of the response dict
- name: EBS
service: ec2
function: describe_volumes
result_key: Volumes
Now, download the binary according to your operating system and platform and execute it, informing which inventory you want to generate.
The tool will create a folder aws-auto-inventory-report
, in the current path, with the inventory report inside.
Testing
AWS-Auto-Inventory uses boto3.
You can use any service that contains any list or describe method to fetch information about your resources.
Parameters
You can use boto3 parameters to narrow down your search results.
Filter by tag:Name
sheets:
- name: VPC
service: ec2
function: describe_vpcs
result_key: Vpcs
parameters:
Filters:
- Name: tag:Name
Values:
- my-vpc
Filter by vpc-id
sheets:
- name: Subnets
service: ec2
function: describe_subnets
result_key: Subnets
parameters:
Filters:
- Name: vpc-id
Values:
- vpc-xxx
Find a particular RDS instance
sheets:
- name: RDS
service: rds
function: describe_db_instances
result_key: DBInstances
parameters:
DBInstanceIdentifier: the-name-of-my-rds-instance
Find EC2 instances by a particular tag
sheets:
- name: EC2
service: ec2
function: describe_instances
result_key: Reservations
parameters:
Filters:
- Name: tag:ApplicationName
Values:
- my-application
Find a particular IAM Role
sheets:
- name: IAM.Role
service: iam
function: get_role
result_key: Role
parameters:
RoleName: my-role