CreateElasticsearchDomainRequest ¶

class CreateElasticsearchDomainRequest(TypedDict, closed=True):
    domain_name: "capo_elasticsearch_service.types.domain_name.DomainName"
    """<p>The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>"""
    elasticsearch_version: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_version_string.ElasticsearchVersionString"
    ]
    """<p>String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>"""
    elasticsearch_cluster_config: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_cluster_config.ElasticsearchClusterConfig"
    ]
    """<p>Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. </p>"""
    ebs_options: NotRequired["capo_elasticsearch_service.types.ebs_options.EBSOptions"]
    """<p>Options to enable, disable and specify the type and size of EBS storage volumes. </p>"""
    access_policies: NotRequired[
        "capo_elasticsearch_service.types.policy_document.PolicyDocument"
    ]
    """<p> IAM access policy as a JSON-formatted string.</p>"""
    snapshot_options: NotRequired[
        "capo_elasticsearch_service.types.snapshot_options.SnapshotOptions"
    ]
    """<p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. </p>"""
    vpc_options: NotRequired["capo_elasticsearch_service.types.vpc_options.VPCOptions"]
    """<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc" target="_blank">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>"""
    cognito_options: NotRequired[
        "capo_elasticsearch_service.types.cognito_options.CognitoOptions"
    ]
    """<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_elasticsearch_service.types.encryption_at_rest_options.EncryptionAtRestOptions"
    ]
    """<p>Specifies the Encryption At Rest Options.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_elasticsearch_service.types.node_to_node_encryption_options.NodeToNodeEncryptionOptions"
    ]
    """<p>Specifies the NodeToNodeEncryptionOptions.</p>"""
    advanced_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_options.AdvancedOptions"
    ]
    """<p> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</p>"""
    log_publishing_options: NotRequired[
        "capo_elasticsearch_service.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_elasticsearch_service.types.domain_endpoint_options.DomainEndpointOptions"
    ]
    """<p>Options to specify configuration that will be applied to the domain endpoint.</p>"""
    advanced_security_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_security_options_input.AdvancedSecurityOptionsInput"
    ]
    """<p>Specifies advanced security options.</p>"""
    auto_tune_options: NotRequired[
        "capo_elasticsearch_service.types.auto_tune_options_input.AutoTuneOptionsInput"
    ]
    """<p>Specifies Auto-Tune options.</p>"""
    tag_list: NotRequired["capo_elasticsearch_service.types.tag_list.TagList"]
    """<p>A list of <code>Tag</code> added during domain creation.</p>"""
    deployment_strategy_options: NotRequired[
        "capo_elasticsearch_service.types.deployment_strategy_options.DeploymentStrategyOptions"
    ]
    """<p>Specifies the deployment strategy options.</p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_elasticsearch_service.types.automated_snapshot_pause_request_options.AutomatedSnapshotPauseRequestOptions"
    ]
    """<p>Specifies the automated snapshot pause options for the domain.</p> <important> <p>Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.</p> </important> <p>Maximum suspension duration: 3 days.</p>"""
    use_case: NotRequired[
        "capo_elasticsearch_service.types.domain_use_case.DomainUseCase"
    ]
    """<p>The primary use case for the domain. For valid values, see <code>DomainUseCase</code>.</p>"""
    engine_mode: NotRequired[
        "capo_elasticsearch_service.types.domain_engine_mode.DomainEngineMode"
    ]
    """<p>The engine mode for the domain. For valid values and requirements, see <code>DomainEngineMode</code>.</p>"""