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.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings

Description

Synopsis

Documentation

data BackendAPIAppSyncAuthSettings Source #

The authentication settings for accessing provisioned data models in your Amplify project.

See: newBackendAPIAppSyncAuthSettings smart constructor.

Constructors

BackendAPIAppSyncAuthSettings'

Fields

cognitoUserPoolId :: Maybe Text
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
description :: Maybe Text
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
expirationTime :: Maybe Double
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
openIDAuthTTL :: Maybe Text
The expiry time for the OpenID authentication mechanism.
openIDClientId :: Maybe Text
The clientID for openID, if openID was used as an authentication setting to access your data models.
openIDIatTTL :: Maybe Text
The expiry time for the OpenID authentication mechanism.
openIDIssueURL :: Maybe Text
The openID issuer URL, if openID was used as an authentication setting to access your data models.
openIDProviderName :: Maybe Text
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Instances

Instances details

FromJSON BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods parseJSON :: Value -> Parser BackendAPIAppSyncAuthSettings # parseJSONList :: Value -> Parser [BackendAPIAppSyncAuthSettings] #
ToJSON BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods toJSON :: BackendAPIAppSyncAuthSettings -> Value # toEncoding :: BackendAPIAppSyncAuthSettings -> Encoding # toJSONList :: [BackendAPIAppSyncAuthSettings] -> Value # toEncodingList :: [BackendAPIAppSyncAuthSettings] -> Encoding #
Generic BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Associated Types type Rep BackendAPIAppSyncAuthSettings :: Type -> Type # Methods from :: BackendAPIAppSyncAuthSettings -> Rep BackendAPIAppSyncAuthSettings x # to :: Rep BackendAPIAppSyncAuthSettings x -> BackendAPIAppSyncAuthSettings #
Read BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods readsPrec :: Int -> ReadS BackendAPIAppSyncAuthSettings # readList :: ReadS [BackendAPIAppSyncAuthSettings] # readPrec :: ReadPrec BackendAPIAppSyncAuthSettings # readListPrec :: ReadPrec [BackendAPIAppSyncAuthSettings] #
Show BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods showsPrec :: Int -> BackendAPIAppSyncAuthSettings -> ShowS # show :: BackendAPIAppSyncAuthSettings -> String # showList :: [BackendAPIAppSyncAuthSettings] -> ShowS #
NFData BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods rnf :: BackendAPIAppSyncAuthSettings -> () #
Eq BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods (==) :: BackendAPIAppSyncAuthSettings -> BackendAPIAppSyncAuthSettings -> Bool # (/=) :: BackendAPIAppSyncAuthSettings -> BackendAPIAppSyncAuthSettings -> Bool #
Hashable BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings Methods hashWithSalt :: Int -> BackendAPIAppSyncAuthSettings -> Int # hash :: BackendAPIAppSyncAuthSettings -> Int #
type Rep BackendAPIAppSyncAuthSettings Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings type Rep BackendAPIAppSyncAuthSettings = D1 ('MetaData "BackendAPIAppSyncAuthSettings" "Amazonka.AmplifyBackend.Types.BackendAPIAppSyncAuthSettings" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "BackendAPIAppSyncAuthSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cognitoUserPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "expirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "openIDAuthTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "openIDClientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "openIDIatTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "openIDIssueURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "openIDProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newBackendAPIAppSyncAuthSettings :: BackendAPIAppSyncAuthSettings Source #

Create a value of BackendAPIAppSyncAuthSettings 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:cognitoUserPoolId:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_cognitoUserPoolId - The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

$sel:description:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_description - The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

$sel:expirationTime:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_expirationTime - The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

$sel:openIDAuthTTL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDAuthTTL - The expiry time for the OpenID authentication mechanism.

$sel:openIDClientId:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDClientId - The clientID for openID, if openID was used as an authentication setting to access your data models.

$sel:openIDIatTTL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDIatTTL - The expiry time for the OpenID authentication mechanism.

$sel:openIDIssueURL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDIssueURL - The openID issuer URL, if openID was used as an authentication setting to access your data models.

$sel:openIDProviderName:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDProviderName - The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

backendAPIAppSyncAuthSettings_cognitoUserPoolId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

backendAPIAppSyncAuthSettings_description :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

backendAPIAppSyncAuthSettings_expirationTime :: Lens' BackendAPIAppSyncAuthSettings (Maybe Double) Source #

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

backendAPIAppSyncAuthSettings_openIDAuthTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The expiry time for the OpenID authentication mechanism.

backendAPIAppSyncAuthSettings_openIDClientId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The clientID for openID, if openID was used as an authentication setting to access your data models.

backendAPIAppSyncAuthSettings_openIDIatTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The expiry time for the OpenID authentication mechanism.

backendAPIAppSyncAuthSettings_openIDIssueURL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The openID issuer URL, if openID was used as an authentication setting to access your data models.

backendAPIAppSyncAuthSettings_openIDProviderName :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.