aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

AWS::Elasticsearch::Domain - Auto-Tune

Open
#832 13 comments 29 reactions 0 assignees View on GitHub
enhancement
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

## Scope of request
ES got a new feature [Auto-tune]( https://aws.amazon.com/about-aws/whats-new/2021/03/amazon-elasticsearch-service-announces-auto-tune-feature-improved-performance-application-availability/). This feature with all its options are not supported by AWS Cloudformation.

Options missing:
- Auto-Tune: Enabled State
- Maintenance Windows: State
- ScheduledAutoTuneDetails

[API Specification - CreateElasticSearchDomain - AutoTuneOptions](https://awsapichanges.info/archive/changes/66ea51-es.html)
```json
{'AutoTuneOptions': {'DesiredState': 'ENABLED | DISABLED',
'MaintenanceSchedules': [{'CronExpressionForRecurrence': 'string',
'Duration': {'Unit': 'HOURS',
'Value': 'long'},
'StartAt': 'timestamp'}]}}
```

## Expected behavior

Configure the options for ES Auto-tune via Cloudformation - see Screenshot of console:

![Screenshot_2021-04-07_at_12 25 11](https://user-images.githubusercontent.com/10091275/114137336-533b8900-990c-11eb-88a3-752de5a8f17c.png)

## Suggest specific test cases

none

## Helpful Links to speed up research and evaluation

- New Feature Announcement: https://aws.amazon.com/about-aws/whats-new/2021/03/amazon-elasticsearch-service-announces-auto-tune-feature-improved-performance-application-availability/
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html
- https://awsapichanges.info/archive/changes/66ea51-es.html

## Category (required)
- Analytics (Athena, EMR, Glue,...)

Contributor guide

Open the contributing guide

Research direction

Start at the AWS::Elasticsearch::Domain resource and compare the CloudFormation resource documentation with the linked AutoTuneOptions API specification. Trace how domain properties are represented and tested in this repository, then add support for DesiredState and MaintenanceSchedules so Auto-Tune can be configured through CloudFormation. The issue provides no specific files or test cases, so identify the relevant implementation and test entry points first.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, elasticsearch
Domain
cloud, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.