latest--aws-apigateway-authorizer

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-authorizer.json
Parent schema serverless-framework-configuration
Type: object

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git

Properties

RestApiId string | Aws_CF_FunctionString required

The identifier of the API.

Name string | Aws_CF_FunctionString required

The name of the authorizer.

Type string | Aws_CF_FunctionString required

The authorizer type.

AuthType string | Aws_CF_FunctionString

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

AuthorizerCredentials string | Aws_CF_FunctionString

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

AuthorizerResultTtlInSeconds integer

The TTL in seconds of cached authorizer results.

AuthorizerUri string | Aws_CF_FunctionString

Specifies the authorizer's Uniform Resource Identifier (URI).

IdentitySource string | Aws_CF_FunctionString

The identity source for which authorization is requested.

IdentityValidationExpression string | Aws_CF_FunctionString

A validation expression for the incoming identity token.

ProviderARNs string[]

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

uniqueItems=true