feat(api-gateway): deploy RestApi to existing stage by gracelu0 · Pull Request #29486 · aws/aws-cdk

gracelu0 · 2024-03-14T17:38:58Z

Issue

Closes #25582 .

Reason for this change

If I have to manually create a new deployment for API gateway but want to deploy to an existing stage instead of creating a new stage, the current workaround is (deployment as any).resource.stageName = "myStage";

Description of changes

Added a new property stageName to Deployment. Updated README with two new sections: Deploying to an existing stage and Controlled triggering of deployments to show how users can trigger new deployments with their latest API changes if they manually create a Deployment resource for RestApi.

Since RestApiBase manages Deployment constructs, this change applies to both SpecRestApi and RestApi.

Description of how you validated changes

Added unit tests and integration tests. Also successfully deployed a sample app to my account where I created a stage in the API gateway console and specified the stage name in the new deployment.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

packages/aws-cdk-lib/aws-apigateway/README.md

packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts

packages/aws-cdk-lib/aws-apigateway/test/deployment.test.ts

packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts

godwingrs22

left few minor comments.

packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts

...cdk-testing/framework-integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.ts

godwingrs22

left some comments

...cdk-testing/framework-integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.ts

godwingrs22

LGTM. Thanks @gracelu0 for your effort in implmenting this much awaited feature.

mergify · 2024-04-26T17:50:39Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-04-26T18:18:49Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 953e46d
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-04-26T18:19:10Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

leoujjawal · 2024-05-01T12:04:27Z

Hi @godwingrs22 @gracelu0 : I am still unable to use this in CDK Python v 2.139.1

gracelu0 · 2024-05-01T20:14:53Z

Hi @godwingrs22 @gracelu0 : I am still unable to use this in CDK Python v 2.139.1

Hi @leoujjawal it looks like this didn't make it into the latest release - it should be included the next release.

eripoll · 2024-09-19T17:17:37Z

I have been trying to use this but to no avail. I see my resources in the resource view, I see a new deployment is active, but the stage hasn't changed.
What am I doing wrong here?

        deployment = apigw.Deployment(
            self,
            deployment_name,
            api=api,
            retain_deployments=True,
            description=description,
            stage_name= stage_name,
        )

leoujjawal · 2024-09-19T19:20:20Z

I have been trying to use this but to no avail. I see my resources in the resource view, I see a new deployment is active, but the stage hasn't changed. What am I doing wrong here?
        deployment = apigw.Deployment(
            self,
            deployment_name,
            api=api,
            retain_deployments=True,
            description=description,
            stage_name= stage_name,
        )

All you got to do is -

# Always create a new deployment
deployment = Deployment(self, str(uuid.uuid4()), api=rest_api)

v1_stage = Stage(
            self,
            "StageV1",
            stage_name="v1",
            deployment=deployment,
            logging_level=MethodLoggingLevel.INFO,
            data_trace_enabled=False,
            tracing_enabled=True,
        )

 rest_api.deployment_stage = v1_stage

Also consider adding a deopendency on the stage for the resource you are trying to create

v1_stage.node.add_dependency(users_resource)

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1 labels Mar 14, 2024

aws-cdk-automation requested a review from a team March 14, 2024 17:39

mergify bot added the contribution/core This is a PR that came from AWS. label Mar 14, 2024