authorizers

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

Overview

Name	`authorizers`
Type	Resource
Description	The `AWS::ApiGatewayV2::Authorizer` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the API Gateway Developer Guide.
Id	`aws.apigatewayv2.authorizers`

Fields

Name	Datatype	Description
`identity_validation_expression`	`string`	This parameter is not used.
`authorizer_uri`	`string`	The authorizer's Uniform Resource Identifier (URI). For `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_credentials_arn`	`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. Supported only for `REQUEST` authorizers.
`authorizer_type`	`string`	The authorizer type. Specify `REQUEST` for a Lambda function using incoming request parameters. Specify `JWT` to use JSON Web Tokens (supported only for HTTP APIs).
`jwt_configuration`	`object`	The `JWTConfiguration` property specifies the configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs.
`authorizer_result_ttl_in_seconds`	`integer`	The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
`identity_source`	`array`	The identity source for which authorization is requested. For a `REQUEST` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with `$`, for example, `$request.header.Auth`, `$request.querystring.Name`. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). For `JWT`, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example `$request.header.Authorization`.
`authorizer_payload_format_version`	`string`	Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are `1.0` and `2.0`. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
`api_id`	`string`	The API identifier.
`enable_simple_responses`	`boolean`	Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
`authorizer_id`	`string`
`name`	`string`	The name of the authorizer.
`region`	`string`	AWS region.

Methods

Name	Accessible by	Required Params
`create_resource`	`INSERT`	`AuthorizerType, ApiId, 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,
identity_validation_expression,
authorizer_uri,
authorizer_credentials_arn,
authorizer_type,
jwt_configuration,
authorizer_result_ttl_in_seconds,
identity_source,
authorizer_payload_format_version,
api_id,
enable_simple_responses,
authorizer_id,
name
FROM aws.apigatewayv2.authorizers
WHERE region = 'us-east-1';

Gets all properties from an individual authorizer.

SELECT
region,
identity_validation_expression,
authorizer_uri,
authorizer_credentials_arn,
authorizer_type,
jwt_configuration,
authorizer_result_ttl_in_seconds,
identity_source,
authorizer_payload_format_version,
api_id,
enable_simple_responses,
authorizer_id,
name
FROM aws.apigatewayv2.authorizers
WHERE region = 'us-east-1' AND data__Identifier = '<AuthorizerId>|<ApiId>';

`INSERT` example

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

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO aws.apigatewayv2.authorizers (
 AuthorizerType,
 ApiId,
 Name,
 region
)
SELECT 
'{{ AuthorizerType }}',
 '{{ ApiId }}',
 '{{ Name }}',
'{{ region }}';

/*+ create */
INSERT INTO aws.apigatewayv2.authorizers (
 IdentityValidationExpression,
 AuthorizerUri,
 AuthorizerCredentialsArn,
 AuthorizerType,
 JwtConfiguration,
 AuthorizerResultTtlInSeconds,
 IdentitySource,
 AuthorizerPayloadFormatVersion,
 ApiId,
 EnableSimpleResponses,
 Name,
 region
)
SELECT 
 '{{ IdentityValidationExpression }}',
 '{{ AuthorizerUri }}',
 '{{ AuthorizerCredentialsArn }}',
 '{{ AuthorizerType }}',
 '{{ JwtConfiguration }}',
 '{{ AuthorizerResultTtlInSeconds }}',
 '{{ IdentitySource }}',
 '{{ AuthorizerPayloadFormatVersion }}',
 '{{ ApiId }}',
 '{{ EnableSimpleResponses }}',
 '{{ Name }}',
 '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: authorizer
    props:
      - name: IdentityValidationExpression
        value: '{{ IdentityValidationExpression }}'
      - name: AuthorizerUri
        value: '{{ AuthorizerUri }}'
      - name: AuthorizerCredentialsArn
        value: '{{ AuthorizerCredentialsArn }}'
      - name: AuthorizerType
        value: '{{ AuthorizerType }}'
      - name: JwtConfiguration
        value:
          Issuer: '{{ Issuer }}'
          Audience:
            - '{{ Audience[0] }}'
      - name: AuthorizerResultTtlInSeconds
        value: '{{ AuthorizerResultTtlInSeconds }}'
      - name: IdentitySource
        value:
          - '{{ IdentitySource[0] }}'
      - name: AuthorizerPayloadFormatVersion
        value: '{{ AuthorizerPayloadFormatVersion }}'
      - name: ApiId
        value: '{{ ApiId }}'
      - name: EnableSimpleResponses
        value: '{{ EnableSimpleResponses }}'
      - name: Name
        value: '{{ Name }}'

`DELETE` example

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

Permissions

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

Create

apigateway:POST,
iam:PassRole

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT,
iam:PassRole

Read

apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​

Permissions​

Create​

Update​

Read​

Delete​

List​