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.Types.AuthorizerDescription

Description

Synopsis

data AuthorizerDescription = AuthorizerDescription' {
- authorizerArn :: Maybe Text
- authorizerFunctionArn :: Maybe Text
- authorizerName :: Maybe Text
- creationDate :: Maybe POSIX
- enableCachingForHttp :: Maybe Bool
- lastModifiedDate :: Maybe POSIX
- signingDisabled :: Maybe Bool
- status :: Maybe AuthorizerStatus
- tokenKeyName :: Maybe Text
- tokenSigningPublicKeys :: Maybe (HashMap Text Text)
}
newAuthorizerDescription :: AuthorizerDescription
authorizerDescription_authorizerArn :: Lens' AuthorizerDescription (Maybe Text)
authorizerDescription_authorizerFunctionArn :: Lens' AuthorizerDescription (Maybe Text)
authorizerDescription_authorizerName :: Lens' AuthorizerDescription (Maybe Text)
authorizerDescription_creationDate :: Lens' AuthorizerDescription (Maybe UTCTime)
authorizerDescription_enableCachingForHttp :: Lens' AuthorizerDescription (Maybe Bool)
authorizerDescription_lastModifiedDate :: Lens' AuthorizerDescription (Maybe UTCTime)
authorizerDescription_signingDisabled :: Lens' AuthorizerDescription (Maybe Bool)
authorizerDescription_status :: Lens' AuthorizerDescription (Maybe AuthorizerStatus)
authorizerDescription_tokenKeyName :: Lens' AuthorizerDescription (Maybe Text)
authorizerDescription_tokenSigningPublicKeys :: Lens' AuthorizerDescription (Maybe (HashMap Text Text))

Documentation

data AuthorizerDescription Source #

The authorizer description.

See: newAuthorizerDescription smart constructor.

Constructors

AuthorizerDescription'

Fields

authorizerArn :: Maybe Text
The authorizer ARN.
authorizerFunctionArn :: Maybe Text
The authorizer's Lambda function ARN.
authorizerName :: Maybe Text
The authorizer name.
creationDate :: Maybe POSIX
The UNIX timestamp of when the authorizer was created.
enableCachingForHttp :: Maybe Bool
When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.
lastModifiedDate :: Maybe POSIX
The UNIX timestamp of when the authorizer was last updated.
signingDisabled :: Maybe Bool
Specifies whether IoT validates the token signature in an authorization request.
status :: Maybe AuthorizerStatus
The status of the authorizer.
tokenKeyName :: Maybe Text
The key used to extract the token from the HTTP headers.
tokenSigningPublicKeys :: Maybe (HashMap Text Text)
The public keys used to validate the token signature returned by your custom authentication service.

Instances

Instances details

FromJSON AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods parseJSON :: Value -> Parser AuthorizerDescription # parseJSONList :: Value -> Parser [AuthorizerDescription] #
Generic AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Associated Types type Rep AuthorizerDescription :: Type -> Type # Methods from :: AuthorizerDescription -> Rep AuthorizerDescription x # to :: Rep AuthorizerDescription x -> AuthorizerDescription #
Read AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods readsPrec :: Int -> ReadS AuthorizerDescription # readList :: ReadS [AuthorizerDescription] # readPrec :: ReadPrec AuthorizerDescription # readListPrec :: ReadPrec [AuthorizerDescription] #
Show AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods showsPrec :: Int -> AuthorizerDescription -> ShowS # show :: AuthorizerDescription -> String # showList :: [AuthorizerDescription] -> ShowS #
NFData AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods rnf :: AuthorizerDescription -> () #
Eq AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods (==) :: AuthorizerDescription -> AuthorizerDescription -> Bool # (/=) :: AuthorizerDescription -> AuthorizerDescription -> Bool #
Hashable AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription Methods hashWithSalt :: Int -> AuthorizerDescription -> Int # hash :: AuthorizerDescription -> Int #
type Rep AuthorizerDescription Source #
Instance details Defined in Amazonka.IoT.Types.AuthorizerDescription type Rep AuthorizerDescription = D1 ('MetaData "AuthorizerDescription" "Amazonka.IoT.Types.AuthorizerDescription" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AuthorizerDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerFunctionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "enableCachingForHttp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "signingDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerStatus)) :: (S1 ('MetaSel ('Just "tokenKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenSigningPublicKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newAuthorizerDescription :: AuthorizerDescription Source #

Create a value of AuthorizerDescription 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:authorizerArn:AuthorizerDescription', authorizerDescription_authorizerArn - The authorizer ARN.

$sel:authorizerFunctionArn:AuthorizerDescription', authorizerDescription_authorizerFunctionArn - The authorizer's Lambda function ARN.

$sel:authorizerName:AuthorizerDescription', authorizerDescription_authorizerName - The authorizer name.

$sel:creationDate:AuthorizerDescription', authorizerDescription_creationDate - The UNIX timestamp of when the authorizer was created.

$sel:enableCachingForHttp:AuthorizerDescription', authorizerDescription_enableCachingForHttp - When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

$sel:lastModifiedDate:AuthorizerDescription', authorizerDescription_lastModifiedDate - The UNIX timestamp of when the authorizer was last updated.

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

$sel:status:AuthorizerDescription', authorizerDescription_status - The status of the authorizer.

$sel:tokenKeyName:AuthorizerDescription', authorizerDescription_tokenKeyName - The key used to extract the token from the HTTP headers.

$sel:tokenSigningPublicKeys:AuthorizerDescription', authorizerDescription_tokenSigningPublicKeys - The public keys used to validate the token signature returned by your custom authentication service.

authorizerDescription_authorizerArn :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer ARN.

authorizerDescription_authorizerFunctionArn :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer's Lambda function ARN.

authorizerDescription_authorizerName :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer name.

authorizerDescription_creationDate :: Lens' AuthorizerDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the authorizer was created.

authorizerDescription_enableCachingForHttp :: Lens' AuthorizerDescription (Maybe Bool) Source #

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

authorizerDescription_lastModifiedDate :: Lens' AuthorizerDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the authorizer was last updated.

authorizerDescription_signingDisabled :: Lens' AuthorizerDescription (Maybe Bool) Source #

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

authorizerDescription_status :: Lens' AuthorizerDescription (Maybe AuthorizerStatus) Source #

The status of the authorizer.

authorizerDescription_tokenKeyName :: Lens' AuthorizerDescription (Maybe Text) Source #

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

authorizerDescription_tokenSigningPublicKeys :: Lens' AuthorizerDescription (Maybe (HashMap Text Text)) Source #

The public keys used to validate the token signature returned by your custom authentication service.