Skip to content

AdvancedSecurityOptions

Source code in docs_src/capo_opensearch/types/advanced_security_options.py
class AdvancedSecurityOptions(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if fine-grained access control is enabled.</p>"""
    internal_user_database_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if the internal user database is enabled.</p>"""
    saml_options: NotRequired[
        "capo_opensearch.types.saml_options_output.SAMLOptionsOutput"
    ]
    """<p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>"""
    jwt_options: NotRequired[
        "capo_opensearch.types.jwt_options_output.JWTOptionsOutput"
    ]
    """<p>Container for information about the JWT configuration of the Amazon OpenSearch Service.</p>"""
    iam_federation_options: NotRequired[
        "capo_opensearch.types.iam_federation_options_output.IAMFederationOptionsOutput"
    ]
    """<p>Configuration options for IAM identity federation in advanced security settings.</p>"""
    anonymous_auth_disable_date: NotRequired[
        "capo_opensearch.types.disable_timestamp.DisableTimestamp"
    ]
    """<p>Date and time when the migration period will be disabled. 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: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if a 30-day migration period is enabled, 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_disable_date instance-attribute

anonymous_auth_disable_date: NotRequired[DisableTimestamp]

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

anonymous_auth_enabled instance-attribute

anonymous_auth_enabled: NotRequired[Boolean]

True if a 30-day migration period is enabled, 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 if fine-grained access control is enabled.

iam_federation_options instance-attribute

iam_federation_options: NotRequired[IAMFederationOptionsOutput]

Configuration options for IAM identity federation in advanced security settings.

internal_user_database_enabled instance-attribute

internal_user_database_enabled: NotRequired[Boolean]

True if the internal user database is enabled.

jwt_options instance-attribute

jwt_options: NotRequired[JWTOptionsOutput]

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

saml_options instance-attribute

saml_options: NotRequired[SAMLOptionsOutput]

Container for information about the SAML configuration for OpenSearch Dashboards.