Interface CfnDomain.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.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDomain.IEBSOptionsProperty

Syntax (vb)

Public Interface CfnDomain.IEBSOptionsProperty

Remarks

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

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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.AWS.Elasticsearch;

             var eBSOptionsProperty = new EBSOptionsProperty {
                 EbsEnabled = false,
                 Iops = 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.
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, such as standard, gp2, or io1.

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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-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 provisioned IOPS EBS volume types.

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

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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize

VolumeType

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

string? VolumeType { get; }

Property Value

string

Remarks

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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype