Skip to content

CreateSecurityConfigRequest

Source code in docs_src/capo_opensearchserverless/types/create_security_config_request.py
class CreateSecurityConfigRequest(TypedDict, closed=True):
    type: "capo_opensearchserverless.types.security_config_type.SecurityConfigType"
    """<p>The type of security configuration.</p>"""
    name: "capo_opensearchserverless.types.config_name.ConfigName"
    """<p>The name of the security configuration.</p>"""
    description: NotRequired[
        "capo_opensearchserverless.types.config_description.ConfigDescription"
    ]
    """<p>A description of the security configuration.</p>"""
    saml_options: NotRequired[
        "capo_opensearchserverless.types.saml_config_options.SamlConfigOptions"
    ]
    """<p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>"""
    iam_identity_center_options: NotRequired[
        "capo_opensearchserverless.types.create_iam_identity_center_config_options.CreateIamIdentityCenterConfigOptions"
    ]
    """<p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>"""
    iam_federation_options: NotRequired[
        "capo_opensearchserverless.types.iam_federation_config_options.IamFederationConfigOptions"
    ]
    """<p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Unique, case-sensitive identifier to ensure idempotency of the request.

description instance-attribute

description: NotRequired[ConfigDescription]

A description of the security configuration.

iam_federation_options instance-attribute

iam_federation_options: NotRequired[IamFederationConfigOptions]

Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.

iam_identity_center_options instance-attribute

iam_identity_center_options: NotRequired[CreateIamIdentityCenterConfigOptions]

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

name instance-attribute

name: ConfigName

The name of the security configuration.

saml_options instance-attribute

saml_options: NotRequired[SamlConfigOptions]

Describes SAML options in the form of a key-value map. This field is required if you specify SAML for the type parameter.

type instance-attribute

The type of security configuration.