ElasticsearchDomainStatus ¶

class ElasticsearchDomainStatus(TypedDict, closed=True):
    domain_id: "capo_elasticsearch_service.types.domain_id.DomainId"
    """<p>The unique identifier for the specified Elasticsearch domain.</p>"""
    domain_name: "capo_elasticsearch_service.types.domain_name.DomainName"
    """<p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>"""
    arn: "capo_elasticsearch_service.types.arn.ARN"
    """<p>The Amazon resource name (ARN) of an Elasticsearch domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>"""
    created: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>The domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.</p>"""
    deleted: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>The domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.</p>"""
    endpoint: NotRequired["capo_elasticsearch_service.types.service_url.ServiceUrl"]
    """<p>The Elasticsearch domain endpoint that you use to submit index and search requests.</p>"""
    endpoints: NotRequired[
        "capo_elasticsearch_service.types.endpoints_map.EndpointsMap"
    ]
    """<p>Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>"""
    processing: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>"""
    upgrade_processing: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>The status of an Elasticsearch domain version upgrade. <code>True</code> if Amazon Elasticsearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active.</p>"""
    elasticsearch_version: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_version_string.ElasticsearchVersionString"
    ]
    elasticsearch_cluster_config: "capo_elasticsearch_service.types.elasticsearch_cluster_config.ElasticsearchClusterConfig"
    """<p>The type and number of instances in the domain cluster.</p>"""
    ebs_options: NotRequired["capo_elasticsearch_service.types.ebs_options.EBSOptions"]
    """<p>The <code>EBSOptions</code> for the specified domain. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs" target="_blank">Configuring EBS-based Storage</a> for more information.</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>Specifies the status of the <code>SnapshotOptions</code></p>"""
    vpc_options: NotRequired[
        "capo_elasticsearch_service.types.vpc_derived_info.VPCDerivedInfo"
    ]
    """<p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html" target="_blank">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>"""
    cognito_options: NotRequired[
        "capo_elasticsearch_service.types.cognito_options.CognitoOptions"
    ]
    """<p>The <code>CognitoOptions</code> for the specified domain. 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 status of the <code>EncryptionAtRestOptions</code>.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_elasticsearch_service.types.node_to_node_encryption_options.NodeToNodeEncryptionOptions"
    ]
    """<p>Specifies the status of the <code>NodeToNodeEncryptionOptions</code>.</p>"""
    advanced_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_options.AdvancedOptions"
    ]
    """<p>Specifies the status of the <code>AdvancedOptions</code></p>"""
    log_publishing_options: NotRequired[
        "capo_elasticsearch_service.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Log publishing options for the given domain.</p>"""
    service_software_options: NotRequired[
        "capo_elasticsearch_service.types.service_software_options.ServiceSoftwareOptions"
    ]
    """<p>The current status of the Elasticsearch domain's service software.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_elasticsearch_service.types.domain_endpoint_options.DomainEndpointOptions"
    ]
    """<p>The current status of the Elasticsearch domain's endpoint options.</p>"""
    advanced_security_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_security_options.AdvancedSecurityOptions"
    ]
    """<p>The current status of the Elasticsearch domain's advanced security options.</p>"""
    auto_tune_options: NotRequired[
        "capo_elasticsearch_service.types.auto_tune_options_output.AutoTuneOptionsOutput"
    ]
    """<p>The current status of the Elasticsearch domain's Auto-Tune options.</p>"""
    change_progress_details: NotRequired[
        "capo_elasticsearch_service.types.change_progress_details.ChangeProgressDetails"
    ]
    """<p>Specifies change details of the domain configuration change.</p>"""
    domain_processing_status: NotRequired[
        "capo_elasticsearch_service.types.domain_processing_status_type.DomainProcessingStatusType"
    ]
    """<p>The status of any changes that are currently in progress for the domain.</p>"""
    modifying_properties: NotRequired[
        "capo_elasticsearch_service.types.modifying_properties_list.ModifyingPropertiesList"
    ]
    """<p>Information about the domain properties that are currently being modified.</p>"""
    deployment_strategy_options: NotRequired[
        "capo_elasticsearch_service.types.deployment_strategy_options.DeploymentStrategyOptions"
    ]
    """<p>The current status of the Elasticsearch domain's deployment strategy options.</p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_elasticsearch_service.types.automated_snapshot_pause_options.AutomatedSnapshotPauseOptions"
    ]
    """<p>The current status of the Elasticsearch domain's automated snapshot pause options.</p>"""
    use_case: NotRequired[
        "capo_elasticsearch_service.types.domain_use_case.DomainUseCase"
    ]
    """<p>The primary use case for the domain.</p>"""
    engine_mode: NotRequired[
        "capo_elasticsearch_service.types.domain_engine_mode.DomainEngineMode"
    ]
    """<p>The engine mode for the domain.</p>"""