aws_cfstack 2024.1.0.0

Get AWS CloudFormation stack template and parameters.

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.