AuthorizerState class

Input properties used for looking up and filtering Authorizer resources.

Constructors

AuthorizerState({Input<String?>? arn, Input<String?>? authorizerCredentials, Input<int?>? authorizerResultTtlInSeconds, Input<String?>? authorizerUri, Input<String?>? identitySource, Input<String?>? identityValidationExpression, Input<String?>? name, Input<List<String>?>? providerArns, Input<String?>? region, Input? restApi, Input<String?>? type})
Creates a new AuthorizerState. arn ARN of the API Gateway Authorizer authorizerCredentials Credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN. authorizerResultTtlInSeconds TTL of cached authorizer results in seconds. Defaults to 300. authorizerUri Authorizer's URI. This must be a well-formed Lambda function URI in the form of arn:aws:apigateway:{region}:lambda:path/{service_api}, e.g., arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations identitySource Source of the identity in an incoming request. Defaults to method.request.header.Authorization. For REQUEST type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g., "method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName" identityValidationExpression Validation expression for the incoming identity. For TOKEN type, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response. name Name of the authorizer providerArns List of the Amazon Cognito user pool ARNs. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. restApi ID of the associated REST API type Type of the authorizer. Possible values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, or COGNITO_USER_POOLS for using an Amazon Cognito user pool. Defaults to TOKEN.
const
AuthorizerState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the API Gateway Authorizer
final
authorizerCredentials → Input<String?>?
Credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.
final
authorizerResultTtlInSeconds → Input<int?>?
TTL of cached authorizer results in seconds. Defaults to 300.
final
authorizerUri → Input<String?>?
Authorizer's URI. This must be a well-formed Lambda function URI in the form of arn:aws:apigateway:{region}:lambda:path/{service_api}, e.g., arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations
final
hashCode → int
The hash code for this object.
no setterinherited
identitySource → Input<String?>?
Source of the identity in an incoming request. Defaults to method.request.header.Authorization. For REQUEST type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g., "method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"
final
identityValidationExpression → Input<String?>?
Validation expression for the incoming identity. For TOKEN type, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
final
name → Input<String?>?
Name of the authorizer
final
providerArns → Input<List<String>?>?
List of the Amazon Cognito user pool ARNs. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
restApi → Input?
ID of the associated REST API
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → Input<String?>?
Type of the authorizer. Possible values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, or COGNITO_USER_POOLS for using an Amazon Cognito user pool. Defaults to TOKEN.
final

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