Skip to content

SAMLOptionsInput

Source code in docs_src/capo_elasticsearch_service/types/saml_options_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class SAMLOptionsInput(TypedDict, closed=True):
    enabled: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>True if SAML is enabled.</p>"""
    idp: NotRequired["capo_elasticsearch_service.types.saml_idp.SAMLIdp"]
    """<p>Specifies the SAML Identity Provider's information.</p>"""
    master_user_name: NotRequired["capo_elasticsearch_service.types.username.Username"]
    """<p>The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>"""
    master_backend_role: NotRequired[
        "capo_elasticsearch_service.types.backend_role.BackendRole"
    ]
    """<p>The backend role to which the SAML master user is mapped to.</p>"""
    subject_key: NotRequired["capo_elasticsearch_service.types.string.String"]
    """<p>The key to use for matching the SAML Subject attribute.</p>"""
    roles_key: NotRequired["capo_elasticsearch_service.types.string.String"]
    """<p>The key to use for matching the SAML Roles attribute.</p>"""
    session_timeout_minutes: NotRequired[
        "capo_elasticsearch_service.types.integer_class.IntegerClass"
    ]
    """<p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

True if SAML is enabled.

idp instance-attribute 

idp: NotRequired[SAMLIdp]

Specifies the SAML Identity Provider's information.

master_backend_role instance-attribute 

master_backend_role: NotRequired[BackendRole]

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

master_user_name instance-attribute 

master_user_name: NotRequired[Username]

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

roles_key instance-attribute 

roles_key: NotRequired[String]

The key to use for matching the SAML Roles attribute.

session_timeout_minutes instance-attribute 

session_timeout_minutes: NotRequired[IntegerClass]

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

subject_key instance-attribute 

subject_key: NotRequired[String]

The key to use for matching the SAML Subject attribute.