Documentation

A container recipe.

See: newContainerRecipe smart constructor.

Create a value of ContainerRecipe with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:ContainerRecipe', containerRecipe_arn - The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

$sel:components:ContainerRecipe', containerRecipe_components - Components for build and test that are included in the container recipe.

$sel:containerType:ContainerRecipe', containerRecipe_containerType - Specifies the type of container, such as Docker.

$sel:dateCreated:ContainerRecipe', containerRecipe_dateCreated - The date when this container recipe was created.

$sel:description:ContainerRecipe', containerRecipe_description - The description of the container recipe.

$sel:dockerfileTemplateData:ContainerRecipe', containerRecipe_dockerfileTemplateData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

$sel:encrypted:ContainerRecipe', containerRecipe_encrypted - A flag that indicates if the target container is encrypted.

$sel:instanceConfiguration:ContainerRecipe', containerRecipe_instanceConfiguration - A group of options that can be used to configure an instance for building and testing container images.

$sel:kmsKeyId:ContainerRecipe', containerRecipe_kmsKeyId - Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

$sel:name:ContainerRecipe', containerRecipe_name - The name of the container recipe.

$sel:owner:ContainerRecipe', containerRecipe_owner - The owner of the container recipe.

$sel:parentImage:ContainerRecipe', containerRecipe_parentImage - The base image for the container recipe.

$sel:platform:ContainerRecipe', containerRecipe_platform - The system platform for the container, such as Windows or Linux.

$sel:tags:ContainerRecipe', containerRecipe_tags - Tags that are attached to the container recipe.

$sel:targetRepository:ContainerRecipe', containerRecipe_targetRepository - The destination repository for the container image.

$sel:version:ContainerRecipe', containerRecipe_version - The semantic version of the container recipe.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: 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.

Patterns: 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

$sel:workingDirectory:ContainerRecipe', containerRecipe_workingDirectory - The working directory for use during build and test workflows.

The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Components for build and test that are included in the container recipe.

Specifies the type of container, such as Docker.

The date when this container recipe was created.

The description of the container recipe.

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

A flag that indicates if the target container is encrypted.

A group of options that can be used to configure an instance for building and testing container images.

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

The name of the container recipe.

The owner of the container recipe.

The base image for the container recipe.

The system platform for the container, such as Windows or Linux.

Tags that are attached to the container recipe.

The destination repository for the container image.

The semantic version of the container recipe.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: 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.

Patterns: 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

The working directory for use during build and test workflows.