CfnStageV2Props

class aws_cdk.aws_apigateway.CfnStageV2Props(*, api_id, stage_name, access_log_settings=None, auto_deploy=None, client_certificate_id=None, default_route_settings=None, deployment_id=None, description=None, route_settings=None, stage_variables=None, tags=None)

Bases: object

(deprecated) Properties for defining a AWS::ApiGatewayV2::Stage.

Parameters:

api_id (str) – (deprecated) AWS::ApiGatewayV2::Stage.ApiId.
stage_name (str) – (deprecated) AWS::ApiGatewayV2::Stage.StageName.
access_log_settings (Union[IResolvable, AccessLogSettingsProperty, Dict[str, Any], None]) – (deprecated) AWS::ApiGatewayV2::Stage.AccessLogSettings.
auto_deploy (Union[bool, IResolvable, None]) – (deprecated) AWS::ApiGatewayV2::Stage.AutoDeploy.
client_certificate_id (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Stage.ClientCertificateId.
default_route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None]) – (deprecated) AWS::ApiGatewayV2::Stage.DefaultRouteSettings.
deployment_id (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Stage.DeploymentId.
description (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Stage.Description.
route_settings (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Stage.RouteSettings.
stage_variables (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Stage.StageVariables.
tags (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Stage.Tags.

Deprecated:

moved to package aws-apigatewayv2

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html

Stability:

deprecated

ExampleMetadata:

fixture=_generated

Example:

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

# route_settings: Any
# stage_variables: Any
# tags: Any

cfn_stage_v2_props = apigateway.CfnStageV2Props(
    api_id="apiId",
    stage_name="stageName",

    # the properties below are optional
    access_log_settings=apigateway.CfnStageV2.AccessLogSettingsProperty(
        destination_arn="destinationArn",
        format="format"
    ),
    auto_deploy=False,
    client_certificate_id="clientCertificateId",
    default_route_settings=apigateway.CfnStageV2.RouteSettingsProperty(
        data_trace_enabled=False,
        detailed_metrics_enabled=False,
        logging_level="loggingLevel",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    ),
    deployment_id="deploymentId",
    description="description",
    route_settings=route_settings,
    stage_variables=stage_variables,
    tags=tags
)