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

[junnkim]

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:

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

[khushail]

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 -

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

[junnkim]

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

[khushail]

Happy to help! I am closing this one now!

[github-actions]

⚠️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]

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.