refactor(connector): add proper prefix for aws related properties for connector #16671
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xxchan
reviewed
May 10, 2024
Comment on lines
80
to
85
| #[serde(rename = "aws.credentials.role.arn", alias = "arn")] | ||
| pub arn: Option<String>, | ||
| /// external ID in IAM role trust policy | ||
| #[serde(rename = "aws.credentials.role.external_id", alias = "external_id")] | ||
| pub external_id: Option<String>, | ||
| #[serde(rename = "aws.region.profile", alias = "profile")] |
There was a problem hiding this comment.
Why credentials.role before arn, external_id, and why region before profile? any reference?
There was a problem hiding this comment.
The arn this for the arn of the role. And the role is used for authentication. I also considered aws.authentication.role.xxx but Kinesis already used aws.credentials.role.xxx.
I'll fix the region.
|
I don't see a strong motivation to add prefixes to these fields. Any conprehensible names will LGTM. Overall, I don't have an opinion on this PR. The code LGTM though |
neverchanje
approved these changes
May 12, 2024
tabVersion
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.
What's changed and what's your intention?
As mentioned in #16625 (comment), the original connector field name can be ambiguous in non AWS context.
Checklist
./risedev check(or alias,./risedev c)Documentation
In pulsar, bigquery and msk documentation, those field name should be changed:
external_id -> aws.credentials.role.external_id
endpoint_url -> aws.endpoint_url
access_key -> aws.credentials.access_key_id
secret_key ->aws.credentials.secret_access_key
session_token -> aws.credentials.session_token
profile-> aws.region.profile
arn -> aws.credentials.role.arn
Release note
If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.