aws / aws/serverless-application-model

Surface DeploymentCanarySettings on Serverless::Api

Open
#1,585 0 comments 0 reactions 0 assignees View on GitHub
area/api-gateway area/resource/api maintainer/need-response type/feature type/new-property
Dominant language
Python
Stars
9.6k
Forks
2.5k
Avg merge
1d 11h
Merged PRs (30d)
7

Description

**Description:**

Need to surface the [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) setting for API Gateway RestApis.

This will allow customers to use these deployment settings to deploy a new api revision gradually.

**Caveats:**

SAM doesn't know about previous deployment resources (ie SAM is stateless, doesn't know about older versions of the same template). If a new deployment is created (changes made to DefinitionBody), it will be impossible in SAM to update these canary settings on an old deployment, which will force users to update those settings via the console or CLI.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.