AuthorizerState class

Input properties used for looking up and filtering Authorizer resources.

Constructors

AuthorizerState({Input<String?>? apiId, Input<String?>? authorizerCredentialsArn, Input<String?>? authorizerPayloadFormatVersion, Input<int?>? authorizerResultTtlInSeconds, Input<String?>? authorizerType, Input<String?>? authorizerUri, Input<bool?>? enableSimpleResponses, Input<List<String>?>? identitySources, Input<AuthorizerJwtConfiguration?>? jwtConfiguration, Input<String?>? name, Input<String?>? region})
Creates a new AuthorizerState. apiId API identifier. authorizerCredentialsArn Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for REQUEST authorizers. authorizerPayloadFormatVersion Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values: 1.0, 2.0. authorizerResultTtlInSeconds 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. Defaults to 300. Supported only for HTTP API Lambda authorizers. authorizerType Authorizer type. Valid values: JWT, REQUEST. Specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens. authorizerUri Authorizer's URI. For REQUEST authorizers this must be a well-formed Lambda function URI, such as the invokeArn attribute of the aws.lambda.Function resource. Supported only for REQUEST authorizers. Must be between 1 and 2048 characters in length. enableSimpleResponses 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. identitySources Identity sources for which authorization is requested. For REQUEST authorizers the value is a list of one or more mapping expressions of the specified request parameters. For JWT authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests. jwtConfiguration Configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. See jwtConfiguration Block below. name Name of the authorizer. Must be between 1 and 128 characters in length. region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
const
AuthorizerState.fromMap(Map<String, dynamic> map)
factory

Properties

apiId → Input<String?>?
API identifier.
final
authorizerCredentialsArn → Input<String?>?
Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for REQUEST authorizers.
final
authorizerPayloadFormatVersion → Input<String?>?
Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values: 1.0, 2.0.
final
authorizerResultTtlInSeconds → Input<int?>?
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. Defaults to 300. Supported only for HTTP API Lambda authorizers.
final
authorizerType → Input<String?>?
Authorizer type. Valid values: JWT, REQUEST. Specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
final
authorizerUri → Input<String?>?
Authorizer's URI. For REQUEST authorizers this must be a well-formed Lambda function URI, such as the invokeArn attribute of the aws.lambda.Function resource. Supported only for REQUEST authorizers. Must be between 1 and 2048 characters in length.
final
enableSimpleResponses → Input<bool?>?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
identitySources → Input<List<String>?>?
Identity sources for which authorization is requested. For REQUEST authorizers the value is a list of one or more mapping expressions of the specified request parameters. For JWT authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests.
final
jwtConfiguration → Input<AuthorizerJwtConfiguration?>?
Configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. See jwtConfiguration Block below.
final
name → Input<String?>?
Name of the authorizer. Must be between 1 and 128 characters in length.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited