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

fix(opensearchservice): openSearchLogGroupResourcePolicy unnecessarily attempts to install latest sdk version #30322

Closed
wants to merge 1 commit into from

Conversation

victorchan314
Copy link

@victorchan314 victorchan314 commented May 24, 2024

Issue #23113

Closes #23113 (Already closed, but looks like some changes were missed)
Related: #28688
Please let me know if the title needs to be changed. The title for the related pull request was approved, but the linter here indicates otherwise.

Reason for this change

If the flag is set to true, the custom resource has nondeterministic behavior, such as longer execution time and network access.

Description of changes

Explicitly set installLatestAwsSdk to false for OpenSearch and ElasticSearch's LogGroupResourcePolicies. No need to set it for AWS EventTargets's LogGroupResourcePolicy because they have a prop that allows the consumer to override it.

Description of how you validated changes

(Copied from #28688)
No tests add because the existing tests run with the @aws-cdk/customresources:installLatestAwsSdkDefault feature flag set to the recommended value. This change is merely change the OpenSearchAccessPolicy config for users that don't set the feature flag. We can safely do this, because we control the code for this custom resource and know it works with the provided SDK version.

Checklist


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

@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels May 24, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team May 24, 2024 01:51
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 5ca8f38
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@victorchan314 victorchan314 marked this pull request as ready for review May 24, 2024 02:25
@xazhao xazhao self-assigned this May 24, 2024
@xazhao xazhao changed the title fix(opensearchservice): OpenSearchLogGroupResourcePolicy unnecessar… fix(opensearchservice): OpenSearchLogGroupResourcePolicy unnecessarily attempts to install latest sdk version May 29, 2024
@xazhao
Copy link
Contributor

xazhao commented May 29, 2024

Updated the title to include the full message

@xazhao xazhao added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels May 29, 2024
@xazhao xazhao changed the title fix(opensearchservice): OpenSearchLogGroupResourcePolicy unnecessarily attempts to install latest sdk version fix(opensearchservice): openSearchLogGroupResourcePolicy unnecessarily attempts to install latest sdk version May 29, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review May 29, 2024 01:02

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 29, 2024
Copy link
Contributor

@xazhao xazhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Copy link
Contributor

mergify bot commented May 29, 2024

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).

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 29, 2024
Copy link
Contributor

mergify bot commented May 29, 2024

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).

@TheRealAmazonKendra TheRealAmazonKendra added the pr/do-not-merge This PR should not be merged at this time. label May 29, 2024
@TheRealAmazonKendra
Copy link
Contributor

Adding do-not-merge on this because this custom resource is actually no longer necessary. The CloudFormation resource exists now. I'm preparing a change to remove it completely and to use the CloudFormation resource.

@TheRealAmazonKendra
Copy link
Contributor

I've been working on this issue but the default is actually already false so adding it explicitly here will not make a difference anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. effort/medium Medium work item – several days of effort p1 pr/do-not-merge This PR should not be merged at this time. pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
4 participants