-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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(location): dataSource property is not required #31314
Conversation
There was a problem hiding this 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.
Exemption Request: The results of the integration test snapshots have not changed, so they are not included. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am going to close this PR because I definitely don't think we want to turn this property required on CDK and I don't see why the current default poses a problem right now. Can always revisit/reopen if we decide to change things up but that discussion should happen in an issue
*/ | ||
readonly dataSource?: DataSource; | ||
readonly dataSource: DataSource; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A property being required on CFN does not necessarily mean we have to require it in CDK, if we can find a reasonable default for it. That's what we've done here -- we are not sending undefined
into CFN and getting an error back, we are providing what we think is a sane default.
It sounds like you don't think that DataSource.ESRI
is a reasonable default -- before making that change, I think that's a better discussion to have in an issue.
Comments on closed issues and PRs are hard for our team to see. |
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
Issue # (if applicable)
Closes #31288.
Reason for this change
Currently, dataSource property in PlaceIndex class is optional.
But in CFn document and CloudFormation schema aws-location-placeindex.json,
DataSource
property is required.The current default value in CDK is ESRI, but there's no clear reason for this, and I think it should be aligned with CFn (CloudFormation).
Description of changes
Make
dataSource
property required.Description of how you validated changes
Updated unit tests and integ tests.
Checklist
BREAKING CHANGE:
dataSource
property inPlaceIndex
class is now required.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license