DomainStatus ¶

class DomainStatus(TypedDict, closed=True):
    domain_id: "capo_opensearch.types.domain_id.DomainId"
    """<p>Unique identifier for the domain.</p>"""
    domain_name: "capo_opensearch.types.domain_name.DomainName"
    """<p>Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.</p>"""
    arn: "capo_opensearch.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM identifiers </a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>"""
    created: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.</p>"""
    deleted: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.</p>"""
    endpoint: NotRequired["capo_opensearch.types.service_url.ServiceUrl"]
    """<p>Domain-specific endpoint used to submit index, search, and data upload requests to the domain.</p>"""
    endpoint_v2: NotRequired["capo_opensearch.types.service_url.ServiceUrl"]
    """<p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. </p>"""
    endpoints: NotRequired["capo_opensearch.types.endpoints_map.EndpointsMap"]
    """<p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:</p> <ul> <li> <p> <b>IPv4 IP addresses</b> - <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code> </p> </li> <li> <p> <b>Dual stack IP addresses</b> - <code>'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'</code> </p> </li> </ul>"""
    domain_endpoint_v2_hosted_zone_id: NotRequired[
        "capo_opensearch.types.hosted_zone_id.HostedZoneId"
    ]
    """<p>The dual stack hosted zone ID for the domain. </p>"""
    processing: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.</p>"""
    upgrade_processing: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.</p>"""
    engine_version: NotRequired["capo_opensearch.types.version_string.VersionString"]
    """<p>Version of OpenSearch or Elasticsearch that the domain is running, in the format <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>"""
    cluster_config: "capo_opensearch.types.cluster_config.ClusterConfig"
    """<p>Container for the cluster configuration of the domain.</p>"""
    ebs_options: NotRequired["capo_opensearch.types.ebs_options.EBSOptions"]
    """<p>Container for EBS-based storage settings for the domain.</p>"""
    access_policies: NotRequired["capo_opensearch.types.policy_document.PolicyDocument"]
    """<p>Identity and Access Management (IAM) policy document specifying the access policies for the domain.</p>"""
    ip_address_type: NotRequired["capo_opensearch.types.ip_address_type.IPAddressType"]
    """<p>The type of IP addresses supported by the endpoint for the domain.</p>"""
    snapshot_options: NotRequired[
        "capo_opensearch.types.snapshot_options.SnapshotOptions"
    ]
    """<p>DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.</p>"""
    vpc_options: NotRequired["capo_opensearch.types.vpc_derived_info.VPCDerivedInfo"]
    """<p>The VPC configuration for the domain.</p>"""
    cognito_options: NotRequired["capo_opensearch.types.cognito_options.CognitoOptions"]
    """<p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_opensearch.types.encryption_at_rest_options.EncryptionAtRestOptions"
    ]
    """<p>Encryption at rest settings for the domain.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_opensearch.types.node_to_node_encryption_options.NodeToNodeEncryptionOptions"
    ]
    """<p>Whether node-to-node encryption is enabled or disabled.</p>"""
    advanced_options: NotRequired[
        "capo_opensearch.types.advanced_options.AdvancedOptions"
    ]
    """<p>Key-value pairs that specify advanced configuration options.</p>"""
    log_publishing_options: NotRequired[
        "capo_opensearch.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Log publishing options for the domain.</p>"""
    service_software_options: NotRequired[
        "capo_opensearch.types.service_software_options.ServiceSoftwareOptions"
    ]
    """<p>The current status of the domain's service software.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_opensearch.types.domain_endpoint_options.DomainEndpointOptions"
    ]
    """<p>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.</p>"""
    advanced_security_options: NotRequired[
        "capo_opensearch.types.advanced_security_options.AdvancedSecurityOptions"
    ]
    """<p>Settings for fine-grained access control.</p>"""
    identity_center_options: NotRequired[
        "capo_opensearch.types.identity_center_options.IdentityCenterOptions"
    ]
    """<p>Configuration options for controlling IAM Identity Center integration within a domain.</p>"""
    auto_tune_options: NotRequired[
        "capo_opensearch.types.auto_tune_options_output.AutoTuneOptionsOutput"
    ]
    """<p>Auto-Tune settings for the domain.</p>"""
    change_progress_details: NotRequired[
        "capo_opensearch.types.change_progress_details.ChangeProgressDetails"
    ]
    """<p>Information about a configuration change happening on the domain.</p>"""
    off_peak_window_options: NotRequired[
        "capo_opensearch.types.off_peak_window_options.OffPeakWindowOptions"
    ]
    """<p>Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.</p>"""
    software_update_options: NotRequired[
        "capo_opensearch.types.software_update_options.SoftwareUpdateOptions"
    ]
    """<p>Service software update options for the domain.</p>"""
    domain_processing_status: NotRequired[
        "capo_opensearch.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_opensearch.types.modifying_properties_list.ModifyingPropertiesList"
    ]
    """<p>Information about the domain properties that are currently being modified.</p>"""
    aiml_options: NotRequired[
        "capo_opensearch.types.aiml_options_output.AIMLOptionsOutput"
    ]
    """<p>Container for parameters required to enable all machine learning features.</p>"""
    deployment_strategy_options: NotRequired[
        "capo_opensearch.types.deployment_strategy_options.DeploymentStrategyOptions"
    ]
    """<p>The current status of the domain's deployment strategy options.</p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_opensearch.types.automated_snapshot_pause_options.AutomatedSnapshotPauseOptions"
    ]
    """<p>The current status of the domain's automated snapshot pause options.</p>"""
    use_case: NotRequired["capo_opensearch.types.domain_use_case.DomainUseCase"]
    """<p>The primary use case for the domain.</p>"""
    engine_mode: NotRequired["capo_opensearch.types.engine_mode.EngineMode"]
    """<p>The engine mode for the domain.</p>"""