public static interface UpdateAuthorizerResponse.Builder extends APIGatewayResponse.Builder, CopyableBuilder<UpdateAuthorizerResponse.Builder,UpdateAuthorizerResponse>
Modifier and Type | Method and Description |
---|---|
UpdateAuthorizerResponse.Builder |
authorizerCredentials(String authorizerCredentials)
Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer.
|
UpdateAuthorizerResponse.Builder |
authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The TTL in seconds of cached authorizer results.
|
UpdateAuthorizerResponse.Builder |
authorizerUri(String authorizerUri)
Specifies the authorizer's Uniform Resource Identifier (URI).
|
UpdateAuthorizerResponse.Builder |
authType(String authType)
Optional customer-defined field, used in Swagger imports and exports without functional impact.
|
UpdateAuthorizerResponse.Builder |
id(String id)
The identifier for the authorizer resource.
|
UpdateAuthorizerResponse.Builder |
identitySource(String identitySource)
The identity source for which authorization is requested.
|
UpdateAuthorizerResponse.Builder |
identityValidationExpression(String identityValidationExpression)
A validation expression for the incoming identity token.
|
UpdateAuthorizerResponse.Builder |
name(String name)
[Required] The name of the authorizer.
|
UpdateAuthorizerResponse.Builder |
providerARNs(Collection<String> providerARNs)
A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS authorizer. |
UpdateAuthorizerResponse.Builder |
providerARNs(String... providerARNs)
A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS authorizer. |
UpdateAuthorizerResponse.Builder |
type(AuthorizerType type)
[Required] The authorizer type.
|
UpdateAuthorizerResponse.Builder |
type(String type)
[Required] The authorizer type.
|
build
copy
apply, build
UpdateAuthorizerResponse.Builder id(String id)
The identifier for the authorizer resource.
id
- The identifier for the authorizer resource.UpdateAuthorizerResponse.Builder name(String name)
[Required] The name of the authorizer.
name
- [Required] The name of the authorizer.UpdateAuthorizerResponse.Builder type(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.
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.AuthorizerType
,
AuthorizerType
UpdateAuthorizerResponse.Builder type(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.
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.AuthorizerType
,
AuthorizerType
UpdateAuthorizerResponse.Builder providerARNs(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.
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.UpdateAuthorizerResponse.Builder providerARNs(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.
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.UpdateAuthorizerResponse.Builder authType(String authType)
Optional customer-defined field, used in Swagger imports and exports without functional impact.
authType
- Optional customer-defined field, used in Swagger imports and exports without functional impact.UpdateAuthorizerResponse.Builder authorizerUri(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
.
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
.UpdateAuthorizerResponse.Builder authorizerCredentials(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.
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.UpdateAuthorizerResponse.Builder identitySource(String identitySource)
The identity source for which authorization is requested.
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
.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.COGNITO_USER_POOLS
authorizer, this property is not used.identitySource
- The identity source for which authorization is requested.
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
.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.COGNITO_USER_POOLS
authorizer, this property is not used.UpdateAuthorizerResponse.Builder identityValidationExpression(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.
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.UpdateAuthorizerResponse.Builder authorizerResultTtlInSeconds(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.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.