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

(S3): inline documentation about Bucket.import is outdated #18575

Closed
ahtsan opened this issue Jan 20, 2022 · 2 comments · Fixed by #18604
Closed

(S3): inline documentation about Bucket.import is outdated #18575

ahtsan opened this issue Jan 20, 2022 · 2 comments · Fixed by #18604
Assignees
@peterwoodworth
Labels
@aws-cdk/aws-s3 Related to Amazon S3 documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1

Comments

@ahtsan
Copy link

ahtsan commented Jan 20, 2022

link to reference doc page

https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/aws-s3/lib/bucket.ts#L360

Describe your issue?

Bucket.import is no longer valid, it should be either Bucket.fromBucketArn or Bucket.fromBucketName
@ahtsan ahtsan added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jan 20, 2022
@github-actions github-actions bot added the @aws-cdk/aws-s3 Related to Amazon S3 label Jan 20, 2022
@peterwoodworth
Copy link
Contributor

Wow this is really old! Check out the commit this is from. I never knew about the export function. Thanks for pointing this out, I'll get this cleaned up tomorrow

@peterwoodworth peterwoodworth added effort/small Small work item – less than a day of effort p1 and removed needs-triage This issue or PR still needs to be triaged. labels Jan 21, 2022
@peterwoodworth peterwoodworth mentioned this issue Jan 21, 2022
Merged
@mergify mergify bot closed this as completed in #18604 Jan 21, 2022
mergify bot pushed a commit that referenced this issue Jan 21, 2022
@peterwoodworth
docs(s3): remove vestigial documentation (#18604)
de3fa57 
fixes #18575 
Models documentation for [similar](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ec2.VpcAttributes.html) [structs](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-lambda.FunctionAttributes.html)

----

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

LukvonStrom pushed a commit to LukvonStrom/aws-cdk that referenced this issue Jan 26, 2022
@peterwoodworth @LukvonStrom
docs(s3): remove vestigial documentation (aws#18604)
dfa613f 
fixes aws#18575 
Models documentation for [similar](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ec2.VpcAttributes.html) [structs](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-lambda.FunctionAttributes.html)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this issue Feb 21, 2022
@peterwoodworth @TikiTDO
docs(s3): remove vestigial documentation (aws#18604)
3e79c4f 
fixes aws#18575 
Models documentation for [similar](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ec2.VpcAttributes.html) [structs](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-lambda.FunctionAttributes.html)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peterwoodworth peterwoodworth

Labels
@aws-cdk/aws-s3 Related to Amazon S3 documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(s3): remove vestigial documentation aws/aws-cdk
3 participants
@otaviomacedo @ahtsan @peterwoodworth