/AWS1/CL_IOTAUTHORIZERDESC¶
The authorizer description.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_authorizername TYPE /AWS1/IOTAUTHORIZERNAME /AWS1/IOTAUTHORIZERNAME¶
The authorizer name.
iv_authorizerarn TYPE /AWS1/IOTAUTHORIZERARN /AWS1/IOTAUTHORIZERARN¶
The authorizer ARN.
iv_authorizerfunctionarn TYPE /AWS1/IOTAUTHORIZERFUNCTIONARN /AWS1/IOTAUTHORIZERFUNCTIONARN¶
The authorizer's Lambda function ARN.
iv_tokenkeyname TYPE /AWS1/IOTTOKENKEYNAME /AWS1/IOTTOKENKEYNAME¶
The key used to extract the token from the HTTP headers.
it_tokensigningpublickeys TYPE /AWS1/CL_IOTPUBLICKEYMAP_W=>TT_PUBLICKEYMAP TT_PUBLICKEYMAP¶
The public keys used to validate the token signature returned by your custom authentication service.
iv_status TYPE /AWS1/IOTAUTHORIZERSTATUS /AWS1/IOTAUTHORIZERSTATUS¶
The status of the authorizer.
iv_creationdate TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The UNIX timestamp of when the authorizer was created.
iv_lastmodifieddate TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The UNIX timestamp of when the authorizer was last updated.
iv_signingdisabled TYPE /AWS1/IOTBOOLEANKEY /AWS1/IOTBOOLEANKEY¶
Specifies whether IoT validates the token signature in an authorization request.
iv_enablecachingforhttp TYPE /AWS1/IOTENABLECACHINGFORHTTP /AWS1/IOTENABLECACHINGFORHTTP¶
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.
Queryable Attributes¶
authorizerName¶
The authorizer name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHORIZERNAME() |
Getter for AUTHORIZERNAME, with configurable default |
ASK_AUTHORIZERNAME() |
Getter for AUTHORIZERNAME w/ exceptions if field has no valu |
HAS_AUTHORIZERNAME() |
Determine if AUTHORIZERNAME has a value |
authorizerArn¶
The authorizer ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHORIZERARN() |
Getter for AUTHORIZERARN, with configurable default |
ASK_AUTHORIZERARN() |
Getter for AUTHORIZERARN w/ exceptions if field has no value |
HAS_AUTHORIZERARN() |
Determine if AUTHORIZERARN has a value |
authorizerFunctionArn¶
The authorizer's Lambda function ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHORIZERFUNCTIONARN() |
Getter for AUTHORIZERFUNCTIONARN, with configurable default |
ASK_AUTHORIZERFUNCTIONARN() |
Getter for AUTHORIZERFUNCTIONARN w/ exceptions if field has |
HAS_AUTHORIZERFUNCTIONARN() |
Determine if AUTHORIZERFUNCTIONARN has a value |
tokenKeyName¶
The key used to extract the token from the HTTP headers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENKEYNAME() |
Getter for TOKENKEYNAME, with configurable default |
ASK_TOKENKEYNAME() |
Getter for TOKENKEYNAME w/ exceptions if field has no value |
HAS_TOKENKEYNAME() |
Determine if TOKENKEYNAME has a value |
tokenSigningPublicKeys¶
The public keys used to validate the token signature returned by your custom authentication service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENSIGNINGPUBLICKEYS() |
Getter for TOKENSIGNINGPUBLICKEYS, with configurable default |
ASK_TOKENSIGNINGPUBLICKEYS() |
Getter for TOKENSIGNINGPUBLICKEYS w/ exceptions if field has |
HAS_TOKENSIGNINGPUBLICKEYS() |
Determine if TOKENSIGNINGPUBLICKEYS has a value |
status¶
The status of the authorizer.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
creationDate¶
The UNIX timestamp of when the authorizer was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
lastModifiedDate¶
The UNIX timestamp of when the authorizer was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
signingDisabled¶
Specifies whether IoT validates the token signature in an authorization request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SIGNINGDISABLED() |
Getter for SIGNINGDISABLED, with configurable default |
ASK_SIGNINGDISABLED() |
Getter for SIGNINGDISABLED w/ exceptions if field has no val |
HAS_SIGNINGDISABLED() |
Determine if SIGNINGDISABLED has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLECACHINGFORHTTP() |
Getter for ENABLECACHINGFORHTTP, with configurable default |
ASK_ENABLECACHINGFORHTTP() |
Getter for ENABLECACHINGFORHTTP w/ exceptions if field has n |
HAS_ENABLECACHINGFORHTTP() |
Determine if ENABLECACHINGFORHTTP has a value |