authorizers

Creates, updates, deletes or gets an authorizer resource or lists authorizers in a region

Overview

Name	authorizers
Type	Resource
Description	The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Id	aws.apigateway.authorizers

Fields

Name	Datatype	Description
rest_api_id	string	The string identifier of the associated RestApi.
authorizer_id	string
auth_type	string	Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_credentials	string	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_result_ttl_in_seconds	integer	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_uri	string	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.
identity_source	string	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.
identity_validation_expression	string	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.
name	string	The name of the authorizer.
provider_arns	array	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.
type	string	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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RestApiId, Type, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all authorizers in a region.

SELECT
region,
rest_api_id,
authorizer_id,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
name,
provider_arns,
type
FROM aws.apigateway.authorizers
WHERE region = 'us-east-1';

Gets all properties from an individual authorizer.

SELECT
region,
rest_api_id,
authorizer_id,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
name,
provider_arns,
type
FROM aws.apigateway.authorizers
WHERE region = 'us-east-1' AND data__Identifier = '<RestApiId>|<AuthorizerId>';

INSERT example

Use the following StackQL query and manifest file to create a new authorizer resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.apigateway.authorizers (
 RestApiId,
 Name,
 Type,
 region
)
SELECT 
'{{ RestApiId }}',
 '{{ Name }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.authorizers (
 RestApiId,
 AuthType,
 AuthorizerCredentials,
 AuthorizerResultTtlInSeconds,
 AuthorizerUri,
 IdentitySource,
 IdentityValidationExpression,
 Name,
 ProviderARNs,
 Type,
 region
)
SELECT 
 '{{ RestApiId }}',
 '{{ AuthType }}',
 '{{ AuthorizerCredentials }}',
 '{{ AuthorizerResultTtlInSeconds }}',
 '{{ AuthorizerUri }}',
 '{{ IdentitySource }}',
 '{{ IdentityValidationExpression }}',
 '{{ Name }}',
 '{{ ProviderARNs }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: authorizer
    props:
      - name: RestApiId
        value: '{{ RestApiId }}'
      - name: AuthType
        value: '{{ AuthType }}'
      - name: AuthorizerCredentials
        value: '{{ AuthorizerCredentials }}'
      - name: AuthorizerResultTtlInSeconds
        value: '{{ AuthorizerResultTtlInSeconds }}'
      - name: AuthorizerUri
        value: '{{ AuthorizerUri }}'
      - name: IdentitySource
        value: '{{ IdentitySource }}'
      - name: IdentityValidationExpression
        value: '{{ IdentityValidationExpression }}'
      - name: Name
        value: '{{ Name }}'
      - name: ProviderARNs
        value:
          - '{{ ProviderARNs[0] }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigateway.authorizers
WHERE data__Identifier = '<RestApiId|AuthorizerId>'
AND region = 'us-east-1';

Permissions

To operate on the authorizers resource, the following permissions are required:

Create

apigateway:POST,
iam:PassRole

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH,
iam:PassRole

Delete

apigateway:DELETE

List

apigateway:GET