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

Use consistent ID separators for resource imports #27843

Closed
YakDriver opened this issue Nov 16, 2022 · 3 comments · May be fixed by #27885
Closed

Use consistent ID separators for resource imports #27843

YakDriver opened this issue Nov 16, 2022 · 3 comments · May be fixed by #27885
Labels
breaking-change Introduces a breaking change in current functionality; usually deferred to the next major release. stale Old or inactive issues managed by automation, if no further action taken these will get closed.

Comments

@YakDriver
Copy link
Member

YakDriver commented Nov 16, 2022

Description

For UX, it would be beneficial to have a consistent separator for resource IDs with multiple parts. This comes into play when importing. Although the different separators are documented, which separator to use should not be something practitioners need to think about.

Based on very quick research (I attempted to limit it to ID splits but it's not exact), these are the separators in use now:

  • / - ~100 resources
  • : - ~45
  • , - ~11
  • _ - ~7
  • | - ~6
  • # - ~4
  • - - ~1
  • ; - ~0

The most commonly used symbol, forward slash /, is not ideal across the board because any ID including an ARN may have complications. Similarly, the second-most commonly used symbol, colon :, is part of ARNs as well. Thus, , may well be the best separator.

Here is an example of an import using a composite ID with a / separator:

$ terraform import aws_dynamodb_contributor_insights.test name:ExampleTableName/index:ExampleIndexName/123456789012
@YakDriver YakDriver added the needs-triage Waiting for first response or review from a maintainer. label Nov 16, 2022
@github-actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

Copy link

github-actions bot commented Nov 6, 2024

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

@github-actions github-actions bot added the stale Old or inactive issues managed by automation, if no further action taken these will get closed. label Nov 6, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 6, 2024
Copy link

github-actions bot commented Jan 6, 2025

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking-change Introduces a breaking change in current functionality; usually deferred to the next major release. stale Old or inactive issues managed by automation, if no further action taken these will get closed.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant