HttpStageOptions¶

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

Bases: aws_cdk.aws_apigatewayv2.StageOptions

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

Parameters

auto_deploy (Optional[bool]) – (experimental) Whether updates to an API automatically trigger a new deployment. Default: false
domain_mapping (Optional[DomainMappingOptions]) – (experimental) The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
throttle (Optional[ThrottleSettings]) – (experimental) Throttle settings for the routes of this stage. Default: - no throttling configuration
stage_name (Optional[str]) – (experimental) 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.

Stability

experimental

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¶

(experimental) Whether updates to an API automatically trigger a new deployment.

Default: false
Stability: experimental
Return type: Optional[bool]

domain_mapping¶

(experimental) The options for custom domain and api mapping.

Default

no custom domain and api mapping configuration

Stability

experimental

Return type

Optional[DomainMappingOptions]

stage_name¶

(experimental) 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.
Stability: experimental
Return type: Optional[str]

throttle¶

(experimental) Throttle settings for the routes of this stage.

Default

no throttling configuration

Stability

experimental

Return type

Optional[ThrottleSettings]