CapacityConfig

class aws_cdk.aws_opensearchservice.CapacityConfig(*, data_node_instance_type=None, data_nodes=None, master_node_instance_type=None, master_nodes=None, multi_az_with_standby_enabled=None, node_options=None, warm_instance_type=None, warm_nodes=None)

Bases: object

Configures the capacity of the cluster such as the instance type and the number of instances.

Parameters:

data_node_instance_type (Optional[str]) – The instance type for your data nodes, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide. Default: - r5.large.search
data_nodes (Union[int, float, None]) – The number of data nodes (instances) to use in the Amazon OpenSearch Service domain. Default: - 1
master_node_instance_type (Optional[str]) –
The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide. Default: - r5.large.search
master_nodes (Union[int, float, None]) – The number of instances to use for the master node. Default: - no dedicated master nodes
multi_az_with_standby_enabled (Optional[bool]) – Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby Default: - multi-az with standby if the feature flag ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY is true, no multi-az with standby otherwise
node_options (Optional[Sequence[Union[NodeOptions, Dict[str, Any]]]]) – Additional node options for the domain. Default: - no additional node options
warm_instance_type (Optional[str]) – The instance type for your UltraWarm node, such as ultrawarm1.medium.search. For valid values, see UltraWarm Storage Limits in the Amazon OpenSearch Service Developer Guide. Default: - ultrawarm1.medium.search
warm_nodes (Union[int, float, None]) – The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain. Default: - no UltraWarm nodes

ExampleMetadata:

infused

Example:

import aws_cdk.aws_opensearchservice as opensearch


domain = Domain(self, "Domain",
    version=EngineVersion.OPENSEARCH_1_3,
    capacity=opensearch.CapacityConfig(
        node_options=[opensearch.NodeOptions(
            node_type=opensearch.NodeType.COORDINATOR,
            node_config=opensearch.NodeConfig(
                enabled=True,
                count=2,
                type="m5.large.search"
            )
        )
        ]
    )
)

Attributes

data_node_instance_type

The instance type for your data nodes, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.

Default:

r5.large.search

data_nodes

The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.

Default:

1

master_node_instance_type

The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.

Default:

r5.large.search

master_nodes

The number of instances to use for the master node.

Default:

no dedicated master nodes

multi_az_with_standby_enabled

Indicates whether Multi-AZ with Standby deployment option is enabled.

For more information, see Multi-AZ with Standby

Default:

multi-az with standby if the feature flag ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY

is true, no multi-az with standby otherwise

node_options

Additional node options for the domain.

Default:

no additional node options

warm_instance_type

The instance type for your UltraWarm node, such as ultrawarm1.medium.search. For valid values, see UltraWarm Storage Limits in the Amazon OpenSearch Service Developer Guide.

Default:

ultrawarm1.medium.search

warm_nodes

The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.

Default:

no UltraWarm nodes