Package com.pulumi.aws.apigatewayv2

Class RouteArgs

  • public final class RouteArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RouteArgs.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static RouteArgs Empty  

    • Field Detail

    • Method Detail

      • apiId

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

      • apiKeyRequired

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> apiKeyRequired()
        Returns:
        Whether an API key is required for the route. Defaults to `false`. Supported only for WebSocket APIs.

      • authorizationScopes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> authorizationScopes()
        Returns:
        Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.

      • authorizationType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizationType()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerId()
        Returns:
        Identifier of the `aws.apigatewayv2.Authorizer` resource to be associated with this route.

      • modelSelectionExpression

        public java.util.Optional<com.pulumi.core.Output<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. Supported only for WebSocket APIs.

      • operationName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> operationName()
        Returns:
        Operation name for the route. Must be between 1 and 64 characters in length.

      • region

        public java.util.Optional<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.

      • requestModels

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestModels()
        Returns:
        Request models for the route. Supported only for WebSocket APIs.

      • requestParameters

        public java.util.Optional<com.pulumi.core.Output<java.util.List<RouteRequestParameterArgs>>> requestParameters()
        Returns:
        Request parameters for the route. Supported only for WebSocket APIs. See `requestParameter` Block below.

      • routeKey

        public com.pulumi.core.Output<java.lang.String> routeKey()
        Returns:
        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

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

      • target

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> target()
        Returns:
        Target for the route, of the form `integrations/`*`IntegrationID`*, where *`IntegrationID`* is the identifier of an `aws.apigatewayv2.Integration` resource.