Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456338351.9 KB

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

put/CreateContainerRecipe

Request body

containerType'DOCKER' required

The type of container to create.

namestring required

The name of the container recipe.

descriptionstring

The description of the container recipe.

semanticVersionstring required
<p>The semantic version of the container recipe. This version follows the semantic version syntax.</p> <note> <p>The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p> </note>
dockerfileTemplateDatastring

The Dockerfile template used to build your image as an inline data blob.

dockerfileTemplateUristring

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

platformOverride'Windows' | 'Linux'

Specifies the operating system platform when you use a custom base image.

imageOsVersionOverridestring

Specifies the operating system version for the base image.

parentImagestring required

The base image for the container recipe.

tagsobject

Tags that are attached to the container recipe.

workingDirectorystring

The working directory for use during build and test workflows.

kmsKeyIdstring

Identifies which KMS key is used to encrypt the container image.

clientTokenstring required

The client token used to make this request idempotent.

Response

Success

requestIdstring

The request ID that uniquely identifies this request.

clientTokenstring

The client token used to make this request idempotent.

containerRecipeArnstring

Returns the Amazon Resource Name (ARN) of the container recipe that the request created.