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

RouteArgs

data class RouteArgs(val apiId: Output<String>? = null, val apiKeyRequired: Output<Boolean>? = null, val authorizationScopes: Output<List<String>>? = null, val authorizationType: Output<String>? = null, val authorizerId: Output<String>? = null, val modelSelectionExpression: Output<String>? = null, val operationName: Output<String>? = null, val requestModels: Output<Any>? = null, val requestParameters: Output<List<RouteParameterConstraintsArgs>>? = null, val routeKey: Output<String>? = null, val routeResponseSelectionExpression: Output<String>? = null, val target: Output<String>? = null) : ConvertibleToJava<RouteArgs>

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

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, apiKeyRequired: Output<Boolean>? = null, authorizationScopes: Output<List<String>>? = null, authorizationType: Output<String>? = null, authorizerId: Output<String>? = null, modelSelectionExpression: Output<String>? = null, operationName: Output<String>? = null, requestModels: Output<Any>? = null, requestParameters: Output<List<RouteParameterConstraintsArgs>>? = null, routeKey: Output<String>? = null, routeResponseSelectionExpression: Output<String>? = null, target: Output<String>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

The API identifier.

Link copied to clipboard
val apiKeyRequired: Output<Boolean>? = null

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

Link copied to clipboard
val authorizationScopes: Output<List<String>>? = null

The authorization scopes supported by this route.

Link copied to clipboard
val authorizationType: Output<String>? = null

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.

Link copied to clipboard
val authorizerId: Output<String>? = null

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.

Link copied to clipboard
val modelSelectionExpression: Output<String>? = null

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

Link copied to clipboard
val operationName: Output<String>? = null

The operation name for the route.

Link copied to clipboard
val requestModels: Output<Any>? = null

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.

Link copied to clipboard
val requestParameters: Output<List<RouteParameterConstraintsArgs>>? = null

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

Link copied to clipboard
val routeKey: Output<String>? = null

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`.

Link copied to clipboard
val routeResponseSelectionExpression: Output<String>? = null

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

Link copied to clipboard
val target: Output<String>? = null

The target for the route.

Functions

Link copied to clipboard
open override fun toJava(): RouteArgs