pulumi-aws-native-kotlin/com.pulumi.awsnative.apigatewayv2.kotlin.outputs/GetRouteResult

GetRouteResult

data class GetRouteResult(val apiKeyRequired: Boolean? = null, val authorizationScopes: List<String>? = null, val authorizationType: String? = null, val modelSelectionExpression: String? = null, val operationName: String? = null, val requestModels: Any? = null, val routeId: String? = null, val routeKey: String? = null, val routeResponseSelectionExpression: String? = null, val target: String? = null)

Constructors

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiKeyRequired: Boolean? = null

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

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

The authorization scopes supported by this route.

Link copied to clipboard
val authorizationType: 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 modelSelectionExpression: String? = null

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

Link copied to clipboard
val operationName: String? = null

The operation name for the route.

Link copied to clipboard
val requestModels: 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 routeId: String? = null

The route ID.

Link copied to clipboard
val routeKey: 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: String? = null

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

Link copied to clipboard
val target: String? = null

The target for the route.