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

Route

class Route : KotlinCustomResource

The `AWS::ApiGatewayV2::Route` resource creates a route for an API.

Properties

apiId

val apiId: Output<String>

The API identifier.

apiKeyRequired

val apiKeyRequired: Output<Boolean>?

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

authorizationScopes

val authorizationScopes: Output<List<String>>?

The authorization scopes supported by this route.

authorizationType

val authorizationType: Output<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.

authorizerId

val authorizerId: Output<String>?

The identifier of the `Authorizer` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

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>?

The operation name for the route.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

requestModels

val requestModels: Output<Any>?

The request models for the route. Supported only for WebSocket APIs. Search the CloudFormation User Guide for AWS::ApiGatewayV2::Route for more information about the expected schema for this property.

requestParameters

val requestParameters: Output<List<RouteParameterConstraints>>?

The request parameters for the route. Supported only for WebSocket APIs.

routeId

val routeId: Output<String>

The route ID.

routeKey

val routeKey: Output<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`.

routeResponseSelectionExpression

val routeResponseSelectionExpression: Output<String>?

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

target

val target: Output<String>?

The target for the route.

urn

val urn: Output<String>