AWS::ApiGatewayV2::Authorizer - AWS CloudFormation

AWS::ApiGatewayV2::Authorizer

The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function for a WebSocket API or a JSON Web Token (JWT) authorizer for an HTTP API. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function in the API Gateway Developer Guide. For more information about JWT authorizers for HTTP APIs, see JWT authorizers in the API Gateway Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ApiGatewayV2::Authorizer", "Properties" : { "ApiId" : String, "AuthorizerCredentialsArn" : String, "AuthorizerResultTtlInSeconds" : Integer, "AuthorizerType" : String, "AuthorizerUri" : String, "IdentitySource" : [ String, ... ], "IdentityValidationExpression" : String, "JwtConfiguration" : JWTConfiguration, "Name" : String } }

YAML

Type: AWS::ApiGatewayV2::Authorizer Properties: ApiId: String AuthorizerCredentialsArn: String AuthorizerResultTtlInSeconds: Integer AuthorizerType: String AuthorizerUri: String IdentitySource: - String IdentityValidationExpression: String JwtConfiguration: JWTConfiguration Name: String

Properties

ApiId

The API identifier.

Required: Yes

Type: String

Update requires: Replacement

AuthorizerCredentialsArn

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.

Required: No

Type: String

Update requires: No interruption

AuthorizerResultTtlInSeconds

Authorizer caching is not currently supported. Don't specify this value for authorizers.

Required: No

Type: Integer

Update requires: No interruption

AuthorizerType

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

Required: Yes

Type: String

Update requires: No interruption

AuthorizerUri

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.

Required: No

Type: String

Update requires: No interruption

IdentitySource

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. Currently, 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. These parameters will be 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 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".

Required: Yes

Type: List of String

Update requires: No interruption

IdentityValidationExpression

This parameter is not used.

Required: No

Type: String

Update requires: No interruption

JwtConfiguration

The JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Required: No

Type: JWTConfiguration

Update requires: No interruption

Name

The name of the authorizer.

Required: Yes

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the authorizer's ID, such as abcde1.

For more information about using the Ref function, see Ref.

Examples

Authorizer creation example

The following example creates a Lambda authorizer resource for the MyApi API.

JSON

{ "Authorizer": { "Type": "AWS::ApiGatewayV2::Authorizer", "Properties": { "Name": "LambdaAuthorizer", "ApiId": { "Ref": "MyApi" }, "AuthorizerType": "REQUEST", "AuthorizerCredentialsArn": "Arn", "AuthorizerUri": { "Fn::Join": [ "", [ "arn:", { "Ref": "AWS::Partition" }, ":apigateway:", { "Ref": "AWS::Region" }, ":lambda:path/2015-03-31/functions/", "/invocations" ] ] }, "AuthorizerResultTtlInSeconds": 500, "IdentitySource": [ "route.request.header.Auth" ] } } }

YAML

Authorizer: Type: 'AWS::ApiGatewayV2::Authorizer' Properties: Name: LambdaAuthorizer ApiId: !Ref MyApi AuthorizerType: REQUEST AuthorizerCredentialsArn: Arn AuthorizerUri: !Join - '' - - 'arn:' - !Ref 'AWS::Partition' - ':apigateway:' - !Ref 'AWS::Region' - ':lambda:path/2015-03-31/functions/' - /invocations AuthorizerResultTtlInSeconds: 500 IdentitySource: - route.request.header.Auth

See Also