StageOptions

class aws_cdk.aws_apigatewayv2.StageOptions(*, auto_deploy=None, description=None, domain_mapping=None, throttle=None)

Bases: object

Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

# domain_name: apigatewayv2.DomainName

stage_options = apigatewayv2.StageOptions(
    auto_deploy=False,
    description="description",
    domain_mapping=apigatewayv2.DomainMappingOptions(
        domain_name=domain_name,

        # the properties below are optional
        mapping_key="mappingKey"
    ),
    throttle=apigatewayv2.ThrottleSettings(
        burst_limit=123,
        rate_limit=123
    )
)

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

throttle

Throttle settings for the routes of this stage.

Default:

  • no throttling configuration