Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Documentation

data SamlConfigOptions

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

FromJSON SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

parseJSON :: Value -> Parser SamlConfigOptions

parseJSONList :: Value -> Parser [SamlConfigOptions]

ToJSON SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

toJSON :: SamlConfigOptions -> Value

toEncoding :: SamlConfigOptions -> Encoding

toJSONList :: [SamlConfigOptions] -> Value

toEncodingList :: [SamlConfigOptions] -> Encoding

Generic SamlConfigOptions

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

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

readsPrec :: Int -> ReadS SamlConfigOptions

readList :: ReadS [SamlConfigOptions]

readPrec :: ReadPrec SamlConfigOptions

readListPrec :: ReadPrec [SamlConfigOptions]

Show SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

showsPrec :: Int -> SamlConfigOptions -> ShowS

show :: SamlConfigOptions -> String

showList :: [SamlConfigOptions] -> ShowS

NFData SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

rnf :: SamlConfigOptions -> ()

Eq SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

(==) :: SamlConfigOptions -> SamlConfigOptions -> Bool

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

Hashable SamlConfigOptions

Defined in Amazonka.OpenSearchServerless.Types.SamlConfigOptions

Methods

hashWithSalt :: Int -> SamlConfigOptions -> Int

hash :: SamlConfigOptions -> Int

type Rep SamlConfigOptions

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

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)

The group attribute for this SAML integration.

samlConfigOptions_sessionTimeout :: Lens' SamlConfigOptions (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.

samlConfigOptions_userAttribute :: Lens' SamlConfigOptions (Maybe Text)

A user attribute for this SAML integration.

samlConfigOptions_metadata :: Lens' SamlConfigOptions Text

The XML IdP metadata file generated from your identity provider.