@pulumi/aws-native/apigatewayv2/getRoute.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
/**
 * The ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.
 */
export declare function getRoute(args: GetRouteArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteResult>;
export interface GetRouteArgs {
    /**
     * The API identifier.
     */
    apiId: string;
    /**
     * The route ID.
     */
    routeId: string;
}
export interface GetRouteResult {
    /**
     * Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
     */
    readonly apiKeyRequired?: boolean;
    /**
     * The authorization scopes supported by this route.
     */
    readonly authorizationScopes?: string[];
    /**
     * 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.
     */
    readonly authorizationType?: string;
    /**
     * The model selection expression for the route. Supported only for WebSocket APIs.
     */
    readonly modelSelectionExpression?: string;
    /**
     * The operation name for the route.
     */
    readonly operationName?: string;
    /**
     * The request models for the route. Supported only for WebSocket APIs.
     *
     * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.
     */
    readonly requestModels?: any;
    /**
     * The route ID.
     */
    readonly routeId?: string;
    /**
     * The route key for the route. For HTTP APIs, the route key can be either ``$default``, or a combination of an HTTP method and resource path, for example, ``GET /pets``.
     */
    readonly routeKey?: string;
    /**
     * The route response selection expression for the route. Supported only for WebSocket APIs.
     */
    readonly routeResponseSelectionExpression?: string;
    /**
     * The target for the route.
     */
    readonly target?: string;
}
/**
 * The ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.
 */
export declare function getRouteOutput(args: GetRouteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouteResult>;
export interface GetRouteOutputArgs {
    /**
     * The API identifier.
     */
    apiId: pulumi.Input<string>;
    /**
     * The route ID.
     */
    routeId: pulumi.Input<string>;
}