===============
**aws-cfstack**
===============
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:
.. code-block:: BASH
pip3 install aws-cfstack
# or
python3 -m pip install aws-cfstack
In Python3 authenticating with named profiles:
.. code-block:: PYTHON
import aws_cfstack
aws_cfstack.get_stack(
'</output/path>',
'profile',
profile_name='<profile_name>'
)
In BASH authenticating with named profiles:
.. code-block:: BASH
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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/fer1035_python/modules/pypi-aws_cfstack",
"name": "aws_cfstack",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6,<4.0",
"maintainer_email": "",
"keywords": "AWS,CloudFormation,stack,download,backup",
"author": "Ahmad Ferdaus Abd Razak",
"author_email": "ahmad.ferdaus.abd.razak@ni.com",
"download_url": "https://files.pythonhosted.org/packages/82/95/b501f46714027d1d59d964b9be59099ad519b82d77d9eb9dd80b0d6650d6/aws_cfstack-2024.1.0.0.tar.gz",
"platform": null,
"description": "===============\n**aws-cfstack**\n===============\n\nOverview\n--------\n\nGet AWS CloudFormation stack template and parameters.\n\nPrerequisites\n-------------\n\n- *Python >= 3.6*\n- *aws-authenticator (https://pypi.org/project/aws-authenticator/) >= 2022.10.1.0*\n\nRequired Arguments\n------------------\n\n- Output path (to store module artifacts)\n- AWS authentication method (profile, iam, or sso)\n\nConditional Arguments\n---------------------\n\nIf authenticating with named profiles:\n\n- AWSCLI profile name\n\nIf authenticating with IAM acccess key credentials:\n\n- AWS access key id\n- AWS secret access key\n\nIf authenticating with SSO:\n\n- AWS account ID\n- AWS SSO Permission Set (role) name\n- AWS SSO login URL\n\nUsage\n-----\n\nInstallation:\n\n.. code-block:: BASH\n\n pip3 install aws-cfstack\n # or\n python3 -m pip install aws-cfstack\n\nIn Python3 authenticating with named profiles:\n\n.. code-block:: PYTHON\n\n import aws_cfstack\n\n aws_cfstack.get_stack(\n '</output/path>',\n 'profile',\n profile_name='<profile_name>'\n )\n\nIn BASH authenticating with named profiles:\n\n.. code-block:: BASH\n\n python [/path/to/]aws_cfstack \\\n -o </output/path> \\\n -m profile \\\n -p <profile_name>\n\nCaveat\n------\n\n- This module creates files within the specified *output_path*.\n- 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.\n- DOS line-endings (\"**\\r**\") are removed from the outputs. Only Unix line-endings (\"**\\n**\") are retained.\n",
"bugtrack_url": null,
"license": "GPL-2.0-only",
"summary": "Get AWS CloudFormation stack template and parameters.",
"version": "2024.1.0.0",
"project_urls": {
"Homepage": "https://gitlab.com/fer1035_python/modules/pypi-aws_cfstack",
"Repository": "https://gitlab.com/fer1035_python/modules/pypi-aws_cfstack"
},
"split_keywords": [
"aws",
"cloudformation",
"stack",
"download",
"backup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d80b77075fde87c7864f36a881ead0d900475ff4631bfd25679bf2ce4d678ec",
"md5": "bb9b301b87900325974dcfa1a0581493",
"sha256": "46b3a7f45ff4c81a5c32d8a6333a599f45cd98e46cd7c2e49c3196d17bc2be1e"
},
"downloads": -1,
"filename": "aws_cfstack-2024.1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb9b301b87900325974dcfa1a0581493",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6,<4.0",
"size": 3692,
"upload_time": "2024-02-02T05:16:17",
"upload_time_iso_8601": "2024-02-02T05:16:17.047950Z",
"url": "https://files.pythonhosted.org/packages/1d/80/b77075fde87c7864f36a881ead0d900475ff4631bfd25679bf2ce4d678ec/aws_cfstack-2024.1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8295b501f46714027d1d59d964b9be59099ad519b82d77d9eb9dd80b0d6650d6",
"md5": "4a029bbfdbf260e0f4acfc593f218070",
"sha256": "c790305d76389ca7af2b3313a9fc3fe89f180f9d7b0834756dbeebd52487f363"
},
"downloads": -1,
"filename": "aws_cfstack-2024.1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4a029bbfdbf260e0f4acfc593f218070",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6,<4.0",
"size": 2972,
"upload_time": "2024-02-02T05:16:18",
"upload_time_iso_8601": "2024-02-02T05:16:18.673647Z",
"url": "https://files.pythonhosted.org/packages/82/95/b501f46714027d1d59d964b9be59099ad519b82d77d9eb9dd80b0d6650d6/aws_cfstack-2024.1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 05:16:18",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "fer1035_python",
"gitlab_project": "modules",
"lcname": "aws_cfstack"
}
JSON