Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Documentation

data AuthenticateCognitoActionConfig

Request parameters to use when integrating with Amazon Cognito to authenticate users.

See: newAuthenticateCognitoActionConfig smart constructor.

Constructors

AuthenticateCognitoActionConfig'

Fields

• authenticationRequestExtraParams :: Maybe (HashMap Text Text)

  The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

• onUnauthenticatedRequest :: Maybe AuthenticateCognitoActionConditionalBehaviorEnum

  The behavior if the user is not authenticated. The following are possible values:

  • deny - Return an HTTP 401 Unauthorized error.
  • allow - Allow the request to be forwarded to the target.
  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
• scope :: Maybe Text

  The set of user claims to be requested from the IdP. The default is openid.

  To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

• sessionCookieName :: Maybe Text

  The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

• sessionTimeout :: Maybe Integer

  The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

• userPoolArn :: Text

  The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

• userPoolClientId :: Text

  The ID of the Amazon Cognito user pool client.

• userPoolDomain :: Text

  The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Instances

ToQuery AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

toQuery :: AuthenticateCognitoActionConfig -> QueryString

FromXML AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

parseXML :: [Node] -> Either String AuthenticateCognitoActionConfig

Generic AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Associated Types

type Rep AuthenticateCognitoActionConfig :: Type -> Type

Methods

from :: AuthenticateCognitoActionConfig -> Rep AuthenticateCognitoActionConfig x

to :: Rep AuthenticateCognitoActionConfig x -> AuthenticateCognitoActionConfig

Read AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

readsPrec :: Int -> ReadS AuthenticateCognitoActionConfig

readList :: ReadS [AuthenticateCognitoActionConfig]

readPrec :: ReadPrec AuthenticateCognitoActionConfig

readListPrec :: ReadPrec [AuthenticateCognitoActionConfig]

Show AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

showsPrec :: Int -> AuthenticateCognitoActionConfig -> ShowS

show :: AuthenticateCognitoActionConfig -> String

showList :: [AuthenticateCognitoActionConfig] -> ShowS

NFData AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

rnf :: AuthenticateCognitoActionConfig -> ()

Eq AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

(==) :: AuthenticateCognitoActionConfig -> AuthenticateCognitoActionConfig -> Bool

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

Hashable AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

Methods

hashWithSalt :: Int -> AuthenticateCognitoActionConfig -> Int

hash :: AuthenticateCognitoActionConfig -> Int

type Rep AuthenticateCognitoActionConfig

Defined in Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig

type Rep AuthenticateCognitoActionConfig = D1 ('MetaData "AuthenticateCognitoActionConfig" "Amazonka.ELBV2.Types.AuthenticateCognitoActionConfig" "amazonka-elbv2-2.0-361J9F5fkBoAtGaOoJg8Ev" 'False) (C1 ('MetaCons "AuthenticateCognitoActionConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationRequestExtraParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "onUnauthenticatedRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticateCognitoActionConditionalBehaviorEnum))) :*: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sessionCookieName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sessionTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "userPoolArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "userPoolClientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userPoolDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newAuthenticateCognitoActionConfig

Arguments

:: Text

$sel:userPoolArn:AuthenticateCognitoActionConfig'

-> Text

$sel:userPoolClientId:AuthenticateCognitoActionConfig'

-> Text

$sel:userPoolDomain:AuthenticateCognitoActionConfig'

-> AuthenticateCognitoActionConfig

Create a value of AuthenticateCognitoActionConfig 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:authenticationRequestExtraParams:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

$sel:onUnauthenticatedRequest:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values:

• deny - Return an HTTP 401 Unauthorized error.
• allow - Allow the request to be forwarded to the target.
• authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

$sel:scope:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_scope - The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

$sel:sessionCookieName:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_sessionCookieName - The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

$sel:sessionTimeout:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

$sel:userPoolArn:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_userPoolArn - The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

$sel:userPoolClientId:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_userPoolClientId - The ID of the Amazon Cognito user pool client.

$sel:userPoolDomain:AuthenticateCognitoActionConfig', authenticateCognitoActionConfig_userPoolDomain - The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

authenticateCognitoActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateCognitoActionConfig (Maybe (HashMap Text Text))

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

authenticateCognitoActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateCognitoActionConfig (Maybe AuthenticateCognitoActionConditionalBehaviorEnum)

The behavior if the user is not authenticated. The following are possible values:

• deny - Return an HTTP 401 Unauthorized error.
• allow - Allow the request to be forwarded to the target.
• authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

authenticateCognitoActionConfig_scope :: Lens' AuthenticateCognitoActionConfig (Maybe Text)

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

authenticateCognitoActionConfig_sessionCookieName :: Lens' AuthenticateCognitoActionConfig (Maybe Text)

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

authenticateCognitoActionConfig_sessionTimeout :: Lens' AuthenticateCognitoActionConfig (Maybe Integer)

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

authenticateCognitoActionConfig_userPoolArn :: Lens' AuthenticateCognitoActionConfig Text

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

authenticateCognitoActionConfig_userPoolClientId :: Lens' AuthenticateCognitoActionConfig Text

The ID of the Amazon Cognito user pool client.

authenticateCognitoActionConfig_userPoolDomain :: Lens' AuthenticateCognitoActionConfig Text

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.