Interface CreateRouteRequest.Builder

All Superinterfaces:
ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>, SdkBuilder<CreateRouteRequest.Builder,CreateRouteRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateRouteRequest
@Mutable @NotThreadSafe public static interface CreateRouteRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

  • Method Details

    • apiId

      CreateRouteRequest.Builder apiId(String apiId)

      The API identifier.

      Parameters:
      apiId - The API identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKeyRequired

      CreateRouteRequest.Builder apiKeyRequired(Boolean apiKeyRequired)

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

      Parameters:
      apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizationScopes

      CreateRouteRequest.Builder authorizationScopes(Collection<String> authorizationScopes)

      The authorization scopes supported by this route.

      Parameters:
      authorizationScopes - The authorization scopes supported by this route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizationScopes

      CreateRouteRequest.Builder authorizationScopes(String... authorizationScopes)

      The authorization scopes supported by this route.

      Parameters:
      authorizationScopes - The authorization scopes supported by this route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizationType

      CreateRouteRequest.Builder authorizationType(String authorizationType)

      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.

      Parameters:
      authorizationType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizationType

      CreateRouteRequest.Builder authorizationType(AuthorizationType authorizationType)

      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.

      Parameters:
      authorizationType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizerId

      CreateRouteRequest.Builder authorizerId(String authorizerId)

      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.

      Parameters:
      authorizerId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelSelectionExpression

      CreateRouteRequest.Builder modelSelectionExpression(String modelSelectionExpression)

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

      Parameters:
      modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationName

      CreateRouteRequest.Builder operationName(String operationName)

      The operation name for the route.

      Parameters:
      operationName - The operation name for the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestModels

      CreateRouteRequest.Builder requestModels(Map<String,String> requestModels)

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

      Parameters:
      requestModels - The request models for the route. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestParameters

      CreateRouteRequest.Builder requestParameters(Map<String,ParameterConstraints> requestParameters)

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

      Parameters:
      requestParameters - The request parameters for the route. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeKey

      CreateRouteRequest.Builder routeKey(String routeKey)

      The route key for the route.

      Parameters:
      routeKey - The route key for the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeResponseSelectionExpression

      CreateRouteRequest.Builder routeResponseSelectionExpression(String routeResponseSelectionExpression)

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

      Parameters:
      routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      CreateRouteRequest.Builder target(String target)

      The target for the route.

      Parameters:
      target - The target for the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateRouteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateRouteRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.