Package com.pulumi.aws.apigatewayv2

Class RouteResponse

  • public class RouteResponse
extends com.pulumi.resources.CustomResource
    Manages an Amazon API Gateway Version 2 route response. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html). ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.apigatewayv2.RouteResponse;
 import com.pulumi.aws.apigatewayv2.RouteResponseArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new RouteResponse("example", RouteResponseArgs.builder()
             .apiId(exampleAwsApigatewayv2Api.id())
             .routeId(exampleAwsApigatewayv2Route.id())
             .routeResponseKey("$default")
             .build());
 
     }
 }
    > **Note:** For WebSocket routes requiring two-way communication, add an `aws.apigatewayv2.RouteResponse` to the route with `routeResponseKey = "$default"`. Only the `$default` route response is supported. Use an integration response to manipulate backend responses — see [Overview of integration responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html#apigateway-websocket-api-integration-response-overview). ## Import Using `pulumi import`, import `aws.apigatewayv2.RouteResponse` using the API identifier, route identifier and route response identifier. For example: ```sh $ pulumi import aws:apigatewayv2/routeResponse:RouteResponse example aabbccddee/1122334/998877 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> apiId()  
      static RouteResponse get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RouteResponseState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> modelSelectionExpression()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> responseModels()  
      com.pulumi.core.Output<java.lang.String> routeId()  
      com.pulumi.core.Output<java.lang.String> routeResponseKey()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RouteResponse

        public RouteResponse​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • RouteResponse

        public RouteResponse​(java.lang.String name,
                     RouteResponseArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • RouteResponse

        public RouteResponse​(java.lang.String name,
                     RouteResponseArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        API identifier.

      • modelSelectionExpression

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> modelSelectionExpression()
        Returns:
        [Model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route response.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • responseModels

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> responseModels()
        Returns:
        Response models for the route response.

      • routeId

        public com.pulumi.core.Output<java.lang.String> routeId()
        Returns:
        Identifier of the `aws.apigatewayv2.Route`.

      • routeResponseKey

        public com.pulumi.core.Output<java.lang.String> routeResponseKey()
        Returns:
        Route response key.

      • get

        public static RouteResponse get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                RouteResponseState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.