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

__init__(*, 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)

Properties for defining a AWS::ApiGatewayV2::Stage.

Parameters

  • api_id (str) – AWS::ApiGatewayV2::Stage.ApiId.

  • stage_name (str) – AWS::ApiGatewayV2::Stage.StageName.

  • access_log_settings (Union[IResolvable, None, AccessLogSettingsProperty]) – AWS::ApiGatewayV2::Stage.AccessLogSettings.

  • auto_deploy (Union[bool, None, IResolvable]) – AWS::ApiGatewayV2::Stage.AutoDeploy.

  • client_certificate_id (Optional[str]) – AWS::ApiGatewayV2::Stage.ClientCertificateId.

  • default_route_settings (Union[IResolvable, None, RouteSettingsProperty]) – AWS::ApiGatewayV2::Stage.DefaultRouteSettings.

  • deployment_id (Optional[str]) – AWS::ApiGatewayV2::Stage.DeploymentId.

  • description (Optional[str]) – AWS::ApiGatewayV2::Stage.Description.

  • route_settings (Optional[Any]) – AWS::ApiGatewayV2::Stage.RouteSettings.

  • stage_variables (Optional[Any]) – AWS::ApiGatewayV2::Stage.StageVariables.

  • tags (Optional[Any]) – AWS::ApiGatewayV2::Stage.Tags.

deprecated :deprecated: moved to package aws-apigatewayv2

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

Attributes

access_log_settings

AWS::ApiGatewayV2::Stage.AccessLogSettings.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings stability :stability: deprecated

Return type

Union[IResolvable, None, AccessLogSettingsProperty]

api_id

AWS::ApiGatewayV2::Stage.ApiId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid stability :stability: deprecated

Return type

str

auto_deploy

AWS::ApiGatewayV2::Stage.AutoDeploy.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy stability :stability: deprecated

Return type

Union[bool, None, IResolvable]

client_certificate_id

AWS::ApiGatewayV2::Stage.ClientCertificateId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid stability :stability: deprecated

Return type

Optional[str]

default_route_settings

AWS::ApiGatewayV2::Stage.DefaultRouteSettings.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings stability :stability: deprecated

Return type

Union[IResolvable, None, RouteSettingsProperty]

deployment_id

AWS::ApiGatewayV2::Stage.DeploymentId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid stability :stability: deprecated

Return type

Optional[str]

description

AWS::ApiGatewayV2::Stage.Description.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description stability :stability: deprecated

Return type

Optional[str]

route_settings

AWS::ApiGatewayV2::Stage.RouteSettings.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings stability :stability: deprecated

Return type

Any

stage_name

AWS::ApiGatewayV2::Stage.StageName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename stability :stability: deprecated

Return type

str

stage_variables

AWS::ApiGatewayV2::Stage.StageVariables.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables stability :stability: deprecated

Return type

Any

tags

AWS::ApiGatewayV2::Stage.Tags.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags stability :stability: deprecated

Return type

Any