AuthorizerDescription
The authorizer description.
Contents
-
The authorizer ARN.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
-
The authorizer's Lambda function ARN.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
[\s\S]*
Required: No
-
The authorizer name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w=,@-]+
Required: No
- creationDate
-
The UNIX timestamp of when the authorizer was created.
Type: Timestamp
Required: No
- enableCachingForHttp
-
When
true
, the result from the authorizer’s Lambda function is cached for the time specified inrefreshAfterInSeconds
. The cached result is used while the device reuses the same HTTP connection.Type: Boolean
Required: No
- lastModifiedDate
-
The UNIX timestamp of when the authorizer was last updated.
Type: Timestamp
Required: No
- signingDisabled
-
Specifies whether Amazon IoT validates the token signature in an authorization request.
Type: Boolean
Required: No
- status
-
The status of the authorizer.
Type: String
Valid Values:
ACTIVE | INACTIVE
Required: No
- tokenKeyName
-
The key used to extract the token from the HTTP headers.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+
Required: No
- tokenSigningPublicKeys
-
The public keys used to validate the token signature returned by your custom authentication service.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9:_-]+
Value Length Constraints: Maximum length of 5120.
Value Pattern:
[\s\S]*
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: