Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add optional parameter for function name #471

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jkruse14
Copy link

Issue #, if available:
N/A

Description of changes:
Adds an optional parameter to the CloudFormation stack to be able to specify a FunctionName when installing with the SAM CLI. The README is updated with CI/CD (non-guided) instructions including how to specify the parameter-override for the FunctionName


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@@ -123,12 +123,50 @@ The Lambda version of the tool is a lightweight wrapper around the core [cfn-gua

### Building and deploying

#### Guided

1. Make sure docker is running
2. Navigate to `guard-lambda` directory and run `sam build --use-container` to build the code for the Lambda function
3. Run `sam deploy --guided` and complete the interactive workflow. This workflow will create a CloudFormation changeset and deploy it
4. Once it succeeds, the name of the function will be shown in the `CloudFormationGuardLambdaFunctionName` output
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are asking user to pass a parameter for name this line will change, correct?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a samconfig.toml is not being used, you are correct. sam deploy will need this added. I will update the PR.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I misunderstood - no, I don't think this will need to change. The output does not change by having a stack parameter. Also, if following the guided approach, it should be managed through the interactive process. The parameter is not required, so already existing consumers will not need to add it.

@joshfried-aws
Copy link
Contributor

Hi @jkruse14 I was wondering if you are able to look at the comments @akshayrane has left when you have a moment.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants