EbsOptions

class aws_cdk.aws_opensearchservice.EbsOptions(*, enabled=None, iops=None, throughput=None, volume_size=None, volume_type=None)

Bases: object

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

For more information, see Amazon EBS in the Amazon Elastic Compute Cloud Developer Guide.

Parameters:

enabled (Optional[bool]) – Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain. Default: - true
iops (Union[int, float, None]) – The number of I/O operations per second (IOPS) that the volume supports. This property applies only to the gp3 and Provisioned IOPS (SSD) EBS volume type. Default: - iops are not set.
throughput (Union[int, float, None]) – The throughput (in MiB/s) of the EBS volumes attached to data nodes. This property applies only to the gp3 volume type. Default: - throughput is not set.
volume_size (Union[int, float, None]) – 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 valid values, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide. Default: 10
volume_type (Optional[EbsDeviceVolumeType]) – The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1. Default: gp2

ExampleMetadata:

infused

Example:

domain = Domain(self, "Domain",
    version=EngineVersion.OPENSEARCH_1_0,
    ebs=EbsOptions(
        volume_size=100,
        volume_type=ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    ),
    node_to_node_encryption=True,
    encryption_at_rest=EncryptionAtRestOptions(
        enabled=True
    )
)

Attributes

enabled

Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.

Default:

true

iops

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

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

Default:

iops are not set.

throughput

The throughput (in MiB/s) of the EBS volumes attached to data nodes.

This property applies only to the gp3 volume type.

Default:

throughput is not set.

volume_size

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 valid values, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide.

Default:: 10

volume_type

The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.

Default:: gp2