Skip to content

ElasticsearchDomainConfig

Source code in docs_src/capo_elasticsearch_service/types/elasticsearch_domain_config.py
class ElasticsearchDomainConfig(TypedDict, closed=True):
    elasticsearch_version: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_version_status.ElasticsearchVersionStatus"
    ]
    """<p>String of format X.Y to specify version for the Elasticsearch domain.</p>"""
    elasticsearch_cluster_config: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_cluster_config_status.ElasticsearchClusterConfigStatus"
    ]
    """<p>Specifies the <code>ElasticsearchClusterConfig</code> for the Elasticsearch domain.</p>"""
    ebs_options: NotRequired[
        "capo_elasticsearch_service.types.ebs_options_status.EBSOptionsStatus"
    ]
    """<p>Specifies the <code>EBSOptions</code> for the Elasticsearch domain.</p>"""
    access_policies: NotRequired[
        "capo_elasticsearch_service.types.access_policies_status.AccessPoliciesStatus"
    ]
    """<p>IAM access policy as a JSON-formatted string.</p>"""
    snapshot_options: NotRequired[
        "capo_elasticsearch_service.types.snapshot_options_status.SnapshotOptionsStatus"
    ]
    """<p>Specifies the <code>SnapshotOptions</code> for the Elasticsearch domain.</p>"""
    vpc_options: NotRequired[
        "capo_elasticsearch_service.types.vpc_derived_info_status.VPCDerivedInfoStatus"
    ]
    """<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_status.CognitoOptionsStatus"
    ]
    """<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_status.EncryptionAtRestOptionsStatus"
    ]
    """<p>Specifies the <code>EncryptionAtRestOptions</code> for the Elasticsearch domain.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_elasticsearch_service.types.node_to_node_encryption_options_status.NodeToNodeEncryptionOptionsStatus"
    ]
    """<p>Specifies the <code>NodeToNodeEncryptionOptions</code> for the Elasticsearch domain.</p>"""
    advanced_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_options_status.AdvancedOptionsStatus"
    ]
    """<p>Specifies the <code>AdvancedOptions</code> for the domain. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuring Advanced Options</a> for more information.</p>"""
    log_publishing_options: NotRequired[
        "capo_elasticsearch_service.types.log_publishing_options_status.LogPublishingOptionsStatus"
    ]
    """<p>Log publishing options for the given domain.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_elasticsearch_service.types.domain_endpoint_options_status.DomainEndpointOptionsStatus"
    ]
    """<p>Specifies the <code>DomainEndpointOptions</code> for the Elasticsearch domain.</p>"""
    advanced_security_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_security_options_status.AdvancedSecurityOptionsStatus"
    ]
    """<p>Specifies <code>AdvancedSecurityOptions</code> for the domain. </p>"""
    auto_tune_options: NotRequired[
        "capo_elasticsearch_service.types.auto_tune_options_status.AutoTuneOptionsStatus"
    ]
    """<p>Specifies <code>AutoTuneOptions</code> for the domain. </p>"""
    change_progress_details: NotRequired[
        "capo_elasticsearch_service.types.change_progress_details.ChangeProgressDetails"
    ]
    """<p>Specifies change details of the domain configuration change.</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_status.DeploymentStrategyOptionsStatus"
    ]
    """<p>Specifies <code>DeploymentStrategyOptions</code> for the domain. </p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_elasticsearch_service.types.automated_snapshot_pause_options_status.AutomatedSnapshotPauseOptionsStatus"
    ]
    """<p>Specifies <code>AutomatedSnapshotPauseOptions</code> for the domain. </p>"""
    use_case: NotRequired[
        "capo_elasticsearch_service.types.use_case_status.UseCaseStatus"
    ]
    """<p>The use case configured for the domain.</p>"""
    engine_mode: NotRequired[
        "capo_elasticsearch_service.types.engine_mode_status.EngineModeStatus"
    ]
    """<p>The engine mode configured for the domain.</p>"""

access_policies instance-attribute

access_policies: NotRequired[AccessPoliciesStatus]

IAM access policy as a JSON-formatted string.

advanced_options instance-attribute

advanced_options: NotRequired[AdvancedOptionsStatus]

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

advanced_security_options instance-attribute

advanced_security_options: NotRequired[AdvancedSecurityOptionsStatus]

Specifies AdvancedSecurityOptions for the domain.

auto_tune_options instance-attribute

auto_tune_options: NotRequired[AutoTuneOptionsStatus]

Specifies AutoTuneOptions for the domain.

automated_snapshot_pause_options instance-attribute

automated_snapshot_pause_options: NotRequired[AutomatedSnapshotPauseOptionsStatus]

Specifies AutomatedSnapshotPauseOptions for the domain.

change_progress_details instance-attribute

change_progress_details: NotRequired[ChangeProgressDetails]

Specifies change details of the domain configuration change.

cognito_options instance-attribute

cognito_options: NotRequired[CognitoOptionsStatus]

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

deployment_strategy_options instance-attribute

deployment_strategy_options: NotRequired[DeploymentStrategyOptionsStatus]

Specifies DeploymentStrategyOptions for the domain.

domain_endpoint_options instance-attribute

domain_endpoint_options: NotRequired[DomainEndpointOptionsStatus]

Specifies the DomainEndpointOptions for the Elasticsearch domain.

ebs_options instance-attribute

ebs_options: NotRequired[EBSOptionsStatus]

Specifies the EBSOptions for the Elasticsearch domain.

elasticsearch_cluster_config instance-attribute

elasticsearch_cluster_config: NotRequired[ElasticsearchClusterConfigStatus]

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

elasticsearch_version instance-attribute

elasticsearch_version: NotRequired[ElasticsearchVersionStatus]

String of format X.Y to specify version for the Elasticsearch domain.

encryption_at_rest_options instance-attribute

encryption_at_rest_options: NotRequired[EncryptionAtRestOptionsStatus]

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

engine_mode instance-attribute

engine_mode: NotRequired[EngineModeStatus]

The engine mode configured for the domain.

log_publishing_options instance-attribute

log_publishing_options: NotRequired[LogPublishingOptionsStatus]

Log publishing options for the given domain.

modifying_properties instance-attribute

modifying_properties: NotRequired[ModifyingPropertiesList]

Information about the domain properties that are currently being modified.

node_to_node_encryption_options instance-attribute

node_to_node_encryption_options: NotRequired[NodeToNodeEncryptionOptionsStatus]

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

snapshot_options instance-attribute

snapshot_options: NotRequired[SnapshotOptionsStatus]

Specifies the SnapshotOptions for the Elasticsearch domain.

use_case instance-attribute

use_case: NotRequired[UseCaseStatus]

The use case configured for the domain.

vpc_options instance-attribute

vpc_options: NotRequired[VPCDerivedInfoStatus]

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.