Skip to content

EBSOptions

Source code in docs_src/capo_opensearch/types/ebs_options.py
class EBSOptions(TypedDict, closed=True):
    ebs_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</p>"""
    volume_type: NotRequired["capo_opensearch.types.volume_type.VolumeType"]
    """<p>Specifies the type of EBS volumes attached to data nodes.</p>"""
    volume_size: NotRequired["capo_opensearch.types.integer_class.IntegerClass"]
    """<p>Specifies the size (in GiB) of EBS volumes attached to data nodes.</p>"""
    iops: NotRequired["capo_opensearch.types.integer_class.IntegerClass"]
    """<p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> and provisioned IOPS EBS volume types.</p>"""
    throughput: NotRequired["capo_opensearch.types.integer_class.IntegerClass"]
    """<p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> volume type.</p>"""

ebs_enabled instance-attribute

ebs_enabled: NotRequired[Boolean]

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

iops instance-attribute

iops: NotRequired[IntegerClass]

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

throughput instance-attribute

throughput: NotRequired[IntegerClass]

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

volume_size instance-attribute

volume_size: NotRequired[IntegerClass]

Specifies the size (in GiB) of EBS volumes attached to data nodes.

volume_type instance-attribute

volume_type: NotRequired[VolumeType]

Specifies the type of EBS volumes attached to data nodes.