AuthorizerCredentials |
String
|
Required: No. The credentials required for the authorizer. To specify an AWS Identity and Access Management (IAM) role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To use resource-based permissions on the AWS Lambda (Lambda) function, specify null.Update requires: No interruption |
AuthorizerResultTtlInSeconds |
Number
|
Required: No. The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour.Update requires: No interruption |
AuthorizerUri |
String
|
Required: Yes. The authorizer's Uniform Resource Identifier (URI). If you specify TOKEN for the authorizer's Type property, specify a Lambda function URI, which has the form arn:aws:apigateway:region:lambda:path/path. The path usually has the form /2015-03-31/functions/LambdaFunctionARN/invocations.Update requires: No interruption |
IdentitySource |
String
|
Required: Yes. The source of the identity in an incoming request. If you specify TOKEN for the authorizer's Type property, specify a mapping expression. The custom header mapping expression has the form method.request.header.name, where name is the name of a custom authorization header that clients submit as part of their requests.Update requires: No interruption |
IdentityValidationExpression |
String
|
Required: No. A validation expression for the incoming identity. If you specify TOKEN for the authorizer's Type property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code.Update requires: No interruption |
Name |
String
|
Required: Yes. The name of the authorizer.Update requires: No interruption |
RestApiId |
String
|
Required: No. The ID of the RestApi resource in which API Gateway creates the authorizer.Update requires: Replacement |
Type |
String
|
Required: Yes. The type of the authorizer, such as TOKEN.Update requires: No interruption |