7

I have an existing API Gateway with resources and stages. I'm adding a new resource to it via aws cdk. The Gateway is configured with deploy:false, so I have to manually create a new deployment for it. I can import the gateway, but I can't find a similar method (fromLookup?) in the Stage class. I know I can create a new stage but it doesn't sound like a scalable solution.

The code is below:

const api = apigateway.RestApi.fromRestApiAttributes(this, 'RestApi', {
  restApiId: 'XXX',
  rootResourceId: 'YYYY',
});

const deployment = new apigateway.Deployment(this, 'APIGatewayDeployment', {
  api,
});

// How to get an existing stage here instead of creating a new one?
const stage = new apigateway.Stage(this, 'test_stage', {
  deployment,
  stageName: 'dev',
});

api.deploymentStage = stage;
Intetics
  • 75
  • 1
  • 4

2 Answers2

6

I was facing the same issue today but I discovered that if you set the stageName property for a deployment resource It will use the existing stage.

If you check the CloudFormation documentation for the Deployment resource, it has a StageName property (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html).

But if you check the Deployment implementation for CDK, it doesn't have support for the stageName property (https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/aws-apigateway/lib/deployment.ts#L71) and by following the extends on the Deployment class, it ends on extending from a CfnResource that is expecting a stageName value in the constructor.

So I end up forcing the Deployment resource to pick the value that I want by doing this:

const api = apigateway.RestApi.fromRestApiAttributes(this, 'RestApi', {
  restApiId: 'XXX',
  rootResourceId: 'YYYY',
});

const deployment = new apigateway.Deployment(this, 'APIGatewayDeployment', {
  api,
});

deployment.resource.stageName = 'YourStageName';
Luciano Fantone
  • 76
  • 1
  • 2
    "resource" is a private property on the Deployment object for me. Typescript won't let it compile. – Connor Feb 01 '21 at 15:22
  • @Connor it is only private for typescript and typescript types are only evaluated at compile time. That means we can get away with `(deployment as any).resource.stageName = 'YourStageName';` – samuba Mar 30 '21 at 17:16
  • How does this work if you have multiple stages? – tvb Apr 08 '22 at 07:53
  • I have created a future request on cdk repository for this: https://github.com/aws/aws-cdk/issues/25582 – Lucas Santos May 15 '23 at 01:09
3

For me, the issue was that the deployment was updating the resources for the API, but not for the stage. The fix was to create a new deployment ID every time:

// Create deployment with ID based on current date
const deployment = new apigw.Deployment(this, 'deployment-' + new Date().toISOString(), { api });
  
// Deploy to existing API & stage  
const stage = new apigw.Stage(this, 'stage-alpha', { deployment, stageName: 'alpha' });
api.deploymentStage = stage

With the code you posted, you should see in the Stage > Deployment History tab that it's not adding new deployments until you give it a unique ID.

Note: This might not be ideal since it deploys updates every time you run cdk deploy, even if no other changes were made

Connor
  • 670
  • 3
  • 9
  • 29
  • 1
    I can't get this to work. Cloudformation is complaining about the stage already exists (yes, intended) xxx|dev already exists in stack arn:aws:cloudformation:xxx:xxx:stack/xxx/xxxx-b5de-11ec-a70b-0257aa684859 – tvb Apr 08 '22 at 10:02
  • 1
    This will error out as new apigw.Stage will always try to create new stage even if stage exists. – Maclean Pinto Jan 27 '23 at 14:45