AWS::OpenSearchService::Domain EBSOptions - AWS CloudFormation
SyntaxProperties

AWS::OpenSearchService::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.

Syntax

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

JSON

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

YAML

  EBSEnabled: Boolean
  Iops: Integer
  Throughput: 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 gp3 and provisioned IOPS EBS volume types.

Required: No

Type: Integer

Update requires: No interruption

Throughput

The throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the gp3 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. 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.

Required: No

Type: String

Allowed values: standard | gp2 | io1 | gp3

Update requires: No interruption