Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://oguzhan-yilmaz.github.io/balcony/
cli tool to read any resource off of AWS API. Also generates Terraform import-blocks, and actual Terraform Resource code.
https://oguzhan-yilmaz.github.io/balcony/
aws aws-api aws-cli cli code-generation code-generator docker python3 terraform terraform-import
Last synced: 5 days ago
JSON representation
cli tool to read any resource off of AWS API. Also generates Terraform import-blocks, and actual Terraform Resource code.
- Host: GitHub
- URL: https://oguzhan-yilmaz.github.io/balcony/
- Owner: oguzhan-yilmaz
- License: apache-2.0
- Created: 2022-09-26T12:30:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T10:31:36.000Z (3 months ago)
- Last Synced: 2024-10-10T18:06:32.157Z (26 days ago)
- Topics: aws, aws-api, aws-cli, cli, code-generation, code-generator, docker, python3, terraform, terraform-import
- Language: Python
- Homepage: https://oguzhan-yilmaz.github.io/balcony/
- Size: 15.3 MB
- Stars: 137
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tf - balcony - CLI tool for easy AWS API reads. Also generates Terraform import-blocks, and actual Terraform Resource code. (Tools / Community providers)
README
# balcony
balcony is a modern CLI tool that with some killer features:
- Auto-fill the required parameters for AWS API calls
- Read the JSON data of any AWS resource in your account
- Generate [Terraform Import Blocks](https://developer.hashicorp.com/terraform/language/import)
- Generate actual `.tf` Terraform Resource code
balcony uses _read-only_ operations, it does not take any action on the used AWS account.
### [Visit the Documentation Website](https://oguzhan-yilmaz.github.io/balcony/quickstart/)
### Installation
```bash
pip3 install balcony
```
Visit [**Installation & QuickStart Page**](https://oguzhan-yilmaz.github.io/balcony/quickstart/) to get started using _balcony_
```bash title="Basic usage"
# see options
balcony
# list available resources of ec2
balcony aws ec2
# read a resource
balcony aws s3 Buckets
# show documentation
balcony aws iam Policy --list
# generate terraform import blocks for a resource
balcony terraform-import s3 Buckets
```
## Features
### Read any AWS Resource
`balcony aws --paginate` command reads all resources of a given type in your AWS account.
Related Docs: [QuickStart](https://oguzhan-yilmaz.github.io/balcony/quickstart/)
---
### Filter and Exclude by Tags
- [aws-jmespath-utils](https://github.com/oguzhan-yilmaz/aws-jmespath-utils) dependency is used to enable JMESPath expressions to filter and exclude resources by tags
- Following expressions are used to select anything: (`=`, `*=`, `=*`, `*=*`)
- You can leave one side empty or put a `*` there to discard that sides value
-
### Filter tags
- Select everything
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["="]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["*="]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["=*"]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["*=*"]`, @).Tags'
```
- Find named EC2 Instances
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["Name="]`, @)'
```
- Find AWS MAP migration tagged EC2 Instances
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].filter_tags(`["map-migrated="]`, @)'
```
### Exclude tags
- Exclude everything
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["="]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["*="]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["=*"]`, @).Tags'
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["*=*"]`, @).Tags'
```
- Find un-named EC2 Instances
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["Name="]`, @)'
```
- Find AWS MAP migration un-tagged EC2 Instances
```bash
balcony aws ec2 Instances -js 'DescribeInstances[].Reservations[].Instances[].exclude_tags(`["map-migrated="]`, @)'
```
---
### Generate Terraform Import Blocks
Terraform v1.5 introduced [import blocks](https://developer.hashicorp.com/terraform/language/import) that allows users to define their imports as code.
`balcony terraform-import ` command generates these import blocks for you.
`balcony terraform-import --list` to see the list of supported resources.
Related Docs: [Generate Terraform Import Blocks](https://oguzhan-yilmaz.github.io/balcony/terraform-import/)
Related Docs: [Balcony Terraform Import Support Matrix](https://oguzhan-yilmaz.github.io/balcony/terraform-import-support-matrix/)
---
### Generate actual Terraform Resource Code
If you have:
- initialized terraform project
- `import_blocks.tf` file that's generated with `balcony terraform-import` command
you can run `terraform plan -generate-config-out=generated.tf` to generate actual `.tf` resource code.
This feature is achieved with the [balcony-terraform-import Docker Image](https://github.com/oguzhan-yilmaz/balcony/pkgs/container/balcony-terraform-import).
Related Docs: [Generate Terraform Code with Docker Image](https://oguzhan-yilmaz.github.io/balcony/terraform-import-docker/)
---
### Interactive Wizard to create balcony import configurations
Balcony doesn't know how to create terraform `import blocks` for all of the AWS resources.
It can be taught how to do it by creating `import-configurations` yaml files, but it's a manual process. This is where the interactive wizard comes in.
Interactive Wizards asks you required questions to automatically create the `import-configurations` yaml files.
Related Docs: [Terraform Import Configuration Wizard](https://oguzhan-yilmaz.github.io/balcony/terraform-import-wizard/)
