Skip to content

IdentityCenterOptions

Source code in docs_src/capo_opensearch/types/identity_center_options.py
class IdentityCenterOptions(TypedDict, closed=True):
    enabled_api_access: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Indicates whether IAM Identity Center is enabled for the application.</p>"""
    identity_center_instance_arn: NotRequired[
        "capo_opensearch.types.identity_center_instance_arn.IdentityCenterInstanceARN"
    ]
    """<p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p>"""
    identity_center_instance_region: NotRequired["capo_opensearch.types.region.Region"]
    """<p>The Region of the IAM Identity Center instance.</p>"""
    subject_key: NotRequired[
        "capo_opensearch.types.subject_key_id_c_option.SubjectKeyIdCOption"
    ]
    """<p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>"""
    roles_key: NotRequired[
        "capo_opensearch.types.roles_key_id_c_option.RolesKeyIdCOption"
    ]
    """<p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>"""
    identity_center_application_arn: NotRequired[
        "capo_opensearch.types.identity_center_application_arn.IdentityCenterApplicationARN"
    ]
    """<p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.</p>"""
    identity_store_id: NotRequired[
        "capo_opensearch.types.identity_store_id.IdentityStoreId"
    ]
    """<p>The identifier of the IAM Identity Store.</p>"""

enabled_api_access instance-attribute

enabled_api_access: NotRequired[Boolean]

Indicates whether IAM Identity Center is enabled for the application.

identity_center_application_arn instance-attribute

identity_center_application_arn: NotRequired[IdentityCenterApplicationARN]

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

identity_center_instance_arn instance-attribute

identity_center_instance_arn: NotRequired[IdentityCenterInstanceARN]

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

identity_center_instance_region instance-attribute

identity_center_instance_region: NotRequired[Region]

The Region of the IAM Identity Center instance.

identity_store_id instance-attribute

identity_store_id: NotRequired[IdentityStoreId]

The identifier of the IAM Identity Store.

roles_key instance-attribute

roles_key: NotRequired[RolesKeyIdCOption]

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

subject_key instance-attribute

subject_key: NotRequired[SubjectKeyIdCOption]

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.