Skip to content

endpointExportName not using correct key in the outputs file #27577

Open
@nirgluzman

Description

@nirgluzman

Describe the bug

endpointExportName should assign the export name for the CfnOutput containing the API endpoint.
It looks like that it does not put the value under the correct name in the outputs file, but rather add some random characters.

Here is a link to documentation:
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html

I'm using this code in ApiStack:

    const api = new RestApi(this, 'Api', {
      endpointExportName: 'ApiEndpoint', 
    });

Expected Behavior

"ApiStack": {
    "ApiEndpoint": "https://XXXXXX.amazonaws.com/prod/"
  }

Current Behavior

"ApiStack": {
    "ApiEndpoint4F160690": "https://XXXXXX.amazonaws.com/prod/"
  }

Reproduction Steps

Run cdk deploy --all --outputs-file outputs.json and view the outputs.json file.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.101.1 (build 16ddad1)

Framework Version

No response

Node.js Version

v20.5.1

OS

Windows

Language

TypeScript

Language Version

TypeScript 5.2.2

Other information

I would like to avoid using CfnOutput as it seems that endpointExportName property is doing the same.
Could it be that I am missing some configurations in the RestApi initializer?

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-apigatewayRelated to Amazon API GatewaybugThis issue is a bug.effort/smallSmall work item – less than a day of effortp2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions