Skip to content
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.

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

api-gateway-deployment: stage_name parameter for the L2 deployment construct is unavailable #30805

Closed
junnkim opened this issue Jul 9, 2024 · 5 comments
Assignees
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway bug This issue is a bug. package/tools Related to AWS CDK Tools or CLI response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.

Comments

@junnkim
Copy link

junnkim commented Jul 9, 2024

Describe the bug

aws-cdk-lib release v2.140 includes the addition of the stage_name parameter to the L2 deployment construct: https://github.com/aws/aws-cdk/releases/tag/v2.140.0

This parameter is also listed as available in the docs: https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_apigateway/Deployment.html

However, the param is unavailable upon import:
apig deployment params

I am on:
aws-cdk-lib==2.141.0
constructs>=10.0.0,<11.0.0

Expected Behavior

Use the stage_name parameter when utilizing the Deployment construct

Current Behavior

The stage_name param shows as unavailable

Reproduction Steps

The definition of the Deployment class is:

def __init__(
    self,
    scope: _constructs_77d1e7e8.Construct,
    id: builtins.str,
    *,
    api: "IRestApi",
    description: typing.Optional[builtins.str] = None,
    retain_deployments: typing.Optional[builtins.bool] = None,
) -> None:
    '''
    :param scope: -
    :param id: -
    :param api: The Rest API to deploy.
    :param description: A description of the purpose of the API Gateway deployment. Default: - No description.
    :param retain_deployments: When an API Gateway model is updated, a new deployment will automatically be created. If this is true, the old API Gateway Deployment resource will not be deleted. This will allow manually reverting back to a previous deployment in case for example Default: false
    '''

As you can see, there is no stage_name parameter.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.127

Framework Version

No response

Node.js Version

18.17.0

OS

Windows

Language

Python

Language Version

3.11.4

Other information

No response

@junnkim junnkim added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Jul 9, 2024
@github-actions github-actions bot added @aws-cdk/aws-apigateway Related to Amazon API Gateway package/tools Related to AWS CDK Tools or CLI labels Jul 9, 2024
@khushail khushail added needs-reproduction This issue needs reproduction. and removed needs-triage This issue or PR still needs to be triaged. labels Jul 10, 2024
@khushail khushail self-assigned this Jul 10, 2024
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-reproduction This issue needs reproduction. labels Jul 10, 2024
@khushail
Copy link
Contributor

khushail commented Jul 10, 2024

Hi @junnkim , thanks for reaching out.

I am able to see the mentioned property in code with CDK 2.141.0, please see the attached snapshot for the same -

Screenshot 2024-07-10 at 12 11 50 PM

Could you please check your CDK version and see if the issue persists ?

@khushail khushail added response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Jul 10, 2024
@junnkim
Copy link
Author

junnkim commented Jul 10, 2024

Thank you for assisting. This was indeed due to a messed virtual env on my part. I can see the parameter now.

@khushail
Copy link
Contributor

Happy to help! I am closing this one now!

Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@aws-cdk-automation
Copy link
Collaborator

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway bug This issue is a bug. package/tools Related to AWS CDK Tools or CLI response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.
Projects
None yet
Development

No branches or pull requests

3 participants