Skip to content
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.

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

Amazon OpenSearch Service: High Level Constructs For OpenSearch IPAddressType Feature #28436

Closed
2 tasks
vidit624 opened this issue Dec 20, 2023 · 2 comments · Fixed by #28497
Closed
2 tasks
Labels
@aws-cdk/aws-opensearch Related to the @aws-cdk/aws-opensearchservice package effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2

Comments

@vidit624
Copy link

vidit624 commented Dec 20, 2023

Describe the feature

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

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 IPAddressType. This serves as a hinderance to the adoption of the IPAddressType feature for AWS OpenSearch Domains.

Proposed Solution

Add the IPAddressType to the Domain high level object CDK Doc for Domain Options .
A IPAddressType based OpenSearchDomain created using CDK high level constructs should look like

const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_0,
  ipAddressType: ipv4 (possible values: [ipv4, dualstack])
  capacity: {
  masterNodes: 3
  },
});

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

@vidit624 vidit624 added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Dec 20, 2023
@github-actions github-actions bot added the @aws-cdk/aws-opensearch Related to the @aws-cdk/aws-opensearchservice package label Dec 20, 2023
@pahud
Copy link
Contributor

pahud commented Dec 20, 2023

Yes, the prop is already in L1. Should be easy to expose that to the L2 props.
Are you interested to submit a PR for that?

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ipaddresstype

@pahud pahud added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Dec 20, 2023
@mergify mergify bot closed this as completed in #28497 Dec 28, 2023
mergify bot pushed a commit that referenced this issue Dec 28, 2023
This PR adds a `ipAddressType` property for `Domain`.

Closes #28436.

----

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

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

paulhcsun pushed a commit to paulhcsun/aws-cdk that referenced this issue Jan 5, 2024
This PR adds a `ipAddressType` property for `Domain`.

Closes aws#28436.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-opensearch Related to the @aws-cdk/aws-opensearchservice package effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants