Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.CreateAuthorizer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Synopsis

data CreateAuthorizer = CreateAuthorizer' {
- status :: Maybe AuthorizerStatus
- signingDisabled :: Maybe Bool
- tokenSigningPublicKeys :: Maybe (HashMap Text Text)
- tokenKeyName :: Maybe Text
- tags :: Maybe [Tag]
- authorizerName :: Text
- authorizerFunctionArn :: Text
}
newCreateAuthorizer :: Text -> Text -> CreateAuthorizer
createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus)
createAuthorizer_signingDisabled :: Lens' CreateAuthorizer (Maybe Bool)
createAuthorizer_tokenSigningPublicKeys :: Lens' CreateAuthorizer (Maybe (HashMap Text Text))
createAuthorizer_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text)
createAuthorizer_tags :: Lens' CreateAuthorizer (Maybe [Tag])
createAuthorizer_authorizerName :: Lens' CreateAuthorizer Text
createAuthorizer_authorizerFunctionArn :: Lens' CreateAuthorizer Text
data CreateAuthorizerResponse = CreateAuthorizerResponse' {
- authorizerName :: Maybe Text
- authorizerArn :: Maybe Text
- httpStatus :: Int
}
newCreateAuthorizerResponse :: Int -> CreateAuthorizerResponse
createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text)
createAuthorizerResponse_authorizerArn :: Lens' CreateAuthorizerResponse (Maybe Text)
createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int

Creating a Request

data CreateAuthorizer Source #

See: newCreateAuthorizer smart constructor.

Constructors

CreateAuthorizer'

Fields

status :: Maybe AuthorizerStatus
The status of the create authorizer request.
signingDisabled :: Maybe Bool
Specifies whether IoT validates the token signature in an authorization request.
tokenSigningPublicKeys :: Maybe (HashMap Text Text)
The public keys used to verify the digital signature returned by your custom authentication service.
tokenKeyName :: Maybe Text
The name of the token key used to extract the token from the HTTP headers.
tags :: Maybe [Tag]
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..."
authorizerName :: Text
The authorizer name.
authorizerFunctionArn :: Text
The ARN of the authorizer's Lambda function.

Instances

Instances details

Eq CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods (==) :: CreateAuthorizer -> CreateAuthorizer -> Bool # (/=) :: CreateAuthorizer -> CreateAuthorizer -> Bool #
Read CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods readsPrec :: Int -> ReadS CreateAuthorizer # readList :: ReadS [CreateAuthorizer] # readPrec :: ReadPrec CreateAuthorizer # readListPrec :: ReadPrec [CreateAuthorizer] #
Show CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods showsPrec :: Int -> CreateAuthorizer -> ShowS # show :: CreateAuthorizer -> String # showList :: [CreateAuthorizer] -> ShowS #
Generic CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Associated Types type Rep CreateAuthorizer :: Type -> Type # Methods from :: CreateAuthorizer -> Rep CreateAuthorizer x # to :: Rep CreateAuthorizer x -> CreateAuthorizer #
NFData CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods rnf :: CreateAuthorizer -> () #
Hashable CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods hashWithSalt :: Int -> CreateAuthorizer -> Int # hash :: CreateAuthorizer -> Int #
ToJSON CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods toJSON :: CreateAuthorizer -> Value # toEncoding :: CreateAuthorizer -> Encoding # toJSONList :: [CreateAuthorizer] -> Value # toEncodingList :: [CreateAuthorizer] -> Encoding #
AWSRequest CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Associated Types type AWSResponse CreateAuthorizer # Methods request :: CreateAuthorizer -> Request CreateAuthorizer # response :: MonadResource m => Logger -> Service -> Proxy CreateAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAuthorizer))) #
ToHeaders CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods toHeaders :: CreateAuthorizer -> [Header] #
ToPath CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods toPath :: CreateAuthorizer -> ByteString #
ToQuery CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods toQuery :: CreateAuthorizer -> QueryString #
type Rep CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer type Rep CreateAuthorizer = D1 ('MetaData "CreateAuthorizer" "Amazonka.IoT.CreateAuthorizer" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateAuthorizer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerStatus)) :: (S1 ('MetaSel ('Just "signingDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "tokenSigningPublicKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "tokenKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "authorizerFunctionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateAuthorizer Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer type AWSResponse CreateAuthorizer = CreateAuthorizerResponse

newCreateAuthorizer Source #

Arguments

:: Text	`$sel:authorizerName:CreateAuthorizer'`
-> Text	`$sel:authorizerFunctionArn:CreateAuthorizer'`
-> 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:

$sel:status:CreateAuthorizer', createAuthorizer_status - The status of the create authorizer request.

$sel:signingDisabled:CreateAuthorizer', createAuthorizer_signingDisabled - Specifies whether IoT validates the token signature in an authorization request.

$sel:tokenSigningPublicKeys:CreateAuthorizer', createAuthorizer_tokenSigningPublicKeys - The public keys used to verify the digital signature returned by your custom authentication service.

$sel:tokenKeyName:CreateAuthorizer', createAuthorizer_tokenKeyName - The name of the token key used to extract the token from the HTTP headers.

$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..."

$sel:authorizerName:CreateAuthorizer', createAuthorizer_authorizerName - The authorizer name.

$sel:authorizerFunctionArn:CreateAuthorizer', createAuthorizer_authorizerFunctionArn - The ARN of the authorizer's Lambda function.

Request Lenses

createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus) Source #

The status of the create authorizer request.

createAuthorizer_signingDisabled :: Lens' CreateAuthorizer (Maybe Bool) Source #

Specifies whether IoT validates the token signature in an authorization request.

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_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text) Source #

The name of the token key used to extract the token from the HTTP headers.

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_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 authorizerName :: Maybe Text The authorizer's name. authorizerArn :: Maybe Text The authorizer ARN. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods (==) :: CreateAuthorizerResponse -> CreateAuthorizerResponse -> Bool # (/=) :: CreateAuthorizerResponse -> CreateAuthorizerResponse -> Bool #
Read CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods readsPrec :: Int -> ReadS CreateAuthorizerResponse # readList :: ReadS [CreateAuthorizerResponse] # readPrec :: ReadPrec CreateAuthorizerResponse # readListPrec :: ReadPrec [CreateAuthorizerResponse] #
Show CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods showsPrec :: Int -> CreateAuthorizerResponse -> ShowS # show :: CreateAuthorizerResponse -> String # showList :: [CreateAuthorizerResponse] -> ShowS #
Generic CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Associated Types type Rep CreateAuthorizerResponse :: Type -> Type # Methods from :: CreateAuthorizerResponse -> Rep CreateAuthorizerResponse x # to :: Rep CreateAuthorizerResponse x -> CreateAuthorizerResponse #
NFData CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer Methods rnf :: CreateAuthorizerResponse -> () #
type Rep CreateAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.CreateAuthorizer type Rep CreateAuthorizerResponse = D1 ('MetaData "CreateAuthorizerResponse" "Amazonka.IoT.CreateAuthorizer" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateAuthorizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAuthorizerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAuthorizerResponse'`
-> CreateAuthorizerResponse

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:

$sel:authorizerName:CreateAuthorizer', createAuthorizerResponse_authorizerName - The authorizer's name.

$sel:authorizerArn:CreateAuthorizerResponse', createAuthorizerResponse_authorizerArn - The authorizer ARN.

$sel:httpStatus:CreateAuthorizerResponse', createAuthorizerResponse_httpStatus - The response's http status code.

Response Lenses

createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The authorizer's name.

createAuthorizerResponse_authorizerArn :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The authorizer ARN.

createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int Source #

The response's http status code.