feat(opensearch): add OpenSearch 3.1 engine version #35477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

mergify merged 8 commits into aws:main from claypack:fix-35471

Oct 6, 2025

Contributor

claypack commented Sep 12, 2025

Issue # (if applicable)

Closes #35471.

Reason for this change

AWS OpenSearch Service now supports OpenSearch 3.1, but the CDK does not have a constant for this version. Users need to be able to specify OpenSearch 3.1 when creating OpenSearch domains through CDK.

Description of changes

Added OPENSEARCH_3_1 constant to the EngineVersion class in aws-opensearchservice
Updated unit tests to include the new version in test arrays to ensure proper validation
Created integration test integ.opensearch.v3-1.ts to verify the new version works correctly
Generated integration test snapshots to validate CloudFormation template generation

The changes follow the existing pattern for adding new OpenSearch versions and maintain backward compatibility.

Note: The original issue referenced OpenSearch 3.0, but this version does not appear to exist in AWS OpenSearch Service. Only OpenSearch 3.1 has been implemented.

Describe any new or updated permissions being added

No new IAM permissions are required. This change only adds a new engine version constant that maps to existing AWS OpenSearch Service functionality.

Description of how you validated changes

Added unit tests that verify the new version constant maps to the correct CloudFormation value (OpenSearch_3.1)
Created integration test that deploys an OpenSearch domain with version 3.1
Generated and validated integration test snapshots using integ-runner
Verified all existing tests continue to pass

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation requested a review from a team

September 12, 2025 17:16

github-actions bot added beginning-contributor feature-request p2 labels

aws-cdk-automation previously requested changes

View reviewed changes

Collaborator

aws-cdk-automation left a comment •

edited

Loading

(This review is outdated)

claypack changed the title ~~Fix 35471~~ feat(opensearch): add OpenSearch 3.1 engine version

Contributor Author

claypack commented Sep 12, 2025

Requesting Exemption Request for README changes as the EngineVersion class will display the version on the documentation once it's added.

aws-cdk-automation added pr-linter/exemption-requested pr/needs-community-review labels

badmintoncryer approved these changes

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review and removed pr/needs-community-review labels

pahud mentioned this pull request

aws-opensearch: Add latest Opensearch engine version v3.1 #35471

Closed

2 tasks

leonmk-aws self-assigned this

leonmk-aws requested changes

View reviewed changes

Contributor

leonmk-aws left a comment

Thank you for your contribution, left a small comment

...es/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.v3-1.ts Outdated

Contributor

leonmk-aws Sep 15, 2025

I don't think we need a new integ test for each new version, why not just add OpenSearch 3.1 in packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.min.ts ?

Contributor Author

claypack Sep 15, 2025 •

edited

Loading

Correct, I think that's better. I pushed a new commit adding 3.1 to the versions array in integ.opensearch.min.ts. I removed the previous test and updated the snapshot for integ.opensearch.min.ts.

aws-cdk-automation removed the pr/needs-maintainer-review label

claypack requested a review from leonmk-aws

September 15, 2025 14:10

leonmk-aws previously approved these changes

View reviewed changes

Contributor

leonmk-aws left a comment

Thank you for your contribution !

ajkerr commented Sep 29, 2025

Hi, is there anything preventing this from being merged?

github-actions bot mentioned this pull request

Monthly PR metrics report #35642

Open

leonmk-aws requested a review from aws-cdk-automation

October 1, 2025 07:29

leonmk-aws added the pr-linter/exempt-readme label

aws-cdk-automation dismissed their stale review

October 1, 2025 07:31

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Contributor

mergify bot commented Oct 1, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

claypack added 3 commits

October 1, 2025 09:53


          feat(opensearch): add OpenSearch 3.0 and 3.1 engine versions

339a616

- Add OPENSEARCH_3_0 and OPENSEARCH_3_1 constants to EngineVersion class
- Update unit tests to include new versions in test arrays
- Add integration tests for both new versions
- Generate snapshots for integration tests


          fix: remove OpenSearch 3.0 version (does not exist)

6d41780

- Remove OPENSEARCH_3_0 constant from EngineVersion class
- Remove 3.0 from unit test arrays
- Delete integ.opensearch.v3-0.ts integration test
- Delete integ.opensearch.v3-0.js.snapshot directory
- Keep only OpenSearch 3.1 version support


          feat(opensearch): consolidate OpenSearch 3.1 testing into existing in…

a8c58f5

…tegration test

- Add OPENSEARCH_3_1 to existing integ.opensearch.min.ts versions array
- Remove separate integ.opensearch.v3-1.ts test file and snapshots
- Update snapshot to include OpenSearch 3.1 domain configuration

leonmk-aws force-pushed the fix-35471 branch from 13dfe16 to a8c58f5 Compare

October 1, 2025 07:53

mergify bot dismissed leonmk-aws’s stale review

October 1, 2025 07:53

Pull request has been modified.

leonmk-aws previously approved these changes

View reviewed changes

Contributor

mergify bot commented Oct 1, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify bot added the queued label

Contributor

mergify bot commented Oct 2, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Contributor

mergify bot commented Oct 2, 2025

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated.

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

mergify bot removed the queued label

Contributor

mergify bot commented Oct 2, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).


          Merge branch 'main' into fix-35471

dd48d2f

mergify bot dismissed leonmk-aws’s stale review

October 2, 2025 18:01

Pull request has been modified.

claypack added 3 commits

October 2, 2025 15:02


          Merge branch 'main' into fix-35471

78eb3cf


          Merge branch 'main' into fix-35471


          Merge branch 'main' into fix-35471

a69e0cb

leonmk-aws approved these changes

View reviewed changes

Contributor

mergify bot commented Oct 6, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify bot added the queued label


          Merge branch 'main' into fix-35471

3fb74dd

Contributor

mergify bot commented Oct 6, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify bot merged commit 3bd7cf9 into aws:main

19 checks passed

mergify bot removed the queued label

Contributor

github-actions bot commented Oct 6, 2025

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

github-actions bot locked as resolved and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

beginning-contributor feature-request p2 pr-linter/exempt-readme pr-linter/exemption-requested