@pulumi/aws-native
Version:
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)
65 lines (64 loc) • 2.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* The ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
*/
export declare function getRouteResponse(args: GetRouteResponseArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteResponseResult>;
export interface GetRouteResponseArgs {
/**
* The API identifier.
*/
apiId: string;
/**
* The route ID.
*/
routeId: string;
/**
* The route response ID.
*/
routeResponseId: string;
}
export interface GetRouteResponseResult {
/**
* The model selection expression for the route response. Supported only for WebSocket APIs.
*/
readonly modelSelectionExpression?: string;
/**
* The response models for the route response.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.
*/
readonly responseModels?: any;
/**
* The route response parameters.
*/
readonly responseParameters?: {
[key: string]: outputs.apigatewayv2.RouteResponseParameterConstraints;
};
/**
* The route response ID.
*/
readonly routeResponseId?: string;
/**
* The route response key.
*/
readonly routeResponseKey?: string;
}
/**
* The ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
*/
export declare function getRouteResponseOutput(args: GetRouteResponseOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouteResponseResult>;
export interface GetRouteResponseOutputArgs {
/**
* The API identifier.
*/
apiId: pulumi.Input<string>;
/**
* The route ID.
*/
routeId: pulumi.Input<string>;
/**
* The route response ID.
*/
routeResponseId: pulumi.Input<string>;
}