Categorygithub.com/moia-oss/go-deploy-cfn
modulepackage
0.0.0-20240612140837-867e347850b5
Repository: https://github.com/moia-oss/go-deploy-cfn.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
0
Files
229 SLOC

# README

go-deploy-cfn

A helper library which can be used in a Go project to deploy a cloudformation yaml template easier.

The main function is CloudFormationDeploy which takes a yaml string and returns an error type. It deploys a cloudformation template to AWS, waiting for the stack to finish updating for about 5 minutes. It simplifies the create-or-update semantics, and handles retries for status checking.

Contributing

This project welcomes contributions or suggestions of any kind. Please feel free to create an issue to discuss changes or create a Pull Request if you see room for improvement.

# Functions

CreateLogicalName creates a logical name used in the CloudFormation template.
CreateStackName creates a valid stack name from the given alarm name.

# Structs

Cloudformation is a utility wrapper around the original aws api to make common operations more intuitive.

# Interfaces

CloudformationAPI provides an API which can be used instead of a concrete client for testing/mocking purposes.