EbsOptions

class aws_cdk.aws_elasticsearch.EbsOptions(*, enabled=None, iops=None, volume_size=None, volume_type=None)

Bases: object

(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Parameters
Deprecated

use opensearchservice module instead

Stability

deprecated

ExampleMetadata

infused

Example:

prod_domain = es.Domain(self, "Domain",
    version=es.ElasticsearchVersion.V7_1,
    capacity=es.CapacityConfig(
        master_nodes=5,
        data_nodes=20
    ),
    ebs=es.EbsOptions(
        volume_size=20
    ),
    zone_awareness=es.ZoneAwarenessConfig(
        availability_zone_count=3
    ),
    logging=es.LoggingOptions(
        slow_search_log_enabled=True,
        app_log_enabled=True,
        slow_index_log_enabled=True
    )
)

Attributes

enabled

(deprecated) Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain.

Default
  • true

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

Optional[bool]

iops

(deprecated) The number of I/O operations per second (IOPS) that the volume supports.

This property applies only to the Provisioned IOPS (SSD) EBS volume type.

Default
  • iops are not set.

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

Union[int, float, None]

volume_size

(deprecated) The size (in GiB) of the EBS volume for each data node.

The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Default

10

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

Union[int, float, None]

volume_type

(deprecated) The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1.

For more information, see[Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

Default

gp2

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

Optional[EbsDeviceVolumeType]