HttpStageOptions

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

Bases: StageOptions

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

Parameters:

  • access_log_settings (Optional[IAccessLogSettings]) – Settings for access logging. Default: - No access logging

  • 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

  • detailed_metrics_enabled (Optional[bool]) – Specifies whether detailed metrics are enabled. 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

  • stage_variables (Optional[Mapping[str, str]]) – Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables Default: - No stage variables

  • 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

access_log_settings

Settings for access logging.

Default:

  • No access logging

auto_deploy

Whether updates to an API automatically trigger a new deployment.

Default:

false

description

The description for the API stage.

Default:

  • no description

detailed_metrics_enabled

Specifies whether detailed metrics are enabled.

Default:

false

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.

stage_variables

Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

Default:

  • No stage variables

throttle

Throttle settings for the routes of this stage.

Default:

  • no throttling configuration