Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. getRouteResponse

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getRouteResponse

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    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 in the API Gateway Developer Guide.

    Using getRouteResponse

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRouteResponse(args: GetRouteResponseArgs, opts?: InvokeOptions): Promise<GetRouteResponseResult>
function getRouteResponseOutput(args: GetRouteResponseOutputArgs, opts?: InvokeOptions): Output<GetRouteResponseResult>
    def get_route_response(api_id: Optional[str] = None,
                       route_id: Optional[str] = None,
                       route_response_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRouteResponseResult
def get_route_response_output(api_id: Optional[pulumi.Input[str]] = None,
                       route_id: Optional[pulumi.Input[str]] = None,
                       route_response_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRouteResponseResult]
    func LookupRouteResponse(ctx *Context, args *LookupRouteResponseArgs, opts ...InvokeOption) (*LookupRouteResponseResult, error)
func LookupRouteResponseOutput(ctx *Context, args *LookupRouteResponseOutputArgs, opts ...InvokeOption) LookupRouteResponseResultOutput

    > Note: This function is named LookupRouteResponse in the Go SDK.

    public static class GetRouteResponse 
{
    public static Task<GetRouteResponseResult> InvokeAsync(GetRouteResponseArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResponseResult> Invoke(GetRouteResponseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteResponseResult> getRouteResponse(GetRouteResponseArgs args, InvokeOptions options)
public static Output<GetRouteResponseResult> getRouteResponse(GetRouteResponseArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigatewayv2:getRouteResponse
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiId string
    The API identifier.
    RouteId string
    The route ID.
    RouteResponseId string
    The route response ID.
    ApiId string
    The API identifier.
    RouteId string
    The route ID.
    RouteResponseId string
    The route response ID.
    apiId String
    The API identifier.
    routeId String
    The route ID.
    routeResponseId String
    The route response ID.
    apiId string
    The API identifier.
    routeId string
    The route ID.
    routeResponseId string
    The route response ID.
    api_id str
    The API identifier.
    route_id str
    The route ID.
    route_response_id str
    The route response ID.
    apiId String
    The API identifier.
    routeId String
    The route ID.
    routeResponseId String
    The route response ID.

    getRouteResponse Result

    The following output properties are available:

    ModelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    ResponseModels object

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    ResponseParameters Dictionary<string, Pulumi.AwsNative.ApiGatewayV2.Outputs.RouteResponseParameterConstraints>
    The route response parameters.
    RouteResponseId string
    The route response ID.
    RouteResponseKey string
    The route response key.
    ModelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    ResponseModels interface{}

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    ResponseParameters map[string]RouteResponseParameterConstraints
    The route response parameters.
    RouteResponseId string
    The route response ID.
    RouteResponseKey string
    The route response key.
    modelSelectionExpression String
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels Object

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters Map<String,RouteResponseParameterConstraints>
    The route response parameters.
    routeResponseId String
    The route response ID.
    routeResponseKey String
    The route response key.
    modelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels any

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters {[key: string]: RouteResponseParameterConstraints}
    The route response parameters.
    routeResponseId string
    The route response ID.
    routeResponseKey string
    The route response key.
    model_selection_expression str
    The model selection expression for the route response. Supported only for WebSocket APIs.
    response_models Any

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    response_parameters Mapping[str, RouteResponseParameterConstraints]
    The route response parameters.
    route_response_id str
    The route response ID.
    route_response_key str
    The route response key.
    modelSelectionExpression String
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels Any

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters Map<Property Map>
    The route response parameters.
    routeResponseId String
    The route response ID.
    routeResponseKey String
    The route response key.

    Supporting Types

    RouteResponseParameterConstraints

    Required bool
    Specifies whether the parameter is required.
    Required bool
    Specifies whether the parameter is required.
    required Boolean
    Specifies whether the parameter is required.
    required boolean
    Specifies whether the parameter is required.
    required bool
    Specifies whether the parameter is required.
    required Boolean
    Specifies whether the parameter is required.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native