ImageRecipe
An image recipe.
Contents
- additionalInstanceConfiguration
-
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
Type: AdditionalInstanceConfiguration object
Required: No
- arn
-
The Amazon Resource Name (ARN) of the image recipe.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?: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
- blockDeviceMappings
-
The block device mappings to apply when creating images from this recipe.
Type: Array of InstanceBlockDeviceMapping objects
Required: No
- components
-
The components that are included in the image 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
- dateCreated
-
The date on which this image recipe was created.
Type: String
Required: No
- description
-
The description of the image recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- name
-
The name of the image 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 image recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- parentImage
-
The base image of the image recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- platform
-
The platform of the image recipe.
Type: String
Valid Values:
Windows | Linux | macOSRequired: No
-
The tags of the image 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
- type
-
Specifies which type of image is created by the recipe - an AMI or a container image.
Type: String
Valid Values:
AMI | DOCKERRequired: No
- version
-
The version of the image recipe.
Type: String
Pattern:
^[0-9]+\.[0-9]+\.[0-9]+$Required: No
- workingDirectory
-
The working directory to be used 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:
