HttpStageOptions

class aws_cdk.aws_apigatewayv2.HttpStageOptions(*, auto_deploy=None, description=None, domain_mapping=None, throttle=None, stage_name=None)

Bases: StageOptions

The options to create a new Stage for an HTTP API.

Parameters:

auto_deploy (Optional[bool]) – Whether updates to an API automatically trigger a new deployment. Default: false
description (Optional[str]) – The description for the API stage. Default: - no description
domain_mapping (Union[DomainMappingOptions, Dict[str, Any], None]) – The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
throttle (Union[ThrottleSettings, Dict[str, Any], None]) – Throttle settings for the routes of this stage. Default: - no throttling configuration
stage_name (Optional[str]) – The name of the stage. See StageName class for more details. Default: ‘$default’ the default stage of the API. This stage will have the URL at the root of the API endpoint.

ExampleMetadata:

infused

Example:

# api: apigwv2.HttpApi
# dn: apigwv2.DomainName


api.add_stage("beta",
    stage_name="beta",
    auto_deploy=True,
    # https://${dn.domainName}/bar goes to the beta stage
    domain_mapping=apigwv2.DomainMappingOptions(
        domain_name=dn,
        mapping_key="bar"
    )
)

Attributes

auto_deploy

Whether updates to an API automatically trigger a new deployment.

Default:: false

description

The description for the API stage.

Default:

no description

domain_mapping

The options for custom domain and api mapping.

Default:

no custom domain and api mapping configuration

stage_name

The name of the stage.

See StageName class for more details.

Default:: ‘$default’ the default stage of the API. This stage will have the URL at the root of the API endpoint.

throttle

Throttle settings for the routes of this stage.

Default:

no throttling configuration