Authorizer (AWS Java SDK for Amazon API Gateway 1.12.347 API)

java.lang.Object
- com.amazonaws.services.apigateway.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 authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

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`	`getAuthorizerCredentials()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`Integer`	`getAuthorizerResultTtlInSeconds()` The TTL in seconds of cached authorizer results.
`String`	`getAuthorizerUri()` Specifies the authorizer's Uniform Resource Identifier (URI).
`String`	`getAuthType()` Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
`String`	`getId()` The identifier for the authorizer resource.
`String`	`getIdentitySource()` The identity source for which authorization is requested.
`String`	`getIdentityValidationExpression()` A validation expression for the incoming identity token.
`String`	`getName()` The name of the authorizer.
`List<String>`	`getProviderARNs()` A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
`String`	`getType()` The authorizer type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAuthorizerCredentials(String authorizerCredentials)` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`void`	`setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The TTL in seconds of cached authorizer results.
`void`	`setAuthorizerUri(String authorizerUri)` Specifies the authorizer's Uniform Resource Identifier (URI).
`void`	`setAuthType(String authType)` Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
`void`	`setId(String id)` The identifier for the authorizer resource.
`void`	`setIdentitySource(String identitySource)` The identity source for which authorization is requested.
`void`	`setIdentityValidationExpression(String identityValidationExpression)` A validation expression for the incoming identity token.
`void`	`setName(String name)` The name of the authorizer.
`void`	`setProviderARNs(Collection<String> providerARNs)` A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
`void`	`setType(AuthorizerType type)` The authorizer type.
`void`	`setType(String type)` The authorizer type.
`String`	`toString()` Returns a string representation of this object.
`Authorizer`	`withAuthorizerCredentials(String authorizerCredentials)` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`Authorizer`	`withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)` The TTL in seconds of cached authorizer results.
`Authorizer`	`withAuthorizerUri(String authorizerUri)` Specifies the authorizer's Uniform Resource Identifier (URI).
`Authorizer`	`withAuthType(String authType)` Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
`Authorizer`	`withId(String id)` The identifier for the authorizer resource.
`Authorizer`	`withIdentitySource(String identitySource)` The identity source for which authorization is requested.
`Authorizer`	`withIdentityValidationExpression(String identityValidationExpression)` A validation expression for the incoming identity token.
`Authorizer`	`withName(String name)` The name of the authorizer.
`Authorizer`	`withProviderARNs(Collection<String> providerARNs)` A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
`Authorizer`	`withProviderARNs(String... providerARNs)` A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
`Authorizer`	`withType(AuthorizerType type)` The authorizer type.
`Authorizer`	`withType(String type)` The authorizer type.

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

- Constructor Detail
  - Authorizer
```
public Authorizer()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier for the authorizer resource.
    
    Parameters:
    
    id - The identifier for the authorizer resource.
  - getId
```
public String getId()
```
    The identifier for the authorizer resource.
    
    Returns:
    
    The identifier for the authorizer resource.
  - withId
```
public Authorizer withId(String id)
```
    The identifier for the authorizer resource.
    
    Parameters:
    
    id - The identifier for the authorizer resource.
    
    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.
  - setType
```
public void setType(String type)
```
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Parameters:
    
    type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    See Also:
    
    AuthorizerType
  - getType
```
public String getType()
```
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Returns:
    
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    See Also:
    
    AuthorizerType
  - withType
```
public Authorizer withType(String type)
```
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Parameters:
    
    type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerType
  - setType
```
public void setType(AuthorizerType type)
```
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Parameters:
    
    type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    See Also:
    
    AuthorizerType
  - withType
```
public Authorizer withType(AuthorizerType type)
```
    The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Parameters:
    
    type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthorizerType
  - getProviderARNs
```
public List<String> getProviderARNs()
```
    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    Returns:
    
    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
  - setProviderARNs
```
public void setProviderARNs(Collection<String> providerARNs)
```
    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    Parameters:
    
    providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
  - withProviderARNs
```
public Authorizer withProviderARNs(String... providerARNs)
```
    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    NOTE: This method appends the values to the existing list (if any). Use setProviderARNs(java.util.Collection) or withProviderARNs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withProviderARNs
```
public Authorizer withProviderARNs(Collection<String> providerARNs)
```
    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    Parameters:
    
    providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthType
```
public void setAuthType(String authType)
```
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    
    Parameters:
    
    authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
  - getAuthType
```
public String getAuthType()
```
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    
    Returns:
    
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
  - withAuthType
```
public Authorizer withAuthType(String authType)
```
    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    
    Parameters:
    
    authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerUri
```
public void setAuthorizerUri(String authorizerUri)
```
    Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
    
    Parameters:
    
    authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
  - getAuthorizerUri
```
public String getAuthorizerUri()
```
    Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
    
    Returns:
    
    Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
  - withAuthorizerUri
```
public Authorizer withAuthorizerUri(String authorizerUri)
```
    Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
    
    Parameters:
    
    authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizerCredentials
```
public void setAuthorizerCredentials(String authorizerCredentials)
```
    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, specify null.
    
    Parameters:
    
    authorizerCredentials - 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, specify null.
  - getAuthorizerCredentials
```
public String getAuthorizerCredentials()
```
    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, specify null.
    
    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, specify null.
  - withAuthorizerCredentials
```
public Authorizer withAuthorizerCredentials(String authorizerCredentials)
```
    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, specify null.
    
    Parameters:
    
    authorizerCredentials - 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, specify null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentitySource
```
public void setIdentitySource(String identitySource)
```
    The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    
    Parameters:
    
    identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
  - getIdentitySource
```
public String getIdentitySource()
```
    The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    
    Returns:
    
    The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
  - withIdentitySource
```
public Authorizer withIdentitySource(String identitySource)
```
    The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    
    Parameters:
    
    identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityValidationExpression
```
public void setIdentityValidationExpression(String identityValidationExpression)
```
    A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    
    Parameters:
    
    identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
  - getIdentityValidationExpression
```
public String getIdentityValidationExpression()
```
    A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    
    Returns:
    
    A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
  - withIdentityValidationExpression
```
public Authorizer withIdentityValidationExpression(String identityValidationExpression)
```
    A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    
    Parameters:
    
    identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. 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.
  - setAuthorizerResultTtlInSeconds
```
public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
```
    The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
    
    Parameters:
    
    authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
  - getAuthorizerResultTtlInSeconds
```
public Integer getAuthorizerResultTtlInSeconds()
```
    The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
    
    Returns:
    
    The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
  - withAuthorizerResultTtlInSeconds
```
public Authorizer withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
```
    The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
    
    Parameters:
    
    authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Authorizer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Authorizer

Method Detail

setId

getId

withId

setName

getName

withName

setType

getType

withType

setType

withType

getProviderARNs

setProviderARNs

withProviderARNs

withProviderARNs

setAuthType

getAuthType

withAuthType

setAuthorizerUri

getAuthorizerUri

withAuthorizerUri

setAuthorizerCredentials

getAuthorizerCredentials

withAuthorizerCredentials

setIdentitySource

getIdentitySource

withIdentitySource

setIdentityValidationExpression

getIdentityValidationExpression

withIdentityValidationExpression

setAuthorizerResultTtlInSeconds

getAuthorizerResultTtlInSeconds

withAuthorizerResultTtlInSeconds

toString

equals

hashCode

clone

marshall