pulumi-aws-kotlin/com.pulumi.aws.apigatewayv2.kotlin/Route

Route

class Route : KotlinCustomResource

Manages an Amazon API Gateway Version 2 route. More information can be found in the Amazon API Gateway Developer Guide for WebSocket and HTTP APIs.

Example Usage

Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Api;
import com.pulumi.aws.apigatewayv2.ApiArgs;
import com.pulumi.aws.apigatewayv2.Route;
import com.pulumi.aws.apigatewayv2.RouteArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleApi = new Api("exampleApi", ApiArgs.builder()
            .protocolType("WEBSOCKET")
            .routeSelectionExpression("$request.body.action")
            .build());
        var exampleRoute = new Route("exampleRoute", RouteArgs.builder()
            .apiId(exampleApi.id())
            .routeKey("$default")
            .build());
    }
}

HTTP Proxy Integration

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Api;
import com.pulumi.aws.apigatewayv2.ApiArgs;
import com.pulumi.aws.apigatewayv2.Integration;
import com.pulumi.aws.apigatewayv2.IntegrationArgs;
import com.pulumi.aws.apigatewayv2.Route;
import com.pulumi.aws.apigatewayv2.RouteArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleApi = new Api("exampleApi", ApiArgs.builder()
            .protocolType("HTTP")
            .build());
        var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
            .apiId(exampleApi.id())
            .integrationType("HTTP_PROXY")
            .integrationMethod("ANY")
            .integrationUri("https://example.com/{proxy}")
            .build());
        var exampleRoute = new Route("exampleRoute", RouteArgs.builder()
            .apiId(exampleApi.id())
            .routeKey("ANY /example/{proxy+}")
            .target(exampleIntegration.id().applyValue(id -> String.format("integrations/%s", id)))
            .build());
    }
}

Import

Using pulumi import, import aws_apigatewayv2_route using the API identifier and route identifier. For example:

$ pulumi import aws:apigatewayv2/route:Route example aabbccddee/1122334

->Note: The API Gateway managed route created as part of quick_create cannot be imported.

Properties

apiId

val apiId: Output<String>

API identifier.

apiKeyRequired

val apiKeyRequired: Output<Boolean>?

Boolean whether an API key is required for the route. Defaults to false. Supported only for WebSocket APIs.

authorizationScopes

val authorizationScopes: Output<List<String>>?

Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.

authorizationType

val authorizationType: Output<String>?

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. Defaults to NONE.

authorizerId

val authorizerId: Output<String>?

Identifier of the aws.apigatewayv2.Authorizer resource to be associated with this route.

val id: Output<String>

modelSelectionExpression

val modelSelectionExpression: Output<String>?

The model selection expression for the route. Supported only for WebSocket APIs.

operationName

val operationName: Output<String>?

Operation name for the route. Must be between 1 and 64 characters in length.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

requestModels

val requestModels: Output<Map<String, String>>?

Request models for the route. Supported only for WebSocket APIs.

requestParameters

val requestParameters: Output<List<RouteRequestParameter>>?

Request parameters for the route. Supported only for WebSocket APIs.

routeKey

val routeKey: Output<String>

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.

routeResponseSelectionExpression

val routeResponseSelectionExpression: Output<String>?

The route response selection expression for the route. Supported only for WebSocket APIs.

target

val target: Output<String>?

Target for the route, of the form integrations/IntegrationID, where IntegrationID is the identifier of an aws.apigatewayv2.Integration resource.

urn

val urn: Output<String>