AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::ApiGatewayV2::Authorizer

The AWS::ApiGatewayV2::Authorizer resource updates a Lambda authorizer function. For more information about Lambda authorizer functions for WebSocket APIs, see Create a Lambda REQUEST Authorizer Function 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, "Name" : String } }

YAML

Type: AWS::ApiGatewayV2::Authorizer Properties: ApiId: String AuthorizerCredentialsArn: String AuthorizerResultTtlInSeconds: Integer AuthorizerType: String AuthorizerUri: String IdentitySource: - String IdentityValidationExpression: String 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.

Required: No

Type: String

Update requires: No interruption

AuthorizerResultTtlInSeconds

The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, 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.

Required: No

Type: Integer

Update requires: No interruption

AuthorizerType

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

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: Yes

Type: String

Update requires: No interruption

IdentitySource

The identity source for which authorization is requested.

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.

Required: Yes

Type: List of String

Update requires: No interruption

IdentityValidationExpression

The validation expression does not apply to the REQUEST authorizer.

Required: No

Type: String

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