Class EbsOptions
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.AWS.OpenSearchService.dll
Syntax (csharp)
public class EbsOptions : Object, IEbsOptions
Syntax (vb)
Public Class EbsOptions
Inherits Object
Implements IEbsOptions
Remarks
For more information, see [Amazon EBS] (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) in the Amazon Elastic Compute Cloud Developer Guide.
ExampleMetadata: infused
Examples
var prodDomain = new Domain(this, "Domain", new DomainProps {
Version = EngineVersion.OPENSEARCH_1_0,
Capacity = new CapacityConfig {
MasterNodes = 5,
DataNodes = 20
},
Ebs = new EbsOptions {
VolumeSize = 20
},
ZoneAwareness = new ZoneAwarenessConfig {
AvailabilityZoneCount = 3
},
Logging = new LoggingOptions {
SlowSearchLogEnabled = true,
AppLogEnabled = true,
SlowIndexLogEnabled = true
}
});
Synopsis
Constructors
EbsOptions() |
Properties
Enabled | Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon 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 Amazon OpenSearch Service domain, such as standard, gp2, io1. |
Constructors
EbsOptions()
public EbsOptions()
Properties
Enabled
Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon OpenSearch Service domain.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - true
Iops
The number of I/O operations per second (IOPS) that the volume supports.
public Nullable<double> Iops { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This property applies only to the Provisioned IOPS (SSD) EBS volume type.
Default: - iops are not set.
VolumeSize
The size (in GiB) of the EBS volume for each data node.
public Nullable<double> VolumeSize { get; set; }
Property Value
System.Nullable<System.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 valid values, see [EBS volume size limits] (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the Amazon OpenSearch Service Developer Guide.
Default: 10
VolumeType
The EBS volume type to use with the Amazon OpenSearch Service domain, such as standard, gp2, io1.
public Nullable<EbsDeviceVolumeType> VolumeType { get; set; }
Property Value
System.Nullable<EbsDeviceVolumeType>
Remarks
Default: gp2