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.1.11.tar.gz (54.9 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.1.11-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: balcony-0.1.11.tar.gz
  • Upload date:
  • Size: 54.9 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.1.11.tar.gz
Algorithm Hash digest
SHA256 2d6af3f11c358d06b9c8499f6519c054aac2c5ff3162a23b1e7037c01dd9c0a8
MD5 6fc8826fc494dfd71edaf3b62a7ac141
BLAKE2b-256 90730bbd5c2ca1bf3d050441f50c2166eb623391c3b6607f4d5722883f4d0626

See more details on using hashes here.

File details

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

File metadata

  • Download URL: balcony-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 66.8 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.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c02a6be1d02ffec59c2e41eebca3bf9fa80f80d59931f96eb31c2fc6ff939a46
MD5 c005598a0af0dc7a86ce1dca96d91e88
BLAKE2b-256 1c17ce902f88502b25975eadd98af095a3586369f86e82d9d7dec5c264f46b53

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