Authorizer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigatewayv2.model.Authorizer

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Authorizer
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents an authorizer.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Authorizer()

Constructors
Constructor and Description
`Authorizer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authorizer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthorizerCredentialsArn()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`String`	`getAuthorizerId()` The authorizer identifier.
`String`	`getAuthorizerPayloadFormatVersion()` Specifies the format of the payload sent to an HTTP API Lambda authorizer.
`Integer`	`getAuthorizerResultTtlInSeconds()` The time to live (TTL) for cached authorizer results, in seconds.
`String`	`getAuthorizerType()` The authorizer type.
`String`	`getAuthorizerUri()` The authorizer's Uniform Resource Identifier (URI).
`Boolean`	`getEnableSimpleResponses()` Specifies whether a Lambda authorizer returns a response in a simple format.
`List<String>`	`getIdentitySource()` The identity source for which authorization is requested.
`String`	`getIdentityValidationExpression()` The validation expression does not apply to the REQUEST authorizer.
`JWTConfiguration`	`getJwtConfiguration()` Represents the configuration of a JWT authorizer.
`String`	`getName()` The name of the authorizer.
`int`	`hashCode()`
`Boolean`	`isEnableSimpleResponses()` Specifies whether a Lambda authorizer returns a response in a simple format.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthorizerCredentialsArn(String authorizerCredentialsArn)` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`void`	`setAuthorizerId(String authorizerId)` The authorizer identifier.
`void`	`setAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)` Specifies the format of the payload sent to an HTTP API Lambda authorizer.
`void`	`setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The time to live (TTL) for cached authorizer results, in seconds.
`void`	`setAuthorizerType(String authorizerType)` The authorizer type.
`void`	`setAuthorizerUri(String authorizerUri)` The authorizer's Uniform Resource Identifier (URI).
`void`	`setEnableSimpleResponses(Boolean enableSimpleResponses)` Specifies whether a Lambda authorizer returns a response in a simple format.
`void`	`setIdentitySource(Collection<String> identitySource)` The identity source for which authorization is requested.
`void`	`setIdentityValidationExpression(String identityValidationExpression)` The validation expression does not apply to the REQUEST authorizer.
`void`	`setJwtConfiguration(JWTConfiguration jwtConfiguration)` Represents the configuration of a JWT authorizer.
`void`	`setName(String name)` The name of the authorizer.
`String`	`toString()` Returns a string representation of this object.
`Authorizer`	`withAuthorizerCredentialsArn(String authorizerCredentialsArn)` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`Authorizer`	`withAuthorizerId(String authorizerId)` The authorizer identifier.
`Authorizer`	`withAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)` Specifies the format of the payload sent to an HTTP API Lambda authorizer.
`Authorizer`	`withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The time to live (TTL) for cached authorizer results, in seconds.
`Authorizer`	`withAuthorizerType(AuthorizerType authorizerType)` The authorizer type.
`Authorizer`	`withAuthorizerType(String authorizerType)` The authorizer type.
`Authorizer`	`withAuthorizerUri(String authorizerUri)` The authorizer's Uniform Resource Identifier (URI).
`Authorizer`	`withEnableSimpleResponses(Boolean enableSimpleResponses)` Specifies whether a Lambda authorizer returns a response in a simple format.
`Authorizer`	`withIdentitySource(Collection<String> identitySource)` The identity source for which authorization is requested.
`Authorizer`	`withIdentitySource(String... identitySource)` The identity source for which authorization is requested.
`Authorizer`	`withIdentityValidationExpression(String identityValidationExpression)` The validation expression does not apply to the REQUEST authorizer.
`Authorizer`	`withJwtConfiguration(JWTConfiguration jwtConfiguration)` Represents the configuration of a JWT authorizer.
`Authorizer`	`withName(String name)` The name of the authorizer.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Authorizer
```
public Authorizer()
```
- Method Detail
  - setAuthorizerCredentialsArn
```
public void setAuthorizerCredentialsArn(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.
  - getAuthorizerCredentialsArn
```
public String getAuthorizerCredentialsArn()
```
    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:
    
    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.
  - withAuthorizerCredentialsArn
```
public Authorizer withAuthorizerCredentialsArn(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.
  - setAuthorizerId
```
public void setAuthorizerId(String authorizerId)
```
    The authorizer identifier.
    
    Parameters:
    
    authorizerId - The authorizer identifier.
  - getAuthorizerId
```
public String getAuthorizerId()
```
    The authorizer identifier.
    
    Returns:
    
    The authorizer identifier.
  - withAuthorizerId
```
public Authorizer withAuthorizerId(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.
  - setAuthorizerPayloadFormatVersion
```
public void setAuthorizerPayloadFormatVersion(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.
  - getAuthorizerPayloadFormatVersion
```
public String getAuthorizerPayloadFormatVersion()
```
    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:
    
    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.
  - withAuthorizerPayloadFormatVersion
```
public Authorizer withAuthorizerPayloadFormatVersion(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.
  - setAuthorizerResultTtlInSeconds
```
public void setAuthorizerResultTtlInSeconds(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.
  - getAuthorizerResultTtlInSeconds
```
public Integer getAuthorizerResultTtlInSeconds()
```
    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:
    
    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.
  - withAuthorizerResultTtlInSeconds
```
public Authorizer withAuthorizerResultTtlInSeconds(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.
  - setAuthorizerType
```
public void setAuthorizerType(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).
    
    See Also:
    
    AuthorizerType
  - getAuthorizerType
```
public String getAuthorizerType()
```
    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:
    
    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).
    
    See Also:
    
    AuthorizerType
  - withAuthorizerType
```
public Authorizer withAuthorizerType(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
  - withAuthorizerType
```
public Authorizer withAuthorizerType(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:
    
    AuthorizerType
  - setAuthorizerUri
```
public void setAuthorizerUri(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.
  - getAuthorizerUri
```
public String getAuthorizerUri()
```
    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:
    
    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.
  - withAuthorizerUri
```
public Authorizer withAuthorizerUri(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.
  - setEnableSimpleResponses
```
public void setEnableSimpleResponses(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
  - getEnableSimpleResponses
```
public Boolean getEnableSimpleResponses()
```
    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:
    
    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
  - withEnableSimpleResponses
```
public Authorizer withEnableSimpleResponses(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.
  - isEnableSimpleResponses
```
public Boolean isEnableSimpleResponses()
```
    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:
    
    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
  - getIdentitySource
```
public List<String> getIdentitySource()
```
    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:
    
    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.
  - setIdentitySource
```
public void setIdentitySource(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.
  - withIdentitySource
```
public Authorizer withIdentitySource(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setIdentitySource(java.util.Collection) or withIdentitySource(java.util.Collection) if you want to override the existing values.
    
    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.
  - withIdentitySource
```
public Authorizer withIdentitySource(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.
  - setIdentityValidationExpression
```
public void setIdentityValidationExpression(String identityValidationExpression)
```
    The validation expression does not apply to the REQUEST authorizer.
    
    Parameters:
    
    identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.
  - getIdentityValidationExpression
```
public String getIdentityValidationExpression()
```
    The validation expression does not apply to the REQUEST authorizer.
    
    Returns:
    
    The validation expression does not apply to the REQUEST authorizer.
  - withIdentityValidationExpression
```
public Authorizer withIdentityValidationExpression(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.
  - setJwtConfiguration
```
public void setJwtConfiguration(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.
  - getJwtConfiguration
```
public JWTConfiguration getJwtConfiguration()
```
    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    
    Returns:
    
    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
  - withJwtConfiguration
```
public Authorizer withJwtConfiguration(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.
  - setName
```
public void setName(String name)
```
    The name of the authorizer.
    
    Parameters:
    
    name - The name of the authorizer.
  - getName
```
public String getName()
```
    The name of the authorizer.
    
    Returns:
    
    The name of the authorizer.
  - withName
```
public Authorizer withName(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Authorizer clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Authorizer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Authorizer

Method Detail

setAuthorizerCredentialsArn

getAuthorizerCredentialsArn

withAuthorizerCredentialsArn

setAuthorizerId

getAuthorizerId

withAuthorizerId

setAuthorizerPayloadFormatVersion

getAuthorizerPayloadFormatVersion

withAuthorizerPayloadFormatVersion

setAuthorizerResultTtlInSeconds

getAuthorizerResultTtlInSeconds

withAuthorizerResultTtlInSeconds

setAuthorizerType

getAuthorizerType

withAuthorizerType

withAuthorizerType

setAuthorizerUri

getAuthorizerUri

withAuthorizerUri

setEnableSimpleResponses

getEnableSimpleResponses

withEnableSimpleResponses

isEnableSimpleResponses

getIdentitySource

setIdentitySource

withIdentitySource

withIdentitySource

setIdentityValidationExpression

getIdentityValidationExpression

withIdentityValidationExpression

setJwtConfiguration

getJwtConfiguration

withJwtConfiguration

setName

getName

withName

toString

equals

hashCode

clone

marshall