AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::Authorizer

ApiGatewayV2 Authorizer

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*.

Properties

11 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
AuthorizerType
string
Required
Name
string
Required
AuthorizerCredentialsArn
string
Write-only
AuthorizerPayloadFormatVersion
string
Write-only
AuthorizerResultTtlInSeconds
integer
Write-only
AuthorizerUri
string
Write-only
EnableSimpleResponses
boolean
Write-only
IdentitySource
Array<string>
IdentityValidationExpression
string
JwtConfiguration
JWTConfiguration

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AuthorizerIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::Authorizer

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::Authorizer
    Properties:
      AuthorizerType: "value"
      ApiId: "my-apiid"
      Name: "my-name"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTiam:PassRole

update

apigateway:PATCHapigateway:GETapigateway:PUTiam:PassRole

read

apigateway:GET

delete

apigateway:GETapigateway:DELETE

list

apigateway:GET

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2
Properties12
Required3
TaggingNot supported
Primary IDAuthorizerId

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ApiId

Related Resources

External Links