Package software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateAuthorizerResponse.Builder

All Superinterfaces:
ApiGatewayV2Response.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<UpdateAuthorizerResponse.Builder,UpdateAuthorizerResponse>, SdkBuilder<UpdateAuthorizerResponse.Builder,UpdateAuthorizerResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
UpdateAuthorizerResponse
public static interface UpdateAuthorizerResponse.Builder extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<UpdateAuthorizerResponse.Builder,UpdateAuthorizerResponse>

  • Method Details

    • authorizerCredentialsArn

      UpdateAuthorizerResponse.Builder authorizerCredentialsArn(String authorizerCredentialsArn)

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

      Parameters:
      authorizerCredentialsArn - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizerId

      UpdateAuthorizerResponse.Builder authorizerId(String authorizerId)

      The authorizer identifier.

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

    • authorizerPayloadFormatVersion

      UpdateAuthorizerResponse.Builder authorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      Parameters:
      authorizerPayloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizerResultTtlInSeconds

      UpdateAuthorizerResponse.Builder authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

      Parameters:
      authorizerResultTtlInSeconds - The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizerType

      UpdateAuthorizerResponse.Builder authorizerType(String authorizerType)

      The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

      Parameters:
      authorizerType - The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizerType

      UpdateAuthorizerResponse.Builder authorizerType(AuthorizerType authorizerType)

      The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

      Parameters:
      authorizerType - The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizerUri

      UpdateAuthorizerResponse.Builder authorizerUri(String authorizerUri)

      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda :us-west-2:{account_id }:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

      Parameters:
      authorizerUri - The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions /arn:aws:lambda:us-west-2:{account_id }:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/ {service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableSimpleResponses

      UpdateAuthorizerResponse.Builder enableSimpleResponses(Boolean enableSimpleResponses)

      Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

      Parameters:
      enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identitySource

      UpdateAuthorizerResponse.Builder identitySource(Collection<String> identitySource)

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      Parameters:
      identitySource - The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identitySource

      UpdateAuthorizerResponse.Builder identitySource(String... identitySource)

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      Parameters:
      identitySource - The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityValidationExpression

      UpdateAuthorizerResponse.Builder identityValidationExpression(String identityValidationExpression)

      The validation expression does not apply to the REQUEST authorizer.

      Parameters:
      identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jwtConfiguration

      UpdateAuthorizerResponse.Builder jwtConfiguration(JWTConfiguration jwtConfiguration)

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      Parameters:
      jwtConfiguration - Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jwtConfiguration

      default UpdateAuthorizerResponse.Builder jwtConfiguration(Consumer<JWTConfiguration.Builder> jwtConfiguration)

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      This is a convenience method that creates an instance of the JWTConfiguration.Builder avoiding the need to create one manually via JWTConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jwtConfiguration(JWTConfiguration).

      Parameters:
      jwtConfiguration - a consumer that will call methods on JWTConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      UpdateAuthorizerResponse.Builder name(String name)

      The name of the authorizer.

      Parameters:
      name - The name of the authorizer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.