DomainConfig ¶

class DomainConfig(TypedDict, closed=True):
    engine_version: NotRequired["capo_opensearch.types.version_status.VersionStatus"]
    """<p>The OpenSearch or Elasticsearch version that the domain is running.</p>"""
    cluster_config: NotRequired[
        "capo_opensearch.types.cluster_config_status.ClusterConfigStatus"
    ]
    """<p>Container for the cluster configuration of a the domain.</p>"""
    ebs_options: NotRequired[
        "capo_opensearch.types.ebs_options_status.EBSOptionsStatus"
    ]
    """<p>Container for EBS options configured for the domain.</p>"""
    access_policies: NotRequired[
        "capo_opensearch.types.access_policies_status.AccessPoliciesStatus"
    ]
    """<p>Specifies the access policies for the domain.</p>"""
    ip_address_type: NotRequired[
        "capo_opensearch.types.ip_address_type_status.IPAddressTypeStatus"
    ]
    """<p>Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.</p>"""
    snapshot_options: NotRequired[
        "capo_opensearch.types.snapshot_options_status.SnapshotOptionsStatus"
    ]
    """<p>DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.</p>"""
    vpc_options: NotRequired[
        "capo_opensearch.types.vpc_derived_info_status.VPCDerivedInfoStatus"
    ]
    """<p>The current VPC options for the domain and the status of any updates to their configuration.</p>"""
    cognito_options: NotRequired[
        "capo_opensearch.types.cognito_options_status.CognitoOptionsStatus"
    ]
    """<p>Container for Amazon Cognito options for the domain.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_opensearch.types.encryption_at_rest_options_status.EncryptionAtRestOptionsStatus"
    ]
    """<p>Key-value pairs to enable encryption at rest.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_opensearch.types.node_to_node_encryption_options_status.NodeToNodeEncryptionOptionsStatus"
    ]
    """<p>Whether node-to-node encryption is enabled or disabled.</p>"""
    advanced_options: NotRequired[
        "capo_opensearch.types.advanced_options_status.AdvancedOptionsStatus"
    ]
    """<p>Key-value pairs to specify advanced configuration options. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced options</a>.</p>"""
    log_publishing_options: NotRequired[
        "capo_opensearch.types.log_publishing_options_status.LogPublishingOptionsStatus"
    ]
    """<p>Key-value pairs to configure log publishing.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_opensearch.types.domain_endpoint_options_status.DomainEndpointOptionsStatus"
    ]
    """<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_status.AdvancedSecurityOptionsStatus"
    ]
    """<p>Container for fine-grained access control settings for the domain.</p>"""
    identity_center_options: NotRequired[
        "capo_opensearch.types.identity_center_options_status.IdentityCenterOptionsStatus"
    ]
    """<p>Configuration options for enabling and managing IAM Identity Center integration within a domain.</p>"""
    auto_tune_options: NotRequired[
        "capo_opensearch.types.auto_tune_options_status.AutoTuneOptionsStatus"
    ]
    """<p>Container for Auto-Tune settings for the domain.</p>"""
    change_progress_details: NotRequired[
        "capo_opensearch.types.change_progress_details.ChangeProgressDetails"
    ]
    """<p>Container for information about the progress of an existing configuration change.</p>"""
    off_peak_window_options: NotRequired[
        "capo_opensearch.types.off_peak_window_options_status.OffPeakWindowOptionsStatus"
    ]
    """<p>Container for off-peak window options for the domain.</p>"""
    software_update_options: NotRequired[
        "capo_opensearch.types.software_update_options_status.SoftwareUpdateOptionsStatus"
    ]
    """<p>Software update options 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_status.AIMLOptionsStatus"
    ]
    """<p>Container for parameters required to enable all machine learning features.</p>"""
    deployment_strategy_options: NotRequired[
        "capo_opensearch.types.deployment_strategy_options_status.DeploymentStrategyOptionsStatus"
    ]
    """<p>Specifies <code>DeploymentStrategyOptions</code> for the domain.</p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_opensearch.types.automated_snapshot_pause_options_status.AutomatedSnapshotPauseOptionsStatus"
    ]
    """<p>Specifies <code>AutomatedSnapshotPauseOptions</code> for the domain.</p>"""
    use_case: NotRequired["capo_opensearch.types.use_case_status.UseCaseStatus"]
    """<p>The use case configured for the domain.</p>"""
    engine_mode: NotRequired[
        "capo_opensearch.types.engine_mode_status.EngineModeStatus"
    ]
    """<p>The engine mode configured for the domain.</p>"""