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
]) –AWS::IoT::Authorizer.EnableCachingForHttp
.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
[CfnTag
]]) – 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.
- Link
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. import aws_cdk.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
The authorizer’s Lambda function ARN.
The authorizer name.
-
enable_caching_for_http
¶ AWS::IoT::Authorizer.EnableCachingForHttp
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
signing_disabled
¶ Specifies whether AWS IoT validates the token signature in an authorization request.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
status
¶ The status of the authorizer.
Valid values:
ACTIVE
|INACTIVE
- Link
- Return type
Optional
[str
]
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…”
- Link
- Return type
Optional
[List
[CfnTag
]]
-
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.
- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]