Class RequestAuthorizerProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for RequestAuthorizer.

public class RequestAuthorizerProps : IRequestAuthorizerProps, ILambdaAuthorizerProps

Inheritance

object

RequestAuthorizerProps

Implements

IRequestAuthorizerProps

ILambdaAuthorizerProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

Function authFn;
            Resource books;


            var auth = new RequestAuthorizer(this, "booksAuthorizer", new RequestAuthorizerProps {
                Handler = authFn,
                IdentitySources = new [] { IdentitySource.Header("Authorization") }
            });

            books.AddMethod("GET", new HttpIntegration("http://amazon.com"), new MethodOptions {
                Authorizer = auth
            });

Remarks

ExampleMetadata: infused

Constructors

RequestAuthorizerProps()

public RequestAuthorizerProps()

Properties

AssumeRole

An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.

public IRole? AssumeRole { get; set; }

Property Value

IRole

Remarks

The IAM role must be assumable by 'apigateway.amazonaws.com'.

Default: - A resource policy is added to the Lambda function allowing apigateway.amazonaws.com to invoke the function.

AuthorizerName

An optional human friendly name for the authorizer.

public string? AuthorizerName { get; set; }

Property Value

string

Remarks

Note that, this is not the primary identifier of the authorizer.

Default: - the unique construcrt ID

Handler

The handler for the authorizer lambda function.

public IFunction Handler { get; set; }

Property Value

IFunction

Remarks

The handler must follow a very specific protocol on the input it receives and the output it needs to produce. API Gateway has documented the handler's input specification {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.

IdentitySources

An array of request header mapping expressions for identities.

public string[] IdentitySources { get; set; }

Property Value

string[]

Remarks

Supported parameter types are Header, Query String, Stage Variable, and Context. For instance, extracting an authorization token from a header would use the identity source IdentitySource.header('Authorizer').

Note: API Gateway uses the specified identity sources as the request authorizer caching key. When caching is enabled, API Gateway calls the authorizer's Lambda function only after successfully verifying that all the specified identity sources are present at runtime. If a specified identify source is missing, null, or empty, API Gateway returns a 401 Unauthorized response without calling the authorizer Lambda function.

See: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource

ResultsCacheTtl

How long APIGateway should cache the results.

public Duration? ResultsCacheTtl { get; set; }

Property Value

Duration

Remarks

Max 1 hour. Disable caching by setting this to 0.

Default: Duration.minutes(5)