AWS Image Builder Image Recipe
This page shows how to write Terraform and CloudFormation for Image Builder Image Recipe and write them securely.
aws_imagebuilder_image_recipe (Terraform)
The Image Recipe in Image Builder can be configured in Terraform with the resource name aws_imagebuilder_image_recipe. The following sections describe 1 example of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_imagebuilder_image_recipe" "py_recipe" {
// block_device_mapping {
// device_name = "/dev/sda/"
//
// ebs {
// delete_on_termination = true
Parameters
-
arnoptional computed - string -
date_createdoptional computed - string -
descriptionoptional - string -
idoptional computed - string -
namerequired - string -
owneroptional computed - string -
parent_imagerequired - string -
platformoptional computed - string -
tagsoptional - map from string to string -
versionrequired - string -
working_directoryoptional - string -
block_device_mappingset block-
device_nameoptional - string -
no_deviceoptional - bool -
virtual_nameoptional - string -
ebslist block-
delete_on_terminationoptional - string -
encryptedoptional - string -
iopsoptional - number -
kms_key_idoptional - string -
snapshot_idoptional - string -
volume_sizeoptional - number -
volume_typeoptional - string
-
-
-
componentlist block-
component_arnrequired - string
-
Explanation in Terraform Registry
Manages an Image Builder Image Recipe.
AWS::ImageBuilder::ImageRecipe (CloudFormation)
The ImageRecipe in ImageBuilder can be configured in CloudFormation with the resource name AWS::ImageBuilder::ImageRecipe. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
Namerequired - String -
Descriptionoptional - String -
Versionrequired - String -
Componentsrequired - List of ComponentConfiguration -
BlockDeviceMappingsoptional - List of InstanceBlockDeviceMapping -
ParentImagerequired - String -
WorkingDirectoryoptional - String -
AdditionalInstanceConfigurationoptional - AdditionalInstanceConfiguration -
Tagsoptional - Map
Explanation in CloudFormation Registry
An Image Builder image recipe is a document that defines the source image and the components to be applied to the source image to produce the desired configuration for the output image. You can use an image recipe to duplicate builds. Image Builder image recipes can be shared, branched, and edited using the console wizard, the AWS CLI, or the API. You can use image recipes with your version control software to maintain shareable versioned image recipes.
Frequently asked questions
What is AWS Image Builder Image Recipe?
AWS Image Builder Image Recipe is a resource for Image Builder of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Image Builder Image Recipe?
For Terraform, the KonovalovAlexey/terraform-modules source code example is useful. See the Terraform Example section for further details.
