CfnStageV2Props

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

Bases: object

__init__(*, api_id, deployment_id, stage_name, access_log_settings=None, client_certificate_id=None, default_route_settings=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.

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

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

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

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

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

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

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

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

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

Return type

str

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

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

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

Return type

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

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

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

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

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

Return type

Any