| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoT.CreateAuthorizer
Description
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
Synopsis
- data CreateAuthorizer = CreateAuthorizer' {}
- newCreateAuthorizer :: Text -> Text -> CreateAuthorizer
- createAuthorizer_enableCachingForHttp :: Lens' CreateAuthorizer (Maybe Bool)
- createAuthorizer_signingDisabled :: Lens' CreateAuthorizer (Maybe Bool)
- createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus)
- createAuthorizer_tags :: Lens' CreateAuthorizer (Maybe [Tag])
- createAuthorizer_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text)
- createAuthorizer_tokenSigningPublicKeys :: Lens' CreateAuthorizer (Maybe (HashMap Text Text))
- createAuthorizer_authorizerName :: Lens' CreateAuthorizer Text
- createAuthorizer_authorizerFunctionArn :: Lens' CreateAuthorizer Text
- data CreateAuthorizerResponse = CreateAuthorizerResponse' {}
- newCreateAuthorizerResponse :: Int -> CreateAuthorizerResponse
- createAuthorizerResponse_authorizerArn :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int
Creating a Request
data CreateAuthorizer Source #
See: newCreateAuthorizer smart constructor.
Constructors
| CreateAuthorizer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateAuthorizer |
Create a value of CreateAuthorizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAuthorizer, createAuthorizer_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.
CreateAuthorizer, createAuthorizer_signingDisabled - Specifies whether IoT validates the token signature in an authorization
request.
CreateAuthorizer, createAuthorizer_status - The status of the create authorizer request.
$sel:tags:CreateAuthorizer', createAuthorizer_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..."
CreateAuthorizer, createAuthorizer_tokenKeyName - The name of the token key used to extract the token from the HTTP
headers.
CreateAuthorizer, createAuthorizer_tokenSigningPublicKeys - The public keys used to verify the digital signature returned by your
custom authentication service.
CreateAuthorizer, createAuthorizer_authorizerName - The authorizer name.
CreateAuthorizer, createAuthorizer_authorizerFunctionArn - The ARN of the authorizer's Lambda function.
Request Lenses
createAuthorizer_enableCachingForHttp :: Lens' CreateAuthorizer (Maybe Bool) Source #
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.
createAuthorizer_signingDisabled :: Lens' CreateAuthorizer (Maybe Bool) Source #
Specifies whether IoT validates the token signature in an authorization request.
createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus) Source #
The status of the create authorizer request.
createAuthorizer_tags :: Lens' CreateAuthorizer (Maybe [Tag]) Source #
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..."
createAuthorizer_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text) Source #
The name of the token key used to extract the token from the HTTP headers.
createAuthorizer_tokenSigningPublicKeys :: Lens' CreateAuthorizer (Maybe (HashMap Text Text)) Source #
The public keys used to verify the digital signature returned by your custom authentication service.
createAuthorizer_authorizerName :: Lens' CreateAuthorizer Text Source #
The authorizer name.
createAuthorizer_authorizerFunctionArn :: Lens' CreateAuthorizer Text Source #
The ARN of the authorizer's Lambda function.
Destructuring the Response
data CreateAuthorizerResponse Source #
See: newCreateAuthorizerResponse smart constructor.
Constructors
| CreateAuthorizerResponse' | |
Fields
| |
Instances
newCreateAuthorizerResponse Source #
Create a value of CreateAuthorizerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAuthorizerResponse, createAuthorizerResponse_authorizerArn - The authorizer ARN.
CreateAuthorizer, createAuthorizerResponse_authorizerName - The authorizer's name.
$sel:httpStatus:CreateAuthorizerResponse', createAuthorizerResponse_httpStatus - The response's http status code.
Response Lenses
createAuthorizerResponse_authorizerArn :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
The authorizer ARN.
createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
The authorizer's name.
createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int Source #
The response's http status code.