Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Authorizer = Authorizer' {}
- newAuthorizer :: Authorizer
- authorizer_authType :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)
- authorizer_authorizerUri :: Lens' Authorizer (Maybe Text)
- authorizer_id :: Lens' Authorizer (Maybe Text)
- authorizer_identitySource :: Lens' Authorizer (Maybe Text)
- authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text)
- authorizer_name :: Lens' Authorizer (Maybe Text)
- authorizer_providerARNs :: Lens' Authorizer (Maybe [Text])
- authorizer_type :: Lens' Authorizer (Maybe AuthorizerType)
Documentation
data Authorizer Source #
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
See: newAuthorizer
smart constructor.
Authorizer' | |
|
Instances
newAuthorizer :: Authorizer Source #
Create a value of Authorizer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authType:Authorizer'
, authorizer_authType
- Optional customer-defined field, used in OpenAPI imports and exports
without functional impact.
$sel:authorizerCredentials:Authorizer'
, authorizer_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.
$sel:authorizerResultTtlInSeconds:Authorizer'
, authorizer_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.
$sel:authorizerUri:Authorizer'
, authorizer_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
.
$sel:id:Authorizer'
, authorizer_id
- The identifier for the authorizer resource.
$sel:identitySource:Authorizer'
, authorizer_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.
$sel:identityValidationExpression:Authorizer'
, authorizer_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.
$sel:name:Authorizer'
, authorizer_name
- The name of the authorizer.
$sel:providerARNs:Authorizer'
, authorizer_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.
$sel:type':Authorizer'
, authorizer_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.
authorizer_authType :: Lens' Authorizer (Maybe Text) Source #
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #
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.
authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #
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
.
authorizer_id :: Lens' Authorizer (Maybe Text) Source #
The identifier for the authorizer resource.
authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_name :: Lens' Authorizer (Maybe Text) Source #
The name of the authorizer.
authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #
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.
authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #
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.