@Generated(value="software.amazon.awssdk:codegen") public class Authorizer extends Object implements StructuredPojo, ToCopyableBuilder<Authorizer.Builder,Authorizer>
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Modifier and Type | Class and Description |
---|---|
static interface |
Authorizer.Builder |
Modifier and Type | Method and Description |
---|---|
String |
authorizerCredentials()
Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer.
|
Integer |
authorizerResultTtlInSeconds()
The TTL in seconds of cached authorizer results.
|
String |
authorizerUri()
Specifies the authorizer's Uniform Resource Identifier (URI).
|
String |
authType()
Optional customer-defined field, used in Swagger imports and exports without functional impact.
|
static Authorizer.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
id()
The identifier for the authorizer resource.
|
String |
identitySource()
The identity source for which authorization is requested.
|
String |
identityValidationExpression()
A validation expression for the incoming identity token.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
name()
[Required] The name of the authorizer.
|
List<String> |
providerARNs()
A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS authorizer. |
static Class<? extends Authorizer.Builder> |
serializableBuilderClass() |
Authorizer.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
AuthorizerType |
type()
[Required] The authorizer type.
|
String |
typeString()
[Required] The authorizer type.
|
copy
public String id()
The identifier for the authorizer resource.
public String name()
[Required] The name of the authorizer.
public 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.
If the service returns an enum value that is not available in the current SDK version, type
will return
AuthorizerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
public String typeString()
[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.
If the service returns an enum value that is not available in the current SDK version, type
will return
AuthorizerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public String authType()
Optional customer-defined field, used in Swagger imports and exports without functional impact.
public 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
.
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
.public 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.
public 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.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.public 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.
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.public 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.
public Authorizer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Authorizer.Builder,Authorizer>
public static Authorizer.Builder builder()
public static Class<? extends Authorizer.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.