CfnStageProps

class aws_cdk.aws_apigatewayv2.CfnStageProps(*, api_id, stage_name, access_log_settings=None, access_policy_id=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

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, AccessLogSettingsProperty, None]) – AWS::ApiGatewayV2::Stage.AccessLogSettings.

  • access_policy_id (Optional[str]) – AWS::ApiGatewayV2::Stage.AccessPolicyId.

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

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

  • default_route_settings (Union[IResolvable, RouteSettingsProperty, None]) – 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.

Link

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

Attributes

access_log_settings

AWS::ApiGatewayV2::Stage.AccessLogSettings.

Link

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

Return type

Union[IResolvable, AccessLogSettingsProperty, None]

access_policy_id

AWS::ApiGatewayV2::Stage.AccessPolicyId.

Link

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

Return type

Optional[str]

api_id

AWS::ApiGatewayV2::Stage.ApiId.

Link

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

Return type

str

auto_deploy

AWS::ApiGatewayV2::Stage.AutoDeploy.

Link

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

Return type

Union[bool, IResolvable, None]

client_certificate_id

AWS::ApiGatewayV2::Stage.ClientCertificateId.

Link

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.

Link

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

Return type

Union[IResolvable, RouteSettingsProperty, None]

deployment_id

AWS::ApiGatewayV2::Stage.DeploymentId.

Link

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

Return type

Optional[str]

description

AWS::ApiGatewayV2::Stage.Description.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Return type

Any