CfnRouteV2Props

class aws_cdk.aws_apigateway.CfnRouteV2Props(*, api_id, route_key, api_key_required=None, authorization_scopes=None, authorization_type=None, authorizer_id=None, model_selection_expression=None, operation_name=None, request_models=None, request_parameters=None, route_response_selection_expression=None, target=None)

Bases: object

__init__(*, api_id, route_key, api_key_required=None, authorization_scopes=None, authorization_type=None, authorizer_id=None, model_selection_expression=None, operation_name=None, request_models=None, request_parameters=None, route_response_selection_expression=None, target=None)

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

Parameters
  • api_id (str) – AWS::ApiGatewayV2::Route.ApiId.

  • route_key (str) – AWS::ApiGatewayV2::Route.RouteKey.

  • api_key_required (Union[bool, None, IResolvable]) – AWS::ApiGatewayV2::Route.ApiKeyRequired.

  • authorization_scopes (Optional[List[str]]) – AWS::ApiGatewayV2::Route.AuthorizationScopes.

  • authorization_type (Optional[str]) – AWS::ApiGatewayV2::Route.AuthorizationType.

  • authorizer_id (Optional[str]) – AWS::ApiGatewayV2::Route.AuthorizerId.

  • model_selection_expression (Optional[str]) – AWS::ApiGatewayV2::Route.ModelSelectionExpression.

  • operation_name (Optional[str]) – AWS::ApiGatewayV2::Route.OperationName.

  • request_models (Optional[Any]) – AWS::ApiGatewayV2::Route.RequestModels.

  • request_parameters (Optional[Any]) – AWS::ApiGatewayV2::Route.RequestParameters.

  • route_response_selection_expression (Optional[str]) – AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.

  • target (Optional[str]) – AWS::ApiGatewayV2::Route.Target.

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

Attributes

api_id

AWS::ApiGatewayV2::Route.ApiId.

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

Return type

str

api_key_required

AWS::ApiGatewayV2::Route.ApiKeyRequired.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired

Return type

Union[bool, None, IResolvable]

authorization_scopes

AWS::ApiGatewayV2::Route.AuthorizationScopes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes

Return type

Optional[List[str]]

authorization_type

AWS::ApiGatewayV2::Route.AuthorizationType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype

Return type

Optional[str]

authorizer_id

AWS::ApiGatewayV2::Route.AuthorizerId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid

Return type

Optional[str]

model_selection_expression

AWS::ApiGatewayV2::Route.ModelSelectionExpression.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression

Return type

Optional[str]

operation_name

AWS::ApiGatewayV2::Route.OperationName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname

Return type

Optional[str]

request_models

AWS::ApiGatewayV2::Route.RequestModels.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels

Return type

Any

request_parameters

AWS::ApiGatewayV2::Route.RequestParameters.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters

Return type

Any

route_key

AWS::ApiGatewayV2::Route.RouteKey.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey

Return type

str

route_response_selection_expression

AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression

Return type

Optional[str]

target

AWS::ApiGatewayV2::Route.Target.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target

Return type

Optional[str]