CapacityConfig

class aws_cdk.aws_opensearchservice.CapacityConfig(*, data_node_instance_type=None, data_nodes=None, master_node_instance_type=None, master_nodes=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] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) 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

  • warm_instance_type (Optional[str]) – The instance type for your UltraWarm node, such as ultrawarm1.medium.search. For valid values, see [UltraWarm Storage Limits] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm) 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:

domain = Domain(self, "Domain",
    version=EngineVersion.OPENSEARCH_1_0,
    capacity=CapacityConfig(
        master_nodes=2,
        warm_nodes=2,
        warm_instance_type="ultrawarm1.medium.search"
    )
)

Attributes

data_node_instance_type

//docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html>`_ in the Amazon OpenSearch Service Developer Guide.

Default
  • r5.large.search

Type

The instance type for your data nodes, such as m3.medium.search. For valid values, see `Supported Instance Types <https

Return type

Optional[str]

data_nodes

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

Default
  • 1

Return type

Union[int, float, None]

master_node_instance_type

//docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) in the Amazon OpenSearch Service Developer Guide.

Default
  • r5.large.search

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] (https

Return type

Optional[str]

master_nodes

The number of instances to use for the master node.

Default
  • no dedicated master nodes

Return type

Union[int, float, None]

warm_instance_type

//docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm) in the Amazon OpenSearch Service Developer Guide.

Default
  • ultrawarm1.medium.search

Type

The instance type for your UltraWarm node, such as ultrawarm1.medium.search. For valid values, see [UltraWarm Storage Limits] (https

Return type

Optional[str]

warm_nodes

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

Default
  • no UltraWarm nodes

Return type

Union[int, float, None]