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.OpenSearch.Types.SAMLOptionsInput

Description

Documentation

data SAMLOptionsInput Source #

The SAML authentication configuration for an Amazon OpenSearch Service domain.

See: newSAMLOptionsInput smart constructor.

Constructors

SAMLOptionsInput'

Fields

enabled :: Maybe Bool
True to enable SAML authentication for a domain.
idp :: Maybe SAMLIdp
The SAML Identity Provider's information.
masterBackendRole :: Maybe Text
The backend role that the SAML master user is mapped to.
masterUserName :: Maybe (Sensitive Text)
The SAML master user name, which is stored in the domain's internal user database.
rolesKey :: Maybe Text
Element of the SAML assertion to use for backend roles. Default is roles.
sessionTimeoutMinutes :: Maybe Int
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
subjectKey :: Maybe Text
Element of the SAML assertion to use for the user name. Default is NameID.

Instances

Instances details

ToJSON SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Methods toJSON :: SAMLOptionsInput -> Value # toEncoding :: SAMLOptionsInput -> Encoding # toJSONList :: [SAMLOptionsInput] -> Value # toEncodingList :: [SAMLOptionsInput] -> Encoding #
Generic SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Associated Types type Rep SAMLOptionsInput :: Type -> Type # Methods from :: SAMLOptionsInput -> Rep SAMLOptionsInput x # to :: Rep SAMLOptionsInput x -> SAMLOptionsInput #
Show SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Methods showsPrec :: Int -> SAMLOptionsInput -> ShowS # show :: SAMLOptionsInput -> String # showList :: [SAMLOptionsInput] -> ShowS #
NFData SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Methods rnf :: SAMLOptionsInput -> () #
Eq SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Methods (==) :: SAMLOptionsInput -> SAMLOptionsInput -> Bool # (/=) :: SAMLOptionsInput -> SAMLOptionsInput -> Bool #
Hashable SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput Methods hashWithSalt :: Int -> SAMLOptionsInput -> Int # hash :: SAMLOptionsInput -> Int #
type Rep SAMLOptionsInput Source #
Instance details Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput type Rep SAMLOptionsInput = D1 ('MetaData "SAMLOptionsInput" "Amazonka.OpenSearch.Types.SAMLOptionsInput" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "SAMLOptionsInput'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "idp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SAMLIdp)) :: S1 ('MetaSel ('Just "masterBackendRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "masterUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "rolesKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sessionTimeoutMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "subjectKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSAMLOptionsInput :: SAMLOptionsInput Source #

Create a value of SAMLOptionsInput 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:enabled:SAMLOptionsInput', sAMLOptionsInput_enabled - True to enable SAML authentication for a domain.

$sel:idp:SAMLOptionsInput', sAMLOptionsInput_idp - The SAML Identity Provider's information.

$sel:masterBackendRole:SAMLOptionsInput', sAMLOptionsInput_masterBackendRole - The backend role that the SAML master user is mapped to.

$sel:masterUserName:SAMLOptionsInput', sAMLOptionsInput_masterUserName - The SAML master user name, which is stored in the domain's internal user database.

$sel:rolesKey:SAMLOptionsInput', sAMLOptionsInput_rolesKey - Element of the SAML assertion to use for backend roles. Default is roles.

$sel:sessionTimeoutMinutes:SAMLOptionsInput', sAMLOptionsInput_sessionTimeoutMinutes - The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

$sel:subjectKey:SAMLOptionsInput', sAMLOptionsInput_subjectKey - Element of the SAML assertion to use for the user name. Default is NameID.

sAMLOptionsInput_enabled :: Lens' SAMLOptionsInput (Maybe Bool) Source #

True to enable SAML authentication for a domain.

sAMLOptionsInput_idp :: Lens' SAMLOptionsInput (Maybe SAMLIdp) Source #

The SAML Identity Provider's information.

sAMLOptionsInput_masterBackendRole :: Lens' SAMLOptionsInput (Maybe Text) Source #

The backend role that the SAML master user is mapped to.

sAMLOptionsInput_masterUserName :: Lens' SAMLOptionsInput (Maybe Text) Source #

The SAML master user name, which is stored in the domain's internal user database.

sAMLOptionsInput_rolesKey :: Lens' SAMLOptionsInput (Maybe Text) Source #

Element of the SAML assertion to use for backend roles. Default is roles.

sAMLOptionsInput_sessionTimeoutMinutes :: Lens' SAMLOptionsInput (Maybe Int) Source #

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

sAMLOptionsInput_subjectKey :: Lens' SAMLOptionsInput (Maybe Text) Source #

Element of the SAML assertion to use for the user name. Default is NameID.