Skip to content

CreateAuthorizerRequest

Source code in docs_src/capo_iot/types/create_authorizer_request.py
class CreateAuthorizerRequest(TypedDict, closed=True):
    authorizer_name: "capo_iot.types.authorizer_name.AuthorizerName"
    """<p>The authorizer name.</p>"""
    authorizer_function_arn: (
        "capo_iot.types.authorizer_function_arn.AuthorizerFunctionArn"
    )
    """<p>The ARN of the authorizer's Lambda function.</p>"""
    token_key_name: NotRequired["capo_iot.types.token_key_name.TokenKeyName"]
    """<p>The name of the token key used to extract the token from the HTTP headers.</p>"""
    token_signing_public_keys: NotRequired["capo_iot.types.public_key_map.PublicKeyMap"]
    """<p>The public keys used to verify the digital signature returned by your custom authentication service.</p>"""
    status: NotRequired["capo_iot.types.authorizer_status.AuthorizerStatus"]
    """<p>The status of the create authorizer request.</p>"""
    tags: NotRequired["capo_iot.types.tag_list.TagList"]
    """<p>Metadata which can be used to manage the custom authorizer.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>"""
    signing_disabled: NotRequired["capo_iot.types.boolean_key.BooleanKey"]
    """<p>Specifies whether IoT validates the token signature in an authorization request.</p>"""
    enable_caching_for_http: NotRequired[
        "capo_iot.types.enable_caching_for_http.EnableCachingForHttp"
    ]
    """<p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p> <p>The default value is <code>false</code>.</p>"""

authorizer_function_arn instance-attribute

authorizer_function_arn: AuthorizerFunctionArn

The ARN of the authorizer's Lambda function.

authorizer_name instance-attribute

authorizer_name: AuthorizerName

The authorizer name.

enable_caching_for_http instance-attribute

enable_caching_for_http: NotRequired[EnableCachingForHttp]

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

signing_disabled instance-attribute

signing_disabled: NotRequired[BooleanKey]

Specifies whether IoT validates the token signature in an authorization request.

status instance-attribute

status: NotRequired[AuthorizerStatus]

The status of the create authorizer request.

tags instance-attribute

tags: NotRequired[TagList]

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

token_key_name instance-attribute

token_key_name: NotRequired[TokenKeyName]

The name of the token key used to extract the token from the HTTP headers.

token_signing_public_keys instance-attribute

token_signing_public_keys: NotRequired[PublicKeyMap]

The public keys used to verify the digital signature returned by your custom authentication service.