Skip to content

chore(design): update DESIGN_GUIDELINES.md#35046

Open
kumvprat wants to merge 2 commits intomainfrom
kumvprat-patch-3
Open

chore(design): update DESIGN_GUIDELINES.md#35046
kumvprat wants to merge 2 commits intomainfrom
kumvprat-patch-3

Conversation

@kumvprat
Copy link
Copy Markdown
Contributor

Reason for this change

Updates DESIGN_GUIDELINES.md for References section

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team July 23, 2025 16:41
@github-actions github-actions bot added the p2 label Jul 23, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jul 23, 2025
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 23, 2025
### Imports
### References

> References create a read-only pointer to the unowned resources
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should also add information about why someone may want to do this, given it is a read-only pointer. @mrgrain thoughts?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Resource created outside of the current stack/app. Personally I like to think about this as a very basic way of service discovery. Often you have centrally managed resources that are available under a well-known address. Think an SNS Topic that publish company-wide notifications. There's really no need to have anything more complex than a hardcoded string for these.


#### From-attributes

> To determine the set of attributes needed to reference an unowned resource, refer to Cloudformation templtate reference for the return types
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Typo: template

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 24, 2025
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. p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants