Skip to content

ElasticsearchClusterConfig

Source code in docs_src/capo_elasticsearch_service/types/elasticsearch_cluster_config.py
class ElasticsearchClusterConfig(TypedDict, closed=True):
    instance_type: NotRequired[
        "capo_elasticsearch_service.types.es_partition_instance_type.ESPartitionInstanceType"
    ]
    """<p>The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.</p>"""
    instance_count: NotRequired[
        "capo_elasticsearch_service.types.integer_class.IntegerClass"
    ]
    """<p>The number of instances in the specified domain cluster.</p>"""
    dedicated_master_enabled: NotRequired[
        "capo_elasticsearch_service.types.boolean.Boolean"
    ]
    """<p>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</p>"""
    zone_awareness_enabled: NotRequired[
        "capo_elasticsearch_service.types.boolean.Boolean"
    ]
    """<p>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</p>"""
    zone_awareness_config: NotRequired[
        "capo_elasticsearch_service.types.zone_awareness_config.ZoneAwarenessConfig"
    ]
    """<p>Specifies the zone awareness configuration for a domain when zone awareness is enabled.</p>"""
    dedicated_master_type: NotRequired[
        "capo_elasticsearch_service.types.es_partition_instance_type.ESPartitionInstanceType"
    ]
    """<p>The instance type for a dedicated master node.</p>"""
    dedicated_master_count: NotRequired[
        "capo_elasticsearch_service.types.integer_class.IntegerClass"
    ]
    """<p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>"""
    warm_enabled: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>True to enable warm storage.</p>"""
    warm_type: NotRequired[
        "capo_elasticsearch_service.types.es_warm_partition_instance_type.ESWarmPartitionInstanceType"
    ]
    """<p>The instance type for the Elasticsearch cluster's warm nodes.</p>"""
    warm_count: NotRequired[
        "capo_elasticsearch_service.types.integer_class.IntegerClass"
    ]
    """<p>The number of warm nodes in the cluster.</p>"""
    cold_storage_options: NotRequired[
        "capo_elasticsearch_service.types.cold_storage_options.ColdStorageOptions"
    ]
    """<p>Specifies the <code>ColdStorageOptions</code> config for Elasticsearch Domain</p>"""

cold_storage_options instance-attribute

cold_storage_options: NotRequired[ColdStorageOptions]

Specifies the ColdStorageOptions config for Elasticsearch Domain

dedicated_master_count instance-attribute

dedicated_master_count: NotRequired[IntegerClass]

Total number of dedicated master nodes, active and on standby, for the cluster.

dedicated_master_enabled instance-attribute

dedicated_master_enabled: NotRequired[Boolean]

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

dedicated_master_type instance-attribute

dedicated_master_type: NotRequired[ESPartitionInstanceType]

The instance type for a dedicated master node.

instance_count instance-attribute

instance_count: NotRequired[IntegerClass]

The number of instances in the specified domain cluster.

instance_type instance-attribute

instance_type: NotRequired[ESPartitionInstanceType]

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

warm_count instance-attribute

warm_count: NotRequired[IntegerClass]

The number of warm nodes in the cluster.

warm_enabled instance-attribute

warm_enabled: NotRequired[Boolean]

True to enable warm storage.

warm_type instance-attribute

warm_type: NotRequired[ESWarmPartitionInstanceType]

The instance type for the Elasticsearch cluster's warm nodes.

zone_awareness_config instance-attribute

zone_awareness_config: NotRequired[ZoneAwarenessConfig]

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

zone_awareness_enabled instance-attribute

zone_awareness_enabled: NotRequired[Boolean]

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.