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.OpenSearchServerless.Types.SamlConfigOptions

Description

Documentation

data SamlConfigOptions Source #

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

See: newSamlConfigOptions smart constructor.

Constructors

SamlConfigOptions'
Fields groupAttribute :: Maybe Text The group attribute for this SAML integration. sessionTimeout :: Maybe Natural The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes. userAttribute :: Maybe Text A user attribute for this SAML integration. metadata :: Text The XML IdP metadata file generated from your identity provider.

Instances

Instances details

FromJSON SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods parseJSON :: Value -> Parser SamlConfigOptions # parseJSONList :: Value -> Parser [SamlConfigOptions] #
ToJSON SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods toJSON :: SamlConfigOptions -> Value # toEncoding :: SamlConfigOptions -> Encoding # toJSONList :: [SamlConfigOptions] -> Value # toEncodingList :: [SamlConfigOptions] -> Encoding #
Generic SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Associated Types type Rep SamlConfigOptions :: Type -> Type # Methods from :: SamlConfigOptions -> Rep SamlConfigOptions x # to :: Rep SamlConfigOptions x -> SamlConfigOptions #
Read SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods readsPrec :: Int -> ReadS SamlConfigOptions # readList :: ReadS [SamlConfigOptions] # readPrec :: ReadPrec SamlConfigOptions # readListPrec :: ReadPrec [SamlConfigOptions] #
Show SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods showsPrec :: Int -> SamlConfigOptions -> ShowS # show :: SamlConfigOptions -> String # showList :: [SamlConfigOptions] -> ShowS #
NFData SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods rnf :: SamlConfigOptions -> () #
Eq SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods (==) :: SamlConfigOptions -> SamlConfigOptions -> Bool # (/=) :: SamlConfigOptions -> SamlConfigOptions -> Bool #
Hashable SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions Methods hashWithSalt :: Int -> SamlConfigOptions -> Int # hash :: SamlConfigOptions -> Int #
type Rep SamlConfigOptions Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions type Rep SamlConfigOptions = D1 ('MetaData "SamlConfigOptions" "Amazonka.OpenSearchServerless.Types.SamlConfigOptions" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "SamlConfigOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sessionTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "userAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSamlConfigOptions Source #

Arguments

:: Text	`$sel:metadata:SamlConfigOptions'`
-> SamlConfigOptions

Create a value of SamlConfigOptions 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:groupAttribute:SamlConfigOptions', samlConfigOptions_groupAttribute - The group attribute for this SAML integration.

$sel:sessionTimeout:SamlConfigOptions', samlConfigOptions_sessionTimeout - The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

$sel:userAttribute:SamlConfigOptions', samlConfigOptions_userAttribute - A user attribute for this SAML integration.

$sel:metadata:SamlConfigOptions', samlConfigOptions_metadata - The XML IdP metadata file generated from your identity provider.

samlConfigOptions_groupAttribute :: Lens' SamlConfigOptions (Maybe Text) Source #

The group attribute for this SAML integration.

samlConfigOptions_sessionTimeout :: Lens' SamlConfigOptions (Maybe Natural) Source #

The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

samlConfigOptions_userAttribute :: Lens' SamlConfigOptions (Maybe Text) Source #

A user attribute for this SAML integration.

samlConfigOptions_metadata :: Lens' SamlConfigOptions Text Source #

The XML IdP metadata file generated from your identity provider.