HttpStageProps

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

Bases: aws_cdk.aws_apigatewayv2.HttpStageOptions

(experimental) Properties to initialize an instance of HttpStage.

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

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

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

Stability

experimental

Example:

# api is of type HttpApi


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

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]

http_api

(experimental) The HTTP API to which this stage is associated.

Stability

experimental

Return type

IHttpApi

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]