Package com.pulumi.aws.apigatewayv2

Class RouteArgs.Builder

  • Enclosing class:
    RouteArgs
    public static final class RouteArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(RouteArgs defaults)

    • Method Detail

      • apiId

        public RouteArgs.Builder apiId​(com.pulumi.core.Output<java.lang.String> apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder

      • apiId

        public RouteArgs.Builder apiId​(java.lang.String apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder

      • apiKeyRequired

        public RouteArgs.Builder apiKeyRequired​(@Nullable
                                        com.pulumi.core.Output<java.lang.Boolean> apiKeyRequired)
        Parameters:
        apiKeyRequired - Whether an API key is required for the route. Defaults to `false`. Supported only for WebSocket APIs.
        Returns:
        builder

      • apiKeyRequired

        public RouteArgs.Builder apiKeyRequired​(java.lang.Boolean apiKeyRequired)
        Parameters:
        apiKeyRequired - Whether an API key is required for the route. Defaults to `false`. Supported only for WebSocket APIs.
        Returns:
        builder

      • authorizationScopes

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

      • authorizationScopes

        public RouteArgs.Builder authorizationScopes​(java.util.List<java.lang.String> authorizationScopes)
        Parameters:
        authorizationScopes - Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.
        Returns:
        builder

      • authorizationScopes

        public RouteArgs.Builder authorizationScopes​(java.lang.String... authorizationScopes)
        Parameters:
        authorizationScopes - Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.
        Returns:
        builder

      • authorizationType

        public RouteArgs.Builder authorizationType​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> authorizationType)
        Parameters:
        authorizationType - 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`.
        Returns:
        builder

      • authorizationType

        public RouteArgs.Builder authorizationType​(java.lang.String authorizationType)
        Parameters:
        authorizationType - 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`.
        Returns:
        builder

      • authorizerId

        public RouteArgs.Builder authorizerId​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> authorizerId)
        Parameters:
        authorizerId - Identifier of the `aws.apigatewayv2.Authorizer` resource to be associated with this route.
        Returns:
        builder

      • authorizerId

        public RouteArgs.Builder authorizerId​(java.lang.String authorizerId)
        Parameters:
        authorizerId - Identifier of the `aws.apigatewayv2.Authorizer` resource to be associated with this route.
        Returns:
        builder

      • modelSelectionExpression

        public RouteArgs.Builder modelSelectionExpression​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> modelSelectionExpression)
        Parameters:
        modelSelectionExpression - [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.
        Returns:
        builder

      • modelSelectionExpression

        public RouteArgs.Builder modelSelectionExpression​(java.lang.String modelSelectionExpression)
        Parameters:
        modelSelectionExpression - [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.
        Returns:
        builder

      • operationName

        public RouteArgs.Builder operationName​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> operationName)
        Parameters:
        operationName - Operation name for the route. Must be between 1 and 64 characters in length.
        Returns:
        builder

      • operationName

        public RouteArgs.Builder operationName​(java.lang.String operationName)
        Parameters:
        operationName - Operation name for the route. Must be between 1 and 64 characters in length.
        Returns:
        builder

      • region

        public RouteArgs.Builder region​(@Nullable
                                com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public RouteArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • requestModels

        public RouteArgs.Builder requestModels​(@Nullable
                                       com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> requestModels)
        Parameters:
        requestModels - Request models for the route. Supported only for WebSocket APIs.
        Returns:
        builder

      • requestModels

        public RouteArgs.Builder requestModels​(java.util.Map<java.lang.String,​java.lang.String> requestModels)
        Parameters:
        requestModels - Request models for the route. Supported only for WebSocket APIs.
        Returns:
        builder

      • requestParameters

        public RouteArgs.Builder requestParameters​(@Nullable
                                           com.pulumi.core.Output<java.util.List<RouteRequestParameterArgs>> requestParameters)
        Parameters:
        requestParameters - Request parameters for the route. Supported only for WebSocket APIs. See `requestParameter` Block below.
        Returns:
        builder

      • requestParameters

        public RouteArgs.Builder requestParameters​(java.util.List<RouteRequestParameterArgs> requestParameters)
        Parameters:
        requestParameters - Request parameters for the route. Supported only for WebSocket APIs. See `requestParameter` Block below.
        Returns:
        builder

      • requestParameters

        public RouteArgs.Builder requestParameters​(RouteRequestParameterArgs... requestParameters)
        Parameters:
        requestParameters - Request parameters for the route. Supported only for WebSocket APIs. See `requestParameter` Block below.
        Returns:
        builder

      • routeKey

        public RouteArgs.Builder routeKey​(com.pulumi.core.Output<java.lang.String> routeKey)
        Parameters:
        routeKey - 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`.
        Returns:
        builder

      • routeKey

        public RouteArgs.Builder routeKey​(java.lang.String routeKey)
        Parameters:
        routeKey - 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`.
        Returns:
        builder

      • routeResponseSelectionExpression

        public RouteArgs.Builder routeResponseSelectionExpression​(@Nullable
                                                          com.pulumi.core.Output<java.lang.String> routeResponseSelectionExpression)
        Parameters:
        routeResponseSelectionExpression - [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.
        Returns:
        builder

      • routeResponseSelectionExpression

        public RouteArgs.Builder routeResponseSelectionExpression​(java.lang.String routeResponseSelectionExpression)
        Parameters:
        routeResponseSelectionExpression - [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.
        Returns:
        builder

      • target

        public RouteArgs.Builder target​(@Nullable
                                com.pulumi.core.Output<java.lang.String> target)
        Parameters:
        target - Target for the route, of the form `integrations/`*`IntegrationID`*, where *`IntegrationID`* is the identifier of an `aws.apigatewayv2.Integration` resource.
        Returns:
        builder

      • target

        public RouteArgs.Builder target​(java.lang.String target)
        Parameters:
        target - Target for the route, of the form `integrations/`*`IntegrationID`*, where *`IntegrationID`* is the identifier of an `aws.apigatewayv2.Integration` resource.
        Returns:
        builder