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< ? identitySources, Input<String> ?>AuthorizerJwtConfiguration?> ? jwtConfiguration, Input<String?> ? name, Input<String?> ? region}) -
Creates a new AuthorizerState.
apiIdAPI identifier.authorizerCredentialsArnRequired credentials as an IAM role for API Gateway to invoke the authorizer. Supported only forREQUESTauthorizers.authorizerPayloadFormatVersionFormat of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values:1.0,2.0.authorizerResultTtlInSecondsTime 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 to300. Supported only for HTTP API Lambda authorizers.authorizerTypeAuthorizer type. Valid values:JWT,REQUEST. SpecifyREQUESTfor a Lambda function using incoming request parameters. For HTTP APIs, specifyJWTto use JSON Web Tokens.authorizerUriAuthorizer's URI. ForREQUESTauthorizers this must be a well-formed Lambda function URI, such as theinvokeArnattribute of theaws.lambda.Functionresource. Supported only forREQUESTauthorizers. Must be between 1 and 2048 characters in length.enableSimpleResponsesWhether 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.identitySourcesIdentity sources for which authorization is requested. ForREQUESTauthorizers the value is a list of one or more mapping expressions of the specified request parameters. ForJWTauthorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests.jwtConfigurationConfiguration of a JWT authorizer. Required for theJWTauthorizer type. Supported only for HTTP APIs. SeejwtConfigurationBlock below.nameName of the authorizer. Must be between 1 and 128 characters in length.regionRegion 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
-
Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for
REQUESTauthorizers.final -
Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values:
1.0,2.0.final -
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 -
Authorizer type. Valid values:
JWT,REQUEST. SpecifyREQUESTfor a Lambda function using incoming request parameters. For HTTP APIs, specifyJWTto use JSON Web Tokens.final -
Authorizer's URI. For
REQUESTauthorizers this must be a well-formed Lambda function URI, such as theinvokeArnattribute of theaws.lambda.Functionresource. Supported only forREQUESTauthorizers. 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
REQUESTauthorizers the value is a list of one or more mapping expressions of the specified request parameters. ForJWTauthorizers 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
JWTauthorizer type. Supported only for HTTP APIs. SeejwtConfigurationBlock 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