CreateRouteRequest ¶

class CreateRouteRequest(TypedDict, closed=True):
    api_id: "capo_apigatewayv2.types.__string.__string"
    """<p>The API identifier.</p>"""
    api_key_required: NotRequired["capo_apigatewayv2.types.__boolean.__boolean"]
    """<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>"""
    authorization_scopes: NotRequired[
        "capo_apigatewayv2.types.authorization_scopes.AuthorizationScopes"
    ]
    """<p>The authorization scopes supported by this route.</p>"""
    authorization_type: NotRequired[
        "capo_apigatewayv2.types.authorization_type.AuthorizationType"
    ]
    """<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>"""
    authorizer_id: NotRequired["capo_apigatewayv2.types.id.Id"]
    """<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>"""
    model_selection_expression: NotRequired[
        "capo_apigatewayv2.types.selection_expression.SelectionExpression"
    ]
    """<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>"""
    operation_name: NotRequired[
        "capo_apigatewayv2.types.string_with_length_between1_and64.StringWithLengthBetween1And64"
    ]
    """<p>The operation name for the route.</p>"""
    request_models: NotRequired["capo_apigatewayv2.types.route_models.RouteModels"]
    """<p>The request models for the route. Supported only for WebSocket APIs.</p>"""
    request_parameters: NotRequired[
        "capo_apigatewayv2.types.route_parameters.RouteParameters"
    ]
    """<p>The request parameters for the route. Supported only for WebSocket APIs.</p>"""
    route_key: NotRequired["capo_apigatewayv2.types.selection_key.SelectionKey"]
    """<p>The route key for the route.</p>"""
    route_response_selection_expression: NotRequired[
        "capo_apigatewayv2.types.selection_expression.SelectionExpression"
    ]
    """<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>"""
    target: NotRequired[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ]
    """<p>The target for the route.</p>"""