CloudFormation aware aws cli wrapper.
Project description
pronounced /ˈɒzi/ oz-ee like our great friends from down under.
AWSIE is a CloudFormation aware wrapper on top of the AWS CLI. It help you to call an awscli command, but instead of the actual physical ID of the resource you set the logical CloudFormation template id or a CloudFormation Output which will be replaced when executing the actual command.
For many different resources AWS can automatically set a random name when creating the resource through Cloudformation. While this has a big upside with resources not clashing when the same stack gets deployed multipe times, a downside is that running a command against a specific resource means you have to write lookup code or use the resource name by hand.
Awsie helps you to do that lookup and call the awscli without any potential for clashes. By supporting both LogicalIds and Output variables you have a lot of flexibility for your deployment scripts.
Installation
Before installing make sure you have the awscli installed as awsie depends on it. We don’t install it ourselves so you’re able to install the exact version you want to use.
pip install awscli
awsie can be installed through pip:
pip install awsie
Alternatively you can clone this repository and run
python setup.py install
Quick example
For example when you deploy a CloudFormation stack:
{
"Resources": {
"DeploymentBucket": {
"Type": "AWS::S3::Bucket"
}
}
}
and then want to list the content of the bucket you can use awsie:
awsie example-stack s3 ls s3://cf:DeploymentBucket: --region us-west-1
or if you want to remove somefile from the DeploymentBucket:
awsie example-stack s3 rm s3://cf:DeploymentBucket:/somefile --region us-west-1
which will replace cf:DeploymentBucket: with the actual name of the resource and run the awscli with all arguments you passed to awsie, except for the stack-name (which has to be the first argument):
aws s3 ls s3://formica-example-stack-deploymentbucket-1jjzisylxreh9 --region us-west-1
aws s3 rm s3://formica-example-stack-deploymentbucket-1jjzisylxreh9/somefile --region us-west-1
Replacement syntax
The replacement syntax is cf:LOGICAL_ID: and will replace LOGICAL_ID with the PhysicalId of the resource through the data returned from list-stack-resources. Make sure you don’t forget the second colon at the end, its important to be able to separate the syntax when its embedded in another string.
Arbitrary commands
You can also use awsie to run arbitrary commands with replaced values. Simply use the --command option to set the specific command and the options you want to use. Make sure the command is in quotes so its handled as one argument to awsie.
awsie stack --command "awslogs get cf:LogGroup: ALL"
Options
awsie STACK_NAME
stack Has to be the first positional argument and will be removed from call to the AWS cli.
--profile PROFILE The AWS profile to use for the CloudFormation lookup, will be passed to the aws cli.
--region REGION The AWS region to use for the CloudFormation lookup, will be passed to the aws cli.
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
Built Distribution
Hashes for awsie-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8092409fbd31b9b2b486ec8f5aa5ec7ef05da4c49ebaf1add81215759919879 |
|
MD5 | 55cff0494f09bb045ca434d5dee07932 |
|
BLAKE2b-256 | ca9ead16607cc4fda24a382f2f2de94c05d149e1b395ba6a39077ed0d96edd38 |