CfnAuthorizerProps
- class aws_cdk.aws_iot.CfnAuthorizerProps(*, authorizer_function_arn, authorizer_name=None, enable_caching_for_http=None, signing_disabled=None, status=None, tags=None, token_key_name=None, token_signing_public_keys=None)
Bases:
object
Properties for defining a
CfnAuthorizer
.- Parameters:
authorizer_function_arn (
str
) – The authorizer’s Lambda function ARN.authorizer_name (
Optional
[str
]) – The authorizer name.enable_caching_for_http (
Union
[bool
,IResolvable
,None
]) – Whentrue
, 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 inrefreshAfterInSeconds
. This value doesn’t affect authorization of clients that use MQTT connections.signing_disabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether AWS IoT validates the token signature in an authorization request.status (
Optional
[str
]) – The status of the authorizer. Valid values:ACTIVE
|INACTIVE
tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Metadata which can be used to manage the custom authorizer. .. epigraph:: 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 (
Optional
[str
]) – The key used to extract the token from the HTTP headers.token_signing_public_keys (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The public keys used to validate the token signature returned by your custom authentication service.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iot as iot cfn_authorizer_props = iot.CfnAuthorizerProps( authorizer_function_arn="authorizerFunctionArn", # the properties below are optional authorizer_name="authorizerName", enable_caching_for_http=False, signing_disabled=False, status="status", tags=[CfnTag( key="key", value="value" )], token_key_name="tokenKeyName", token_signing_public_keys={ "token_signing_public_keys_key": "tokenSigningPublicKeys" } )
Attributes
- authorizer_function_arn
The authorizer’s Lambda function ARN.
- authorizer_name
The authorizer name.
- enable_caching_for_http
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 doesn’t affect authorization of clients that use MQTT connections.
- signing_disabled
Specifies whether AWS IoT validates the token signature in an authorization request.
- status
The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- tags
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
The key used to extract the token from the HTTP headers.
- token_signing_public_keys
The public keys used to validate the token signature returned by your custom authentication service.