Skip to content

APIGW: support DeploymentCanarySettings for AWS::ApiGateway::Deployment #12899

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged

APIGW: support DeploymentCanarySettings for AWS::ApiGateway::Deployment #12899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...stack-core/localstack/services/apigateway/resource_providers/aws_apigateway_deployment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ def create(
if model.get("Description"):
params["description"] = model["Description"]

if model.get("DeploymentCanarySettings"):
params["canarySettings"] = model["DeploymentCanarySettings"]

Comment on lines +129 to +131
Copy link
Contributor

Choose a reason for hiding this comment

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

Gotta love these short code change PRs! 155 lines added, of which 3 are the implementation (2%)!

response = api.create_deployment(**params)

model["DeploymentId"] = response["id"]
Expand Down
27 changes: 27 additions & 0 deletions tests/aws/services/cloudformation/resources/test_apigateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,3 +724,30 @@ def test_serverless_like_deployment_with_update(
)
get_fn_2 = aws_client.lambda_.get_function(FunctionName="test-service-local-api")
assert get_fn_2["Configuration"]["Handler"] == "index.handler2"


@markers.snapshot.skip_snapshot_verify(paths=["$..tags"])
@markers.aws.validated
def test_apigateway_deployment_canary_settings(deploy_cfn_template, snapshot, aws_client):
snapshot.add_transformers_list(
[
snapshot.transform.key_value("deploymentId"),
snapshot.transform.key_value("aws:cloudformation:stack-name"),
snapshot.transform.resource_name(),
SortingTransformer("items", itemgetter("description")),
]
)

api_name = f"api-{short_uid()}"
stack = deploy_cfn_template(
template_path=os.path.join(
os.path.dirname(__file__), "../../../templates/apigateway_canary_deployment.yml"
),
parameters={"RestApiName": api_name},
)
api_id = stack.outputs["RestApiId"]
stage = aws_client.apigateway.get_stages(restApiId=api_id)
snapshot.match("get-stages", stage)

deployments = aws_client.apigateway.get_deployments(restApiId=api_id)
snapshot.match("get-deployments", deployments)
57 changes: 57 additions & 0 deletions tests/aws/services/cloudformation/resources/test_apigateway.snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,5 +734,62 @@
}
}
}
},
"tests/aws/services/cloudformation/resources/test_apigateway.py::test_apigateway_deployment_canary_settings": {
"recorded-date": "23-07-2025, 23:07:05",
"recorded-content": {
"get-stages": {
"item": [
{
"cacheClusterEnabled": false,
"cacheClusterStatus": "NOT_AVAILABLE",
"canarySettings": {
"deploymentId": "<deployment-id:1>",
"percentTraffic": 50.0,
"stageVariableOverrides": {
"lambdaAlias": "Dev"
},
"useStageCache": false
},
"createdDate": "datetime",
"deploymentId": "<deployment-id:2>",
"lastUpdatedDate": "datetime",
"methodSettings": {},
"stageName": "prod",
"tags": {
"aws:cloudformation:logical-id": "Stage",
"aws:cloudformation:stack-id": "arn:<partition>:cloudformation:<region>:111111111111:stack/<aws:cloudformation:stack-name:1>/<resource:1>",
"aws:cloudformation:stack-name": "<aws:cloudformation:stack-name:1>"
},
"tracingEnabled": false,
"variables": {
"lambdaAlias": "Prod"
}
}
],
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
},
"get-deployments": {
"items": [
{
"createdDate": "datetime",
"description": "basic deployment",
"id": "<deployment-id:2>"
},
{
"createdDate": "datetime",
"description": "canary description",
"id": "<deployment-id:1>"
}
],
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
}
}
}
}
9 changes: 9 additions & 0 deletions tests/aws/services/cloudformation/resources/test_apigateway.validation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@
"total": 16.99
}
},
"tests/aws/services/cloudformation/resources/test_apigateway.py::test_apigateway_deployment_canary_settings": {
"last_validated_date": "2025-07-23T23:07:16+00:00",
"durations_in_seconds": {
"setup": 0.44,
"call": 22.5,
"teardown": 11.11,
"total": 34.05
}
},
"tests/aws/services/cloudformation/resources/test_apigateway.py::test_cfn_apigateway_rest_api": {
"last_validated_date": "2025-05-05T14:50:14+00:00"
},
Expand Down
59 changes: 59 additions & 0 deletions tests/aws/templates/apigateway_canary_deployment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Parameters:
RestApiName:
Type: String

Resources:
RestApi:
Type: AWS::ApiGateway::RestApi
Properties:
Name: !Ref RestApiName
Stage:
Type: AWS::ApiGateway::Stage
Properties:
RestApiId:
Ref: RestApi
DeploymentId:
Ref: ApiDeployment
StageName: prod
Variables:
lambdaAlias: Prod

MockMethod:
Type: 'AWS::ApiGateway::Method'
Properties:
RestApiId: !Ref RestApi
ResourceId: !GetAtt
- RestApi
- RootResourceId
HttpMethod: POST
AuthorizationType: NONE
Integration:
Type: MOCK

ApiDeployment:
Type: AWS::ApiGateway::Deployment
Properties:
RestApiId:
Ref: RestApi
Description: "basic deployment"
DependsOn:
- MockMethod

ApiCanaryDeployment:
Type: AWS::ApiGateway::Deployment
Properties:
RestApiId:
Ref: RestApi
Description: "canary description"
DeploymentCanarySettings:
PercentTraffic: 50
StageVariableOverrides:
lambdaAlias: Dev
StageName: prod
DependsOn:
- MockMethod
- Stage

Outputs:
RestApiId:
Value: !GetAtt RestApi.RestApiId
Loading