reserved_elasticsearch_instances

Creates, updates, deletes, gets or lists a reserved_elasticsearch_instances resource.

Overview

Name	reserved_elasticsearch_instances
Type	Resource
Id	aws.es.reserved_elasticsearch_instances

Fields

The following fields are returned by SELECT queries:

describe_reserved_elasticsearch_instances

Name	Datatype	Description
currency_code	string	The currency code for the reserved Elasticsearch instance offering.
duration	integer	The duration, in seconds, for which the Elasticsearch instance is reserved.
elasticsearch_instance_count	integer	The number of Elasticsearch instances that have been reserved.
elasticsearch_instance_type	string	The Elasticsearch instance type offered by the reserved instance offering. (m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch)
fixed_price	number (double)	The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
payment_option	string	The payment option as defined in the reserved Elasticsearch instance offering. (ALL_UPFRONT, PARTIAL_UPFRONT, NO_UPFRONT)
recurring_charges	array	The charge to your account regardless of whether you are creating any domains using the instance offering.
reservation_name	string	The customer-specified identifier to track this reservation.
reserved_elasticsearch_instance_id	string	The unique identifier for the reservation. (pattern: <code>\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}</code>)
reserved_elasticsearch_instance_offering_id	string	The offering identifier.
start_time	string (date-time)	The time the reservation started.
state	string	The state of the reserved Elasticsearch instance.
usage_price	number (double)	The rate you are charged for each hour for the domain that is using this reserved instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_elasticsearch_instances	select	region	reservationId, maxResults, nextToken	Returns information about reserved Elasticsearch instances for this account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	Set this value to limit the number of results returned. If not specified, defaults to 100.
nextToken	string	NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
reservationId	string	The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

SELECT examples

describe_reserved_elasticsearch_instances

Returns information about reserved Elasticsearch instances for this account.

SELECT
currency_code,
duration,
elasticsearch_instance_count,
elasticsearch_instance_type,
fixed_price,
payment_option,
recurring_charges,
reservation_name,
reserved_elasticsearch_instance_id,
reserved_elasticsearch_instance_offering_id,
start_time,
state,
usage_price
FROM aws.es.reserved_elasticsearch_instances
WHERE region = '{{ region }}' -- required
AND reservationId = '{{ reservationId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;