AWS::Elasticsearch::Domain EBSOptions - AWS CloudFormation

AWS::Elasticsearch::Domain EBSOptions

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.

Important

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "EBSEnabled" : Boolean, "Iops" : Integer, "VolumeSize" : Integer, "VolumeType" : String }

YAML

EBSEnabled: Boolean Iops: Integer VolumeSize: Integer VolumeType: String

Properties

EBSEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

Iops

The number of I/O operations per second (IOPS) that the volume supports. This property applies only to the Provisioned IOPS (SSD) EBS volume type.

Required: No

Type: Integer

Update requires: No interruption

VolumeSize

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.

Required: No

Type: Integer

Update requires: No interruption

VolumeType

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.

Required: No

Type: String

Update requires: No interruption