com.amazonaws.services.apigateway.model

Class UpdateAuthorizerResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.UpdateAuthorizerResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateAuthorizerResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateAuthorizerResult()

Method Summary

Modifier and Type	Method and Description
UpdateAuthorizerResult	clone()
boolean	equals(Object obj)
String	getAuthorizerCredentials() Specifies the required credentials as an IAM role for Amazon 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 Swagger 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() [Required] 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() [Required] The authorizer type.
int	hashCode()
void	setAuthorizerCredentials(String authorizerCredentials) Specifies the required credentials as an IAM role for Amazon 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 Swagger 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) [Required] 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) [Required] The authorizer type.
void	setType(String type) [Required] The authorizer type.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateAuthorizerResult	withAuthorizerCredentials(String authorizerCredentials) Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer.
UpdateAuthorizerResult	withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The TTL in seconds of cached authorizer results.
UpdateAuthorizerResult	withAuthorizerUri(String authorizerUri) Specifies the authorizer's Uniform Resource Identifier (URI).
UpdateAuthorizerResult	withAuthType(String authType) Optional customer-defined field, used in Swagger imports and exports without functional impact.
UpdateAuthorizerResult	withId(String id) The identifier for the authorizer resource.
UpdateAuthorizerResult	withIdentitySource(String identitySource) The identity source for which authorization is requested.
UpdateAuthorizerResult	withIdentityValidationExpression(String identityValidationExpression) A validation expression for the incoming identity token.
UpdateAuthorizerResult	withName(String name) [Required] The name of the authorizer.
UpdateAuthorizerResult	withProviderARNs(Collection<String> providerARNs) A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
UpdateAuthorizerResult	withProviderARNs(String... providerARNs) A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
UpdateAuthorizerResult	withType(AuthorizerType type) [Required] The authorizer type.
UpdateAuthorizerResult	withType(String type) [Required] The authorizer type.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateAuthorizerResult

public UpdateAuthorizerResult()

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 UpdateAuthorizerResult 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)

[Required] The name of the authorizer.

Parameters:

name - [Required] The name of the authorizer.

getName

public String getName()

[Required] The name of the authorizer.

Returns:

[Required] The name of the authorizer.

withName

public UpdateAuthorizerResult withName(String name)

[Required] The name of the authorizer.

Parameters:

name - [Required] 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)

[Required] 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 - [Required] 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()

[Required] 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:

[Required] 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 UpdateAuthorizerResult withType(String type)

[Required] 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 - [Required] 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)

[Required] 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 - [Required] 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 UpdateAuthorizerResult withType(AuthorizerType type)

[Required] 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 - [Required] 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 UpdateAuthorizerResult 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 UpdateAuthorizerResult 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 Swagger imports and exports without functional impact.

Parameters:

authType - Optional customer-defined field, used in Swagger imports and exports without functional impact.

getAuthType

public String getAuthType()

Optional customer-defined field, used in Swagger imports and exports without functional impact.

Returns:

Optional customer-defined field, used in Swagger imports and exports without functional impact.

withAuthType

public UpdateAuthorizerResult withAuthType(String authType)

Optional customer-defined field, used in Swagger imports and exports without functional impact.

Parameters:

authType - Optional customer-defined field, used in Swagger 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 UpdateAuthorizerResult 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 Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 UpdateAuthorizerResult withAuthorizerCredentials(String authorizerCredentials)

Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon 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 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

Parameters:

identitySource - The identity source for which authorization is requested.

• For a TOKEN 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

getIdentitySource

public String getIdentitySource()

The identity source for which authorization is requested.

• For a TOKEN 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

Returns:

The identity source for which authorization is requested.

• For a TOKEN 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

withIdentitySource

public UpdateAuthorizerResult withIdentitySource(String identitySource)

The identity source for which authorization is requested.

• For a TOKEN 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

Parameters:

identitySource - The identity source for which authorization is requested.

• For a TOKEN 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.
• For a COGNITO_USER_POOLS authorizer, this property is not used.

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. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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 UpdateAuthorizerResult withIdentityValidationExpression(String identityValidationExpression)

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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 UpdateAuthorizerResult 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; useful for testing and debugging.

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 UpdateAuthorizerResult clone()

Overrides:

clone in class Object