authorizers

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

Overview

Name	authorizers
Type	Resource
Description	Creates an authorizer.
Id	aws.iot.authorizers

Fields

Name	Datatype	Description
authorizer_function_arn	string
arn	string
authorizer_name	string
signing_disabled	boolean
status	string
token_key_name	string
token_signing_public_keys	object
enable_caching_for_http	boolean
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AuthorizerFunctionArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all authorizers in a region.

SELECT
region,
authorizer_function_arn,
arn,
authorizer_name,
signing_disabled,
status,
token_key_name,
token_signing_public_keys,
enable_caching_for_http,
tags
FROM aws.iot.authorizers
WHERE region = 'us-east-1';

Gets all properties from an individual authorizer.

SELECT
region,
authorizer_function_arn,
arn,
authorizer_name,
signing_disabled,
status,
token_key_name,
token_signing_public_keys,
enable_caching_for_http,
tags
FROM aws.iot.authorizers
WHERE region = 'us-east-1' AND data__Identifier = '<AuthorizerName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iot.authorizers (
 AuthorizerFunctionArn,
 region
)
SELECT 
'{{ AuthorizerFunctionArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iot.authorizers (
 AuthorizerFunctionArn,
 AuthorizerName,
 SigningDisabled,
 Status,
 TokenKeyName,
 TokenSigningPublicKeys,
 EnableCachingForHttp,
 Tags,
 region
)
SELECT 
 '{{ AuthorizerFunctionArn }}',
 '{{ AuthorizerName }}',
 '{{ SigningDisabled }}',
 '{{ Status }}',
 '{{ TokenKeyName }}',
 '{{ TokenSigningPublicKeys }}',
 '{{ EnableCachingForHttp }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: authorizer
    props:
      - name: AuthorizerFunctionArn
        value: '{{ AuthorizerFunctionArn }}'
      - name: AuthorizerName
        value: '{{ AuthorizerName }}'
      - name: SigningDisabled
        value: '{{ SigningDisabled }}'
      - name: Status
        value: '{{ Status }}'
      - name: TokenKeyName
        value: '{{ TokenKeyName }}'
      - name: TokenSigningPublicKeys
        value: {}
      - name: EnableCachingForHttp
        value: '{{ EnableCachingForHttp }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iot.authorizers
WHERE data__Identifier = '<AuthorizerName>'
AND region = 'us-east-1';

Permissions

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

Create

iot:CreateAuthorizer,
iot:DescribeAuthorizer,
iot:TagResource,
iot:ListTagsForResource

Read

iot:DescribeAuthorizer,
iot:ListTagsForResource

Update

iot:UpdateAuthorizer,
iot:DescribeAuthorizer,
iot:TagResource,
iot:UntagResource,
iot:ListTagsForResource

Delete

iot:UpdateAuthorizer,
iot:DeleteAuthorizer,
iot:DescribeAuthorizer

List

iot:ListAuthorizers