AWS imagebuilder: Document Image Builder resource name normalization and ARNs
Summary
Adds a section explaining how Image Builder normalizes resource names (lowercasing, replacing spaces/underscores with hyphens) to generate ARNs, and how this affects name uniqueness and conflicts within an account per Region.
Security assessment
The change documents ARN generation and naming uniqueness/conflict behavior; it is about resource naming semantics, not a security control or vulnerability.
Evidence
+When you create an Image Builder resource, Image Builder generates the resource ARN from a normalized form of the name that you provide. Understanding this normalization helps you avoid unexpected naming conflicts when you create similarly named resources. Normalization converts the name to lowercase and replaces spaces and underscores with hyphens. For example, a component named `My Component_v2` appears in its ARN as `my-component-v2`.
Diff
diff --git a/imagebuilder/latest/userguide/how-image-builder-works.md b/imagebuilder/latest/userguide/how-image-builder-works.md index 6192bc25d..6eba38eb2 100644 --- a//imagebuilder/latest/userguide/how-image-builder-works.md +++ b//imagebuilder/latest/userguide/how-image-builder-works.md @@ -7 +7 @@ -AMI elementsComponent managementResources createdDistributionSharing ResourcesCompliance +AMI elementsComponent managementResource names and ARNsResources createdDistributionSharing ResourcesCompliance @@ -35,0 +36,2 @@ The images that you build from your custom base image are in your AWS account. Y + * Resource names and ARNs + @@ -81,0 +84,8 @@ Generally, each test component consists of a YAML document that contains a test +## Resource names and ARNs + +When you create an Image Builder resource, Image Builder generates the resource ARN from a normalized form of the name that you provide. Understanding this normalization helps you avoid unexpected naming conflicts when you create similarly named resources. Normalization converts the name to lowercase and replaces spaces and underscores with hyphens. For example, a component named `My Component_v2` appears in its ARN as `my-component-v2`. + +Normalization applies to all Image Builder resource types, including components, recipes, images, image pipelines, infrastructure configurations, distribution configurations, lifecycle policies, and workflows. + +Resource names must be unique to your account in each AWS Region. Because the ARN is based on the normalized name, names that differ only in case, spaces, or underscores conflict with each other. For example, you can't create an image recipe named `my recipe` if you already have one named `My_Recipe` with the same version. When names conflict, the create request fails with a `ResourceAlreadyExistsException` error. For versioned resources, the name combines with the semantic version to determine uniqueness. Resources that support build versions, such as components and workflows, instead create a new build version when you reuse a name and version with changed content. +