Authorizer class

Represents an authorizer.

Constructors

Authorizer({required String name, String? authorizerCredentialsArn, String? authorizerId, String? authorizerPayloadFormatVersion, int? authorizerResultTtlInSeconds, AuthorizerType? authorizerType, String? authorizerUri, bool? enableSimpleResponses, List<String>? identitySource, String? identityValidationExpression, JWTConfiguration? jwtConfiguration})

Authorizer.fromJson(Map<String, dynamic> json)

factory

Properties

authorizerCredentialsArn → String?

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, don't specify this parameter. Supported only for REQUEST authorizers.

final

authorizerId → String?

The authorizer identifier.

final

authorizerPayloadFormatVersion → String?

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

final

authorizerResultTtlInSeconds → int?

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

final

authorizerType → AuthorizerType?

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

final

authorizerUri → String?

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::function:/invocations. In general, the URI has this form: arn:aws:apigateway::lambda:path/ , 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. Supported only for REQUEST authorizers.

final

enableSimpleResponses → bool?

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

final

hashCode → int

The hash code for this object.

no setter, inherited

identitySource → List<String>?

The identity source for which authorization is requested.

final

identityValidationExpression → String?

The validation expression does not apply to the REQUEST authorizer.

final

jwtConfiguration → JWTConfiguration?

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

final

name → String

The name of the authorizer.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited