Amazonka.IoT.CreateAuthorizer

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Creating a Request

data CreateAuthorizer

See: newCreateAuthorizer smart constructor.

Constructors

CreateAuthorizer'

Fields

• enableCachingForHttp :: Maybe Bool

  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.

• signingDisabled :: Maybe Bool

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

• status :: Maybe AuthorizerStatus

  The status of the create authorizer request.

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

• tokenKeyName :: Maybe Text

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

• tokenSigningPublicKeys :: Maybe (HashMap Text Text)

  The public keys used to verify the digital signature returned by your custom authentication service.

• authorizerName :: Text

  The authorizer name.

• authorizerFunctionArn :: Text

  The ARN of the authorizer's Lambda function.

Instances

ToJSON CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

toJSON :: CreateAuthorizer -> Value

toEncoding :: CreateAuthorizer -> Encoding

toJSONList :: [CreateAuthorizer] -> Value

toEncodingList :: [CreateAuthorizer] -> Encoding

ToHeaders CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

toHeaders :: CreateAuthorizer -> [Header]

ToPath CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

toPath :: CreateAuthorizer -> ByteString

ToQuery CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

toQuery :: CreateAuthorizer -> QueryString

AWSRequest CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Associated Types

type AWSResponse CreateAuthorizer

Methods

request :: (Service -> Service) -> CreateAuthorizer -> Request CreateAuthorizer

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAuthorizer)))

Generic CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Associated Types

type Rep CreateAuthorizer :: Type -> Type

Methods

from :: CreateAuthorizer -> Rep CreateAuthorizer x

to :: Rep CreateAuthorizer x -> CreateAuthorizer

Read CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

readsPrec :: Int -> ReadS CreateAuthorizer

readList :: ReadS [CreateAuthorizer]

readPrec :: ReadPrec CreateAuthorizer

readListPrec :: ReadPrec [CreateAuthorizer]

Show CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

showsPrec :: Int -> CreateAuthorizer -> ShowS

show :: CreateAuthorizer -> String

showList :: [CreateAuthorizer] -> ShowS

NFData CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

rnf :: CreateAuthorizer -> ()

Eq CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

(==) :: CreateAuthorizer -> CreateAuthorizer -> Bool

(/=) :: CreateAuthorizer -> CreateAuthorizer -> Bool

Hashable CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

Methods

hashWithSalt :: Int -> CreateAuthorizer -> Int

hash :: CreateAuthorizer -> Int

type AWSResponse CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

type AWSResponse CreateAuthorizer = CreateAuthorizerResponse

type Rep CreateAuthorizer

Defined in Amazonka.IoT.CreateAuthorizer

type Rep CreateAuthorizer = D1 ('MetaData "CreateAuthorizer" "Amazonka.IoT.CreateAuthorizer" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateAuthorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enableCachingForHttp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "signingDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerStatus)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "tokenKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenSigningPublicKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizerFunctionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAuthorizer

Arguments

:: Text

CreateAuthorizer

-> Text

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:

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)

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)

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

createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus)

The status of the create authorizer request.

createAuthorizer_tags :: Lens' CreateAuthorizer (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..."

createAuthorizer_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text)

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

createAuthorizer_tokenSigningPublicKeys :: Lens' CreateAuthorizer (Maybe (HashMap Text Text))

The public keys used to verify the digital signature returned by your custom authentication service.

createAuthorizer_authorizerName :: Lens' CreateAuthorizer Text

The authorizer name.

createAuthorizer_authorizerFunctionArn :: Lens' CreateAuthorizer Text

The ARN of the authorizer's Lambda function.

Destructuring the Response

data CreateAuthorizerResponse

See: newCreateAuthorizerResponse smart constructor.

Constructors

CreateAuthorizerResponse'

Fields

• authorizerArn :: Maybe Text

  The authorizer ARN.

• authorizerName :: Maybe Text

  The authorizer's name.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

Associated Types

type Rep CreateAuthorizerResponse :: Type -> Type

Methods

from :: CreateAuthorizerResponse -> Rep CreateAuthorizerResponse x

to :: Rep CreateAuthorizerResponse x -> CreateAuthorizerResponse

Read CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

Methods

readsPrec :: Int -> ReadS CreateAuthorizerResponse

readList :: ReadS [CreateAuthorizerResponse]

readPrec :: ReadPrec CreateAuthorizerResponse

readListPrec :: ReadPrec [CreateAuthorizerResponse]

Show CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

Methods

showsPrec :: Int -> CreateAuthorizerResponse -> ShowS

show :: CreateAuthorizerResponse -> String

showList :: [CreateAuthorizerResponse] -> ShowS

NFData CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

Methods

rnf :: CreateAuthorizerResponse -> ()

Eq CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

Methods

(==) :: CreateAuthorizerResponse -> CreateAuthorizerResponse -> Bool

(/=) :: CreateAuthorizerResponse -> CreateAuthorizerResponse -> Bool

type Rep CreateAuthorizerResponse

Defined in Amazonka.IoT.CreateAuthorizer

type Rep CreateAuthorizerResponse = D1 ('MetaData "CreateAuthorizerResponse" "Amazonka.IoT.CreateAuthorizer" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateAuthorizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAuthorizerResponse

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:

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)

The authorizer ARN.

createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text)

The authorizer's name.

createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int

The response's http status code.