HttpStageProps

class aws_cdk.aws_apigatewayv2.HttpStageProps(*, auto_deploy=None, domain_mapping=None, throttle=None, stage_name=None, http_api)

Bases: HttpStageOptions

Properties to initialize an instance of HttpStage.

Parameters:

  • auto_deploy (Optional[bool]) – Whether updates to an API automatically trigger a new deployment. Default: false

  • 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.

  • http_api (IHttpApi) – The HTTP API to which this stage is associated.

ExampleMetadata:

infused

Example:

# api: apigwv2.HttpApi


apigwv2.HttpStage(self, "Stage",
    http_api=api,
    stage_name="beta"
)

Attributes

auto_deploy

Whether updates to an API automatically trigger a new deployment.

Default:

false

domain_mapping

The options for custom domain and api mapping.

Default:

  • no custom domain and api mapping configuration

http_api

The HTTP API to which this stage is associated.

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