ContainerRecipe - EC2 Image Builder

ContainerRecipe

A container recipe.

Contents

arn

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

Note

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.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

Required: No

components

Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Type: Array of ComponentConfiguration objects

Array Members: Minimum number of 1 item.

Required: No

containerType

Specifies the type of container, such as Docker.

Type: String

Valid Values: DOCKER

Required: No

dateCreated

The date when this container recipe was created.

Type: String

Required: No

description

The description of the container recipe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Required: No

encrypted

A flag that indicates if the target container is encrypted.

Type: Boolean

Required: No

instanceConfiguration

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

Type: InstanceConfiguration object

Required: No

kmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

name

The name of the container recipe.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: No

owner

The owner of the container recipe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

parentImage

The base image for the container recipe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

platform

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

Type: String

Valid Values: Windows | Linux

Required: No

tags

Tags that are attached to the container recipe.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

targetRepository

The destination repository for the container image.

Type: TargetContainerRepository object

Required: No

version

The semantic version of the container recipe.

Note

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.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No

workingDirectory

The working directory for use during build and test workflows.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: