Skip to content

Github Action that updates CloudFormation stack parameters while preserving other settings

License

Notifications You must be signed in to change notification settings

artyom/update-cloudformation-stack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b63ad54 · Dec 9, 2024

History

12 Commits
Nov 23, 2024
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Nov 28, 2024
Nov 24, 2024
Nov 22, 2024
Nov 22, 2024
Dec 9, 2024
Nov 24, 2024

Repository files navigation

Update CloudFormation Stack Parameters Action

This GitHub Action updates existing CloudFormation stack by changing some of its parameters while preserving all other settings.

Usage

- uses: artyom/update-cloudformation-stack@main
  with:
    stack: my-stack-name
    parameters: |
      Name1=value1
      Name2=value2

Inputs

  • stack - name of the CloudFormation stack to update
  • parameters - pairs of parameters in the Name=Value format, each pair on a separate line

AWS Credentials

This action uses the AWS SDK default credential provider chain. Configure AWS credentials using standard GitHub Actions methods:

- uses: aws-actions/configure-aws-credentials@v4
  with:
    role-to-assume: arn:aws:iam::123456789012:role/my-role
    aws-region: us-east-1

AWS Permissions

This action requires the following permissions:

  • cloudformation:DescribeStacks
  • cloudformation:UpdateStack
  • cloudformation:DescribeStackEvents

Example

jobs:
  update-stack:
    runs-on: ubuntu-latest
    steps:
      - uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: arn:aws:iam::123456789012:role/my-role
          aws-region: us-east-1
      - uses: artyom/update-cloudformation-stack@main
        with:
          stack: production-stack
          parameters: |
            ImageTag=v123

The action will monitor stack update progress and fail if update fails.

Known Limitations

This action doesn't work for stacks that rely on template transformations (stack template has non-empty “Transform” section).

On such stacks UpdateStack API call does not recognize parameters-only changes and the action reports there's nothing to update.

About

Github Action that updates CloudFormation stack parameters while preserving other settings

Resources

License

Stars

Watchers

Forks

Releases

No releases published