ClusterConfig ¶

class ClusterConfig(TypedDict, closed=True):
    instance_type: NotRequired[
        "capo_opensearch.types.open_search_partition_instance_type.OpenSearchPartitionInstanceType"
    ]
    """<p>Instance type of data nodes in the cluster.</p>"""
    instance_count: NotRequired["capo_opensearch.types.integer_class.IntegerClass"]
    """<p>Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.</p>"""
    dedicated_master_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code> if the cluster will use a dedicated master node.<code>False</code> if the cluster will not.</p>"""
    zone_awareness_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Indicates whether multiple Availability Zones are enabled. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>.</p>"""
    zone_awareness_config: NotRequired[
        "capo_opensearch.types.zone_awareness_config.ZoneAwarenessConfig"
    ]
    """<p>Container for zone awareness configuration options. Only required if <code>ZoneAwarenessEnabled</code> is <code>true</code>.</p>"""
    dedicated_master_type: NotRequired[
        "capo_opensearch.types.open_search_partition_instance_type.OpenSearchPartitionInstanceType"
    ]
    """<p>OpenSearch Service instance type of the dedicated master nodes in the cluster.</p>"""
    dedicated_master_count: NotRequired[
        "capo_opensearch.types.integer_class.IntegerClass"
    ]
    """<p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.</p>"""
    warm_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether to enable warm storage for the cluster.</p>"""
    warm_type: NotRequired[
        "capo_opensearch.types.open_search_warm_partition_instance_type.OpenSearchWarmPartitionInstanceType"
    ]
    """<p>The instance type for the cluster's warm nodes.</p>"""
    warm_count: NotRequired["capo_opensearch.types.integer_class.IntegerClass"]
    """<p>The number of warm nodes in the cluster.</p>"""
    cold_storage_options: NotRequired[
        "capo_opensearch.types.cold_storage_options.ColdStorageOptions"
    ]
    """<p>Container for cold storage configuration options.</p>"""
    multi_az_with_standby_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </p>"""
    node_options: NotRequired["capo_opensearch.types.node_options_list.NodeOptionsList"]
    """<p>List of node options for the domain.</p>"""