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

chore(secretsmanager): Remove unused secretName attribute #10410

Merged
merged 2 commits into from
Sep 17, 2020

Conversation

njlynch
Copy link
Contributor

@njlynch njlynch commented Sep 17, 2020

In #10309, secretName was added to SecretAttributes, but given the ARN is always
required, it's fairly redundant. Removing to reduce public API surface area.

Not a breaking change, as #10309 has not yet been released.


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

In #10309, secretName was added to SecretAttributes, but given the ARN is always
required, it's fairly redundant. Removing to reduce public API surface area.

Not a breaking change, as #10309 has not yet been released.
@njlynch njlynch requested a review from eladb September 17, 2020 13:34
@njlynch njlynch self-assigned this Sep 17, 2020
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 17, 2020
*
* @default - the name is derived from the secretArn.
*/
readonly secretName?: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

I would argue that a better DX is to only support secretName, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

to only support secretName

We can't stop supporting secretArn as an attribute, no.

You mean make secretArn optional, and add back in secretName as optional, then a validation in fromSecretAttributes that at least one is present? We can do that.

Copy link
Contributor

Choose a reason for hiding this comment

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

to only support secretName

We can't stop supporting secretArn as an attribute, no.

You mean make secretArn optional, and add back in secretName as optional, then a validation in fromSecretAttributes that at least one is present? We can do that.

I guess that could work although generally against our api guidelines (normally in such cases we prefer something like union-like classes). I am okay with how it is now

@mergify
Copy link
Contributor

mergify bot commented Sep 17, 2020

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 74acf20
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify
Copy link
Contributor

mergify bot commented Sep 17, 2020

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 93ba604 into master Sep 17, 2020
@mergify mergify bot deleted the njlynch/remove-unused-attribute branch September 17, 2020 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants