aws / aws/aws-extensions-for-dotnet-cli

support CloudFormation template configuration file for deploy-serverless

Open
#216 0 comments 0 reactions 0 assignees View on GitHub
feature-request module/cli-ext p2 queued
Dominant language
C#
Stars
393
Forks
90
Avg merge
2d 19m
Merged PRs (30d)
3

Description

### Describe the feature

The [template configuration file](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html#w2ab1c21c15c15) is supported by several other tools in the CloudFormation ecosystem, and provides a convenient way to share config between manual deployments and CodePipeline.

### Use Case

When using a CI/CD pipeline, we prefer to use one `package-ci` call with multiple CloudFormation deployments (via CodePipeline's CloudFormation action). However, when experimenting locally, `dotnet lambda deploy-serverless` would be more convenient to use. Being able to share one config file format between the two (copying & tweaking or overriding the dev config file for local experiments) would make this a lot more straightforward.

### Proposed Solution

an option for `dotnet lambda deploy-serverless` accepting a relative path to a CloudFormation template config file, which applies that config but is overridden by the `--template-parameters` and `--tags` arguments

### Other Information

A workaround which only respects Parameters (not Tags) is to use `dotnet lambda package-ci` followed by `aws cloudformation deploy --parameter-overrides file://{config_file_path}`

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### Targeted .NET platform

6.0.202

### CLI extension version

5.1.4

### Environment details (OS name and version, etc.)

Windows 10, git bash

Contributor guide

Open the contributing guide

Research direction

Start at the dotnet lambda deploy-serverless command and compare its configuration flow with the package-ci workaround and aws cloudformation deploy parameter-overrides usage. Verify how a CloudFormation template configuration file should be read, then confirm that --template-parameters and --tags override it; done means local deploy-serverless supports the shared file format without changing those override rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, csharp
Domain
cli, cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.