interface EBSOptionsProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Elasticsearch.CfnDomain.EBSOptionsProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#CfnDomain_EBSOptionsProperty |
![]() | software.amazon.awscdk.services.elasticsearch.CfnDomain.EBSOptionsProperty |
![]() | aws_cdk.aws_elasticsearch.CfnDomain.EBSOptionsProperty |
![]() | aws-cdk-lib » aws_elasticsearch » CfnDomain » EBSOptionsProperty |
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
The
AWS::Elasticsearch::Domain
resource is being replaced by the AWS::OpenSearchService::Domain 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 New resource types in the Amazon OpenSearch Service Developer Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticsearch as elasticsearch } from 'aws-cdk-lib';
const eBSOptionsProperty: elasticsearch.CfnDomain.EBSOptionsProperty = {
ebsEnabled: false,
iops: 123,
volumeSize: 123,
volumeType: 'volumeType',
};
Properties
Name | Type | Description |
---|---|---|
ebs | boolean | IResolvable | Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain. |
iops? | number | The number of I/O operations per second (IOPS) that the volume supports. |
volume | number | The size (in GiB) of the EBS volume for each data node. |
volume | string | The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1. |
ebsEnabled?
Type:
boolean |
IResolvable
(optional)
Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.
iops?
Type:
number
(optional)
The number of I/O operations per second (IOPS) that the volume supports.
This property applies only to provisioned IOPS EBS volume types.
volumeSize?
Type:
number
(optional)
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 more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
volumeType?
Type:
string
(optional)
The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1.
For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .