Create a new version of a container recipe

To create a new container recipe version:

1. At the top of the container recipe details page, choose Create new version. You are taken to the Create recipe page for container recipes.

2. To create the new version, make your changes, and then choose Create recipe.

1. Create a CLI input JSON file

   You can provide all of the input for the create-container-recipe command with inline command parameters. However, the resulting command can be quite long. To streamline the command, you can instead provide a JSON file that contains all of the container recipe settings

   Note

   The naming convention for the data values in the JSON file follows the pattern that is specified for the Image Builder API action request parameters. To review the API command request parameters, see the CreateContainerRecipe command in the EC2 Image Builder API Reference.

   To provide the data values as command line parameters, refer to the parameter names specified in the Amazon CLI Command Reference.

   Here is a summary of the parameters in this example:

   • components (array of objects, required) – Contains an array of ComponentConfiguration objects. At least one build component must be specified:

     Note

     Image Builder installs components in the order that you specified them in the recipe. However, CIS hardening components always run last to ensure that the benchmark tests run against your output image.

     • componentARN (string, required) – The component ARN.

       Tip

       To use the example to create your own container recipe, replace the example ARNs with the ARNs for the components that you are using for your recipe,. These include the Amazon Web Services Region, name, and the version number for each.

     • parameters (array of objects) – Contains an array of ComponentParameter objects. If an input parameter is required, but doesn't have a default value defined in the component, you must provide a value. Image Builder won't create the recipe version if there are any required parameters that are missing and don't have a default value defined.

       Important

       Component parameters are plain text values, and are logged in Amazon CloudTrail. We recommend that you use Amazon Secrets Manager or the Amazon Systems Manager Parameter Store to store your secrets. For more information about Secrets Manager, see What is Secrets Manager? in the Amazon Secrets Manager User Guide. For more information about Amazon Systems Manager Parameter Store, see Amazon Systems Manager Parameter Store in the Amazon Systems Manager User Guide.

       • name (string, required) – The name of the component parameter to set.

       • value (array of strings, required) – Contains an array of strings to set the value for the named component parameter. If there is a default value defined for the component, and no other value is provided, EC2 TOE uses the default value.

   • containerType (string, required) – The type of container to create. Valid values include DOCKER.

   • dockerfileTemplateData (string) – The Dockerfile template that is used to build your image, expressed as an inline data blob.

   • name (string, required) – The name of the container recipe.

   • description (string) – The description of the container recipe.

   • parentImage (string, required) – Image that the container recipe uses as a base for your customized image. The value can be the base image ARN or an AMI ID.

   • platformOverride (string) – Specifies the operating system platform when you use a custom base image.

   • semanticVersion (string, required) – The semantic version of the container recipe specified in the following format, with numeric values in each position to indicate a specific version: <major>.<minor>.<patch>. An example would be 1.0.0. To learn more about semantic versioning for Image Builder resources, see Semantic versioning.

   • tags (string map) – Tags that are attached to the container recipe.

   • instanceConfiguration (object) – A group of options that can be used to configure an instance for building and testing container images.

     • image (string) – The AMI ID to use as the base image for a container build and test instance. If you don't specify this value, Image Builder uses the appropriate Amazon ECS optimized AMI as a base image.

     • blockDeviceMappings (array of objects) – Defines the block devices to attach for building an instance from the Image Builder AMI specified in the image parameter.

       • deviceName (string) – The device that these mappings apply to.

       • ebs (object) – Used to manage Amazon EBS specific configuration for this mapping.

         • deleteOnTermination (Boolean) – Used to configure delete on termination of the associated device.

         • encrypted (Boolean) – Used to configure device encryption.

         • volumeSize (integer) – Used to override the device's volume size.

         • volumeType (string) – Used to override the device's volume type.

   • targetRepository (object, required) – The destination repository for the container image if there is no other repository specified in your pipeline's distribution configuration for the Region where the pipeline runs (Region 1).

     • repositoryName (string, required) – The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

     • service (string, required) – Specifies the service in which this image was registered.

   • workingDirectory (string) – The working directory for use during build and test workflows.

   {
   	"components": [ 
   	  { 
   		 "componentArn": "arn:aws:imagebuilder:us-east-1:123456789012:component/helloworldal2/x.x.x"
   	  }
   	],
   	"containerType": "DOCKER",
   	"description": "My Linux Docker container image",
   	"dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}",
   	"name": "amazonlinux-container-recipe",
   	"parentImage": "amazonlinux:latest",
   	"platformOverride": "Linux",
   	"semanticVersion": "1.0.2",
   	"tags": { 
   	  "sometag" : "Tag detail" 
   	},
   	"instanceConfiguration": {
   	  "image": "ami-1234567890",
   	  "blockDeviceMappings": [
   		 {
   			"deviceName": "/dev/xvda",
   			"ebs": {
   				"deleteOnTermination": true,
   				"encrypted": false,
   				"volumeSize": 8,
   				"volumeType": "gp2"
   			 }
   		  }			
   	  ]
   	},
   	"targetRepository": { 
   	  "repositoryName": "myrepo",
   	  "service": "ECR"
   	},
   	"workingDirectory": "/tmp"
   }

2. Create the recipe

   Use the following command to create the recipe. Provide the name of the JSON file that you created in the prior step in the --cli-input-json parameter:

   aws imagebuilder create-container-recipe --cli-input-json file://create-container-recipe.json

   Note

   • You must include the file:// notation at the beginning of the JSON file path.

   • The path for the JSON file should follow the appropriate convention for the base operating system where you are running the command. For example, Windows uses the backslash (\) to refer to the directory path, and Linux uses the forward slash (/).