Skip to main content

Read any resource in your AWS Account. You can generate terraform code for them, too.

Project description

balcony

Build and publish a Docker image to ghcr.io

Build and Deploy Documentation website

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
  • 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

Installation

pip3 install balcony

Visit Installation & QuickStart Page to get started using balcony

# 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 <service> <resource-name> --paginate command reads all resources of a given type in your AWS account.

Related Docs: QuickStart


Generate Terraform Import Blocks

Terraform v1.5 introduced import blocks that allows users to define their imports as code.

balcony terraform-import <service> <resource-name> command generates these import blocks for you.

balcony terraform-import --list to see the list of supported resources.

Related Docs: Generate Terraform Import Blocks Related Docs: 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.

Related Docs: Generate Terraform Code with Docker Image


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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

balcony-0.2.0.tar.gz (55.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

balcony-0.2.0-py3-none-any.whl (69.2 kB view details)

Uploaded Python 3

File details

Details for the file balcony-0.2.0.tar.gz.

File metadata

  • Download URL: balcony-0.2.0.tar.gz
  • Upload date:
  • Size: 55.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.12 Darwin/22.5.0

File hashes

Hashes for balcony-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d216e88478ac746313f2a901c2c7884a2d1055cab9f636c02cd27246a8bd0cbe
MD5 23c343fd67369779a20f69959a121627
BLAKE2b-256 5e8d2b683650f2d1d0a3be3b03383e198bd9b223611a2669595af03a1736b4b8

See more details on using hashes here.

File details

Details for the file balcony-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: balcony-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 69.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.12 Darwin/22.5.0

File hashes

Hashes for balcony-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 907396555e7ae300e60861aa3ec55e8956a7ec8ca61658a308e82ac49c461fb4
MD5 932090cbf0361142e33cc9283768894b
BLAKE2b-256 4c7d973412898beb56cefdb54ed2090273b593c86f5aa616bb50f93c45da28f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page