AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::Authorizer

ApiGateway Authorizer

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.

Properties

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

Filter:
PropertyTypeFlags
Name
string
Required
RestApiId
string
RequiredCreate-only
Type
string
Required
AuthorizerCredentials
string
AuthorizerResultTtlInSeconds
integer
AuthorizerUri
string
AuthType
string
IdentitySource
string
IdentityValidationExpression
string
ProviderARNs
Array<string>

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::ApiGateway::Authorizer

Resources:
  MyResource:
    Type: AWS::ApiGateway::Authorizer
    Properties:
      RestApiId: "my-restapiid"
      Type: "value"
      Name: "my-name"

Required IAM Permissions

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

create

apigateway:POSTiam:PassRole

read

apigateway:GET

update

apigateway:GETapigateway:PATCHiam:PassRole

delete

apigateway:DELETE

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties11
Required3
TaggingNot supported
Primary IDRestApiId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

RestApiId

Related Resources

External Links