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.

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

opensearch: High Level Constructs For OpenSearchOffPeakWindowOptions and Software Update Options Feature #26388

Closed
2 tasks
AmanRajAWS opened this issue Jul 17, 2023 · 2 comments · Fixed by #26403
Closed
2 tasks

opensearch: High Level Constructs For OpenSearchOffPeakWindowOptions and Software Update Options Feature #26388

AmanRajAWS opened this issue Jul 17, 2023 · 2 comments · Fixed by #26403
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

@AmanRajAWS
Copy link

AmanRajAWS commented Jul 17, 2023 •
edited
Loading

Describe the feature

The OpenSearch Team has recently launched OffPeak and Software Update OptionsFeature for OpenSearch Domain. OffPeakWindowOptionsLink.
SoftwareUpdateOptionsLink
According to the CDK docs currently there is no high level CDK construct for these features.
CDK docs link for OffPeakWindowOptionsProperty
CDK Docs link for OffPeakWindow
CDK Docs link for SoftwareUpdateOptions
CFN docs link for OffPeakWindow
CFN docs link for OffPeakWindowOptions
CFN docs link for SoftwareUpdateOptions

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 OffPeak window for OpenSearch Domain . This serves as a hinderance to the adoption of the OffPeak Window and Software Update Options feature for AWS OpenSearch Domains.

Proposed Solution

Add the OffPeakWindowOptions to the OpenSearch Domain Props(https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.Domain.html) .
Configuring OffPeakWindowOptions on OpenSearchDomain created using CDK high level constructs should look like
const domain = new Domain(this, 'Domain', {
version: EngineVersion.OPENSEARCH_1_0,

offPeakWindowOptions: {
enabled: true (possible values: [true,false])
offPeakWindow: {
windowStartTime: {
hours: 4 [possible values from 0 to 60]
minutes: 4 [possible values from 0 to 60]
}
}
},
softwareUpdateOptions : {
autoSoftwareUpdateEnabled: 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
@AmanRajAWS AmanRajAWS added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jul 17, 2023
@github-actions github-actions bot added the @aws-cdk/aws-opensearch Related to the @aws-cdk/aws-opensearchservice package label Jul 17, 2023
@pahud
Copy link
Contributor

pahud commented Jul 17, 2023

Yes OffPeakWindowOptions is an optional prop for domain and we welcome and appreciate any PRs for that.

@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 Jul 17, 2023
@pahud pahud changed the title Amazon OpenSearch Service: High Level Constructs For OpenSearchOffPeakWindowOptions and Software Update Options Feature opensearch: High Level Constructs For OpenSearchOffPeakWindowOptions and Software Update Options Feature Jul 17, 2023
@lpizzinidev lpizzinidev mentioned this issue Jul 18, 2023
Merged
kaizencc added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 18, 2023
@kaizencc
Merge branch 'main' into awsgh-26388
47362d6
lpizzinidev added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 19, 2023
@lpizzinidev
Merge branch 'main' into awsgh-26388
c383dd4
lpizzinidev added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 22, 2023
@lpizzinidev
Merge branch 'main' into awsgh-26388
3b24e02
lpizzinidev added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 25, 2023
@lpizzinidev
Merge branch 'main' into awsgh-26388
341b2d6
kaizencc added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 26, 2023
@kaizencc
Merge branch 'main' into awsgh-26388
e75adf3
kaizencc added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 27, 2023
@kaizencc
Merge branch 'main' into awsgh-26388
fbb4e20
mergify bot added a commit to lpizzinidev/aws-cdk that referenced this issue Jul 27, 2023
@mergify
Merge branch 'main' into awsgh-26388
16ba32f
@mergify mergify bot closed this as completed in #26403 Jul 27, 2023
mergify bot pushed a commit that referenced this issue Jul 27, 2023
@lpizzinidev
feat(opensearchservice): L2 properties for offPeakWindowOptions and s…
02e8d58 
…oftwareUpdateOptions (#26403)

The [`OffPeakWindowOptions`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomain.OffPeakWindowOptionsProperty.html) and [`SoftwareUpdateOptions`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomain.SoftwareUpdateOptionsProperty.html) are supported by OpenSearch Domain, but not by the CDK high-level construct.

This change adds the corresponding properties to the `Domain` construct:

```ts
const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_3,
  offPeakWindowEnabled: true, // can be omitted if offPeakWindowStart is set
  offPeakWindowStart: {
    hours: 20,
    minutes: 0,
  },
  enableAutoSoftwareUpdate: true,
});
```

Closes #26388.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
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.

@github-actions github-actions bot mentioned this issue Aug 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
2 participants
@pahud @AmanRajAWS