Skip to content

CreateApplicationRequest

Source code in docs_src/capo_opensearch/types/create_application_request.py
class CreateApplicationRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_opensearch.types.client_token.ClientToken"]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""
    name: "capo_opensearch.types.application_name.ApplicationName"
    """<p>The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.</p>"""
    data_sources: NotRequired["capo_opensearch.types.data_sources.DataSources"]
    """<p>The data sources to link to the OpenSearch application.</p>"""
    iam_identity_center_options: NotRequired[
        "capo_opensearch.types.iam_identity_center_options_input.IamIdentityCenterOptionsInput"
    ]
    """<p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.</p>"""
    app_configs: NotRequired["capo_opensearch.types.app_configs.AppConfigs"]
    """<p>Configuration settings for the OpenSearch application, including administrative options.</p>"""
    tag_list: NotRequired["capo_opensearch.types.tag_list.TagList"]
    kms_key_arn: NotRequired["capo_opensearch.types.kms_key_arn.KmsKeyArn"]
    """<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application.</p>"""

app_configs instance-attribute

app_configs: NotRequired[AppConfigs]

Configuration settings for the OpenSearch application, including administrative options.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

data_sources instance-attribute

data_sources: NotRequired[DataSources]

The data sources to link to the OpenSearch application.

iam_identity_center_options instance-attribute

iam_identity_center_options: NotRequired[IamIdentityCenterOptionsInput]

Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application.

name instance-attribute

The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

tag_list instance-attribute

tag_list: NotRequired[TagList]