Skip to main content

authorizers

Creates, updates, deletes or gets an authorizer resource or lists authorizers in a region

Overview​

Nameauthorizers
TypeResource
DescriptionThe AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide.
Idawscc.apigatewayv2.authorizers

Fields​

NameDatatypeDescription
identity_validation_expressionstringThis parameter is not used.
authorizer_uristringThe authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
authorizer_credentials_arnstringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
authorizer_typestringThe authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
identity_sourcearray
The identity source for which authorization is requested.For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
▶jwt_configurationobjectThe JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
authorizer_result_ttl_in_secondsintegerThe 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. Supported only for HTTP API Lambda authorizers.
authorizer_payload_format_versionstringSpecifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with Lambda authorizers for HTTP APIs.
enable_simple_responsesbooleanSpecifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with Lambda authorizers for HTTP APIs.
api_idstringThe API identifier.
authorizer_idstring
namestringThe name of the authorizer.
regionstringAWS region.

For more information, see AWS::ApiGatewayV2::Authorizer.

Methods​

NameResourceAccessible byRequired Params
create_resourceauthorizersINSERTAuthorizerType, ApiId, Name, region
delete_resourceauthorizersDELETEIdentifier, region
update_resourceauthorizersUPDATEIdentifier, PatchDocument, region
list_resourcesauthorizers_list_onlySELECTregion
get_resourceauthorizersSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual authorizer.

SELECT
  region,
  identity_validation_expression,
  authorizer_uri,
  authorizer_credentials_arn,
  authorizer_type,
  identity_source,
  jwt_configuration,
  authorizer_result_ttl_in_seconds,
  authorizer_payload_format_version,
  enable_simple_responses,
  api_id,
  authorizer_id,
  name
FROM awscc.apigatewayv2.authorizers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ authorizer_id }}|{{ api_id }}';

INSERT example​

Use the following StackQL query and manifest file to create a new authorizer resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.apigatewayv2.authorizers (
  AuthorizerType,
  ApiId,
  Name,
  region
)
SELECT
  '{{ authorizer_type }}',
  '{{ api_id }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

Use the following StackQL query and manifest file to update a authorizer resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigatewayv2.authorizers
SET PatchDocument = string('{{ {
    "IdentityValidationExpression": identity_validation_expression,
    "AuthorizerUri": authorizer_uri,
    "AuthorizerCredentialsArn": authorizer_credentials_arn,
    "AuthorizerType": authorizer_type,
    "IdentitySource": identity_source,
    "JwtConfiguration": jwt_configuration,
    "AuthorizerResultTtlInSeconds": authorizer_result_ttl_in_seconds,
    "AuthorizerPayloadFormatVersion": authorizer_payload_format_version,
    "EnableSimpleResponses": enable_simple_responses,
    "Name": name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ authorizer_id }}|{{ api_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.apigatewayv2.authorizers
WHERE
  Identifier = '{{ authorizer_id }}|{{ api_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

To operate on the authorizers resource, the following permissions are required:

apigateway:POST,
iam:PassRole