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< ? providerArns, Input<String> ?>String?> ? region, Input? restApi, Input<String?> ? type}) -
Creates a new AuthorizerState.
arnARN of the API Gateway AuthorizerauthorizerCredentialsCredentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.authorizerResultTtlInSecondsTTL of cached authorizer results in seconds. Defaults to300.authorizerUriAuthorizer's URI. This must be a well-formed Lambda function URI in the form ofarn: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/invocationsidentitySourceSource of the identity in an incoming request. Defaults tomethod.request.header.Authorization. ForREQUESTtype, 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"identityValidationExpressionValidation expression for the incoming identity. ForTOKENtype, 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.nameName of the authorizerproviderArnsList of the Amazon Cognito user pool ARNs. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.restApiID of the associated REST APItypeType of the authorizer. Possible values areTOKENfor a Lambda function using a single authorization token submitted in a custom header,REQUESTfor a Lambda function using incoming request parameters, orCOGNITO_USER_POOLSfor using an Amazon Cognito user pool. Defaults toTOKEN.const -
AuthorizerState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the API Gateway Authorizer
final
-
Credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.
final
-
TTL of cached authorizer results in seconds. Defaults to
300.final -
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/invocationsfinal - 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. ForREQUESTtype, 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
TOKENtype, 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
TOKENfor a Lambda function using a single authorization token submitted in a custom header,REQUESTfor a Lambda function using incoming request parameters, orCOGNITO_USER_POOLSfor using an Amazon Cognito user pool. Defaults toTOKEN.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