Amazon OpenSearch Service: High Level Constructs For OpenSearch MultiAZWithStandBy Feature

[AmanRajAWS]

Describe the feature

The OpenSearch Team has recently launched MultiAZWithStandby Feature for OpenSearch Domain. Feature Documentation Link. According to the CDK docs currently there is no high level CDK construct for this feature.CDK Docs link for the MultiAZWIthStandbyFeature

Use Case

The general recommendation is to use high level constructs and due to lack of High level construct for this feature, the CDK template needs to be migrated to use CFN constructs if there is a need to Create an OpenSearchDomain with MultiAZWithStandBy. This serves as a hinderance to the adoption of the MultiAZWithStandBy feature for AWS OpenSearch Domains.

Proposed Solution

Add the MultiAZWithStandByAttribute to the capacityConfig object CDK Doc for CapacityConfig Attribute .
A MultiAZWithStandBy based OpenSearchDomain created using CDK high level constructs should look like
const domain = new Domain(this, 'Domain', {
version: EngineVersion.OPENSEARCH_1_0,
capacity: {
masterNodes: 3,
multiAZWithStandbyEnabled: true (possible values: [true,false])
},
});

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.84.0

Environment details (OS name and version, etc.)

macOS Ventura 13.4

[pahud]

Is this feature supported by cloudformation? If not, it sounds like we need to create a L3(or at least L2.5) construct for that?

[AmanRajAWS]

yes this feature is supported by cloudformation
docs link

[peterwoodworth]

You should be able to easily add this now to your template with an escape hatch.

Labeled as good first issue, all we need to do is add a boolean prop it appears