Interface Authorizer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Authorizer.Builder,
,Authorizer> SdkBuilder<Authorizer.Builder,
,Authorizer> SdkPojo
- Enclosing class:
Authorizer
-
Method Summary
Modifier and TypeMethodDescriptionauthorizerCredentials
(String authorizerCredentials) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.authorizerResultTtlInSeconds
(Integer authorizerResultTtlInSeconds) The TTL in seconds of cached authorizer results.authorizerUri
(String authorizerUri) Specifies the authorizer's Uniform Resource Identifier (URI).Optional customer-defined field, used in OpenAPI imports and exports without functional impact.The identifier for the authorizer resource.identitySource
(String identitySource) The identity source for which authorization is requested.identityValidationExpression
(String identityValidationExpression) A validation expression for the incoming identity token.The name of the authorizer.providerARNs
(String... providerARNs) A list of the Amazon Cognito user pool ARNs for theCOGNITO_USER_POOLS
authorizer.providerARNs
(Collection<String> providerARNs) A list of the Amazon Cognito user pool ARNs for theCOGNITO_USER_POOLS
authorizer.The authorizer type.type
(AuthorizerType type) The authorizer type.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.- Parameters:
type
- The authorizer type. Valid values areTOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_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:
-
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.- Parameters:
type
- The authorizer type. Valid values areTOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_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:
-
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 aTOKEN
orREQUEST
authorizer, this is not defined.- Parameters:
providerARNs
- A list of the Amazon Cognito user pool ARNs for theCOGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 aTOKEN
orREQUEST
authorizer, this is not defined.- Parameters:
providerARNs
- A list of the Amazon Cognito user pool ARNs for theCOGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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). ForTOKEN
orREQUEST
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 formarn: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.
-
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.
-
identitySource
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
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 aTOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
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.
-
identityValidationExpression
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer.- Parameters:
identityValidationExpression
- A validation expression for the incoming identity token. ForTOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-