Use consistent ID separators for resource imports

[YakDriver]

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

[github-actions[bot]]

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.

[github-actions[bot]]

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!