Skip to content

AdvancedSecurityOptionsInput

Source code in docs_src/capo_opensearch/types/advanced_security_options_input.py
class AdvancedSecurityOptionsInput(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable fine-grained access control.</p>"""
    internal_user_database_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable the internal user database.</p>"""
    master_user_options: NotRequired[
        "capo_opensearch.types.master_user_options.MasterUserOptions"
    ]
    """<p>Container for information about the master user.</p>"""
    saml_options: NotRequired[
        "capo_opensearch.types.saml_options_input.SAMLOptionsInput"
    ]
    """<p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>"""
    jwt_options: NotRequired["capo_opensearch.types.jwt_options_input.JWTOptionsInput"]
    """<p>Container for information about the JWT configuration of the Amazon OpenSearch Service. </p>"""
    iam_federation_options: NotRequired[
        "capo_opensearch.types.iam_federation_options_input.IAMFederationOptionsInput"
    ]
    """<p>Input configuration for IAM identity federation within advanced security options.</p>"""
    anonymous_auth_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling fine-grained access control on an existing domain</a>.</p>"""

anonymous_auth_enabled instance-attribute

anonymous_auth_enabled: NotRequired[Boolean]

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

enabled instance-attribute

enabled: NotRequired[Boolean]

True to enable fine-grained access control.

iam_federation_options instance-attribute

iam_federation_options: NotRequired[IAMFederationOptionsInput]

Input configuration for IAM identity federation within advanced security options.

internal_user_database_enabled instance-attribute

internal_user_database_enabled: NotRequired[Boolean]

True to enable the internal user database.

jwt_options instance-attribute

jwt_options: NotRequired[JWTOptionsInput]

Container for information about the JWT configuration of the Amazon OpenSearch Service.

master_user_options instance-attribute

master_user_options: NotRequired[MasterUserOptions]

Container for information about the master user.

saml_options instance-attribute

saml_options: NotRequired[SAMLOptionsInput]

Container for information about the SAML configuration for OpenSearch Dashboards.