Interface CfnDomainPropsMixin.IEBSOptionsProperty

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

Namespace: Amazon.CDK.Mixins.Preview.AWS.OpenSearchService.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnDomainPropsMixin.IEBSOptionsProperty

Syntax (vb)

Public Interface CfnDomainPropsMixin.IEBSOptionsProperty

Remarks

For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.OpenSearchService.Mixins;

             var eBSOptionsProperty = new EBSOptionsProperty {
                 EbsEnabled = false,
                 Iops = 123,
                 Throughput = 123,
                 VolumeSize = 123,
                 VolumeType = "volumeType"
             };

Synopsis

Properties

EbsEnabled	Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.
Iops	The number of I/O operations per second (IOPS) that the volume supports.
Throughput	The throughput (in MiB/s) of the EBS volumes attached to data nodes.
VolumeSize	The size (in GiB) of the EBS volume for each data node.
VolumeType	The EBS volume type to use with the OpenSearch Service domain.

Properties

EbsEnabled

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

object? EbsEnabled { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-ebsenabled

Type union: either bool or IResolvable

Iops

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

double? Iops { get; }

Property Value

double?

Remarks

This property applies only to the gp3 and provisioned IOPS EBS volume types.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-iops

Throughput

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

double? Throughput { get; }

Property Value

double?

Remarks

Applies only to the gp3 volume type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-throughput

VolumeSize

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

double? VolumeSize { get; }

Property Value

double?

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumesize

VolumeType

The EBS volume type to use with the OpenSearch Service domain.

string? VolumeType { get; }

Property Value

string

Remarks

If you choose gp3 , you must also specify values for Iops and Throughput . For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumetype