libZSservicesZSamazonka-opensearchZSamazonka-opensearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpenSearch.Types.SAMLOptionsInput

Description

 
Synopsis

Documentation

data SAMLOptionsInput Source #

The SAML application configuration for the domain.

See: newSAMLOptionsInput smart constructor.

Constructors

SAMLOptionsInput' 

Fields

Instances

Instances details
Eq SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

Show SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

Generic SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

Associated Types

type Rep SAMLOptionsInput :: Type -> Type #

NFData SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

Methods

rnf :: SAMLOptionsInput -> () #

Hashable SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

ToJSON SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

type Rep SAMLOptionsInput Source # 
Instance details

Defined in Amazonka.OpenSearch.Types.SAMLOptionsInput

type Rep SAMLOptionsInput = D1 ('MetaData "SAMLOptionsInput" "Amazonka.OpenSearch.Types.SAMLOptionsInput" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "SAMLOptionsInput'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "masterUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "idp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SAMLIdp)))) :*: ((S1 ('MetaSel ('Just "rolesKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "masterBackendRole") '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:masterUserName:SAMLOptionsInput', sAMLOptionsInput_masterUserName - The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

$sel:enabled:SAMLOptionsInput', sAMLOptionsInput_enabled - True if SAML is enabled.

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

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

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

$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 username. Default is NameID.

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

The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

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

The SAML Identity Provider's information.

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

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

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

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

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 username. Default is NameID.