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

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

Parameters

api_id (str) – (deprecated) AWS::ApiGatewayV2::Route.ApiId.
route_key (str) – (deprecated) AWS::ApiGatewayV2::Route.RouteKey.
api_key_required (Union[bool, IResolvable, None]) – (deprecated) AWS::ApiGatewayV2::Route.ApiKeyRequired.
authorization_scopes (Optional[Sequence[str]]) – (deprecated) AWS::ApiGatewayV2::Route.AuthorizationScopes.
authorization_type (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.AuthorizationType.
authorizer_id (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.AuthorizerId.
model_selection_expression (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.ModelSelectionExpression.
operation_name (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.OperationName.
request_models (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Route.RequestModels.
request_parameters (Optional[Any]) – (deprecated) AWS::ApiGatewayV2::Route.RequestParameters.
route_response_selection_expression (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.
target (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Route.Target.

Deprecated

moved to package aws-apigatewayv2

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.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

# request_models: Any
# request_parameters: Any

cfn_route_v2_props = apigateway.CfnRouteV2Props(
    api_id="apiId",
    route_key="routeKey",

    # the properties below are optional
    api_key_required=False,
    authorization_scopes=["authorizationScopes"],
    authorization_type="authorizationType",
    authorizer_id="authorizerId",
    model_selection_expression="modelSelectionExpression",
    operation_name="operationName",
    request_models=request_models,
    request_parameters=request_parameters,
    route_response_selection_expression="routeResponseSelectionExpression",
    target="target"
)

Attributes

api_id¶

(deprecated) AWS::ApiGatewayV2::Route.ApiId.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid
Stability: deprecated
Return type: str

api_key_required¶

(deprecated) AWS::ApiGatewayV2::Route.ApiKeyRequired.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
Stability: deprecated
Return type: Union[bool, IResolvable, None]

authorization_scopes¶

(deprecated) AWS::ApiGatewayV2::Route.AuthorizationScopes.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes
Stability: deprecated
Return type: Optional[List[str]]

authorization_type¶

(deprecated) AWS::ApiGatewayV2::Route.AuthorizationType.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype
Stability: deprecated
Return type: Optional[str]

authorizer_id¶

(deprecated) AWS::ApiGatewayV2::Route.AuthorizerId.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid
Stability: deprecated
Return type: Optional[str]

model_selection_expression¶

(deprecated) AWS::ApiGatewayV2::Route.ModelSelectionExpression.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression
Stability: deprecated
Return type: Optional[str]

operation_name¶

(deprecated) AWS::ApiGatewayV2::Route.OperationName.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname
Stability: deprecated
Return type: Optional[str]

request_models¶

(deprecated) AWS::ApiGatewayV2::Route.RequestModels.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels
Stability: deprecated
Return type: Any

request_parameters¶

(deprecated) AWS::ApiGatewayV2::Route.RequestParameters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters
Stability: deprecated
Return type: Any

route_key¶

(deprecated) AWS::ApiGatewayV2::Route.RouteKey.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey
Stability: deprecated
Return type: str

route_response_selection_expression¶

(deprecated) AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression
Stability: deprecated
Return type: Optional[str]

target¶

(deprecated) AWS::ApiGatewayV2::Route.Target.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target
Stability: deprecated
Return type: Optional[str]