Skip to main content

Get AWS CloudFormation stack template and parameters.

Project description

Overview

Get AWS CloudFormation stack template and parameters.

Prerequisites

  • Python >= 3.6

  • aws-authenticator (https://pypi.org/project/aws-authenticator/) >= 2022.10.1.0

Required Arguments

  • Output path (to store module artifacts)

  • AWS authentication method (profile, iam, or sso)

Conditional Arguments

If authenticating with named profiles:

  • AWSCLI profile name

If authenticating with IAM acccess key credentials:

  • AWS access key id

  • AWS secret access key

If authenticating with SSO:

  • AWS account ID

  • AWS SSO Permission Set (role) name

  • AWS SSO login URL

Usage

Installation:

pip3 install aws-cfstack
# or
python3 -m pip install aws-cfstack

In Python3 authenticating with named profiles:

import aws_cfstack

aws_cfstack.get_stack(
   '</output/path>',
   'profile',
   profile_name='<profile_name>'
)

In BASH authenticating with named profiles:

python [/path/to/]aws_cfstack \
-o </output/path> \
-m profile \
-p <profile_name>

Caveat

  • This module creates files within the specified output_path.

  • All stack instances whose names start with “StackSet-” are filtered out. This module was not intended to work with stack sets, although it can easily be expanded to do so.

  • DOS line-endings (”r”) are removed from the outputs. Only Unix line-endings (”n”) are retained.

Project details


Download files

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

Source Distribution

aws_cfstack-2024.1.0.0.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

aws_cfstack-2024.1.0.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file aws_cfstack-2024.1.0.0.tar.gz.

File metadata

  • Download URL: aws_cfstack-2024.1.0.0.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/5.4.109+

File hashes

Hashes for aws_cfstack-2024.1.0.0.tar.gz
Algorithm Hash digest
SHA256 c790305d76389ca7af2b3313a9fc3fe89f180f9d7b0834756dbeebd52487f363
MD5 4a029bbfdbf260e0f4acfc593f218070
BLAKE2b-256 8295b501f46714027d1d59d964b9be59099ad519b82d77d9eb9dd80b0d6650d6

See more details on using hashes here.

File details

Details for the file aws_cfstack-2024.1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cfstack-2024.1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46b3a7f45ff4c81a5c32d8a6333a599f45cd98e46cd7c2e49c3196d17bc2be1e
MD5 bb9b301b87900325974dcfa1a0581493
BLAKE2b-256 1d80b77075fde87c7864f36a881ead0d900475ff4631bfd25679bf2ce4d678ec

See more details on using hashes here.

Supported by

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