View a markdown version of this page

AWS::ImageBuilder::ImageRecipe - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ImageBuilder::ImageRecipe

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ImageBuilder::ImageRecipe",
  "Properties" : {
      "AdditionalInstanceConfiguration" : AdditionalInstanceConfiguration,
      "AmiTags" : {Key: Value, ...},
      "AmiWatermarks" : [ String, ... ],
      "BlockDeviceMappings" : [ InstanceBlockDeviceMapping, ... ],
      "Components" : [ ComponentConfiguration, ... ],
      "Description" : String,
      "Name" : String,
      "ParentImage" : String,
      "Tags" : {Key: Value, ...},
      "Version" : String,
      "WorkingDirectory" : String
    }
}

YAML

Type: AWS::ImageBuilder::ImageRecipe
Properties:
  AdditionalInstanceConfiguration: 
    AdditionalInstanceConfiguration
  AmiTags: 
    Key: Value
  AmiWatermarks: 
    - String
  BlockDeviceMappings: 
    - InstanceBlockDeviceMapping
  Components: 
    - ComponentConfiguration
  Description: String
  Name: String
  ParentImage: String
  Tags: 
    Key: Value
  Version: String
  WorkingDirectory: String

Properties

AdditionalInstanceConfiguration

The additional settings and launch scripts for your build instances.

Required: No

Type: AdditionalInstanceConfiguration

Update requires: Replacement

AmiTags

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Required: No

Type: Object of String

Pattern: .{1,}

Update requires: Replacement

AmiWatermarks

The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

Note

AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

Required: No

Type: Array of String

Minimum: 3 | 1

Maximum: 128 | 5

Update requires: Replacement

BlockDeviceMappings

The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.

Required: No

Type: Array of InstanceBlockDeviceMapping

Update requires: Replacement

Components

The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.

Required: No

Type: Array of ComponentConfiguration

Minimum: 1

Update requires: Replacement

Description

The description of the image recipe.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Name

The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each AWS Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

Required: Yes

Type: String

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

Update requires: Replacement

ParentImage

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:

  • AMI ID

  • Image Builder image Amazon Resource Name (ARN)

  • AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

  • AWS Marketplace product ID

If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI. The AMI must also be in the Region where you're creating the recipe.

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Tags

The tags of the image recipe.

Required: No

Type: Object of String

Pattern: .{1,}

Update requires: No interruption

Version

The semantic version of the image recipe. This version follows the semantic version syntax.

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. The upper limit is 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.

Required: Yes

Type: String

Pattern: ^(?:[0-9]+|x)\.(?:[0-9]+|x)\.(?:[0-9]+|x)$

Update requires: Replacement

WorkingDirectory

The working directory used during build and test workflows. If you don't specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource ARN, such as arn:aws:imagebuilder:us-east-1:111122223333:image-recipe/mybasicrecipe/2019.12.03.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

Returns the Amazon Resource Name (ARN) of the image recipe. For example, arn:aws:imagebuilder:us-east-1:111122223333:image-recipe/mybasicrecipe/2019.12.03.

LatestVersion.Arn

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

LatestVersion.Major

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

LatestVersion.Minor

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

LatestVersion.Patch

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Name

The name of the image recipe.

Examples

Create an image recipe

The following example shows the template for the ImageRecipe resource in both YAML and JSON format.

YAML

Resources:
  ImageRecipeAllParameters:
    Type: 'AWS::ImageBuilder::ImageRecipe'
    Properties:
      Name: 'image-recipe-name'
      Version: '1.0.0'
      ParentImage: !Ref ParentImage
      Description: 'description'
      Components:
        - ComponentArn: !Ref ComponentArn
        - ComponentArn: !Ref AnotherComponentArn
      BlockDeviceMappings:
        - DeviceName: "device-name"
          VirtualName: "virtual-name"
          Ebs:
            DeleteOnTermination: true
            Encrypted: true
            Iops: 100
            KmsKeyId: !Ref KmsKeyId
            SnapshotId: "snapshot-id"
            VolumeType: "gp2"
            VolumeSize: 100
      Tags:
        CustomerImageRecipeTagKey1: 'CustomerImageRecipeTagValue1'
        CustomerImageRecipeTagKey2: 'CustomerImageRecipeTagValue2'

JSON

{
    "Resources": {
        "ImageRecipeAllParameters": {
            "Type": "AWS::ImageBuilder::ImageRecipe",
            "Properties": {
                "Name": "image-recipe-name",
                "Version": "1.0.0",
                "ParentImage": {
                    "Ref": "ParentImage"
                },
                "Description": "description",
                "Components": [
                    {
                        "ComponentArn": {
                            "Ref": "ComponentArn"
                        }
                    },
                    {
                        "ComponentArn": {
                            "Ref": "AnotherComponentArn"
                        }
                    }
                ],
                "BlockDeviceMappings": [
                    {
                        "DeviceName": "device-name",
                        "VirtualName": "virtual-name",
                        "Ebs": {
                            "DeleteOnTermination": true,
                            "Encrypted": true,
                            "Iops": 100,
                            "KmsKeyId": {
                                "Ref": "KmsKeyId"
                            },
                            "SnapshotId": "snapshot-id",
                            "VolumeType": "gp2",
                            "VolumeSize": 100
                        }
                    }
                ],
                "Tags": {
                    "CustomerImageRecipeTagKey1": "CustomerImageRecipeTagValue1",
                    "CustomerImageRecipeTagKey2": "CustomerImageRecipeTagValue2"
                }
            }
        }
    }
}

Create an image recipe with AMI tags and watermarks

The following example creates an image recipe that applies tags and watermarks to the output AMI, and provides a custom user data script for the build instance.

YAML

Resources:
  RecipeWithExtras:
    Type: AWS::ImageBuilder::ImageRecipe
    Properties:
      Name: recipe-with-extras
      Version: '1.0.0'
      ParentImage: !Ref LatestAmazonLinux2Ami
      Components:
        - ComponentArn: !GetAtt HardeningComponent.Arn
      AmiTags:
        CostCenter: '12345'
        PatchLevel: latest
      AmiWatermarks:
        - production-approved
        - security-hardened
      AdditionalInstanceConfiguration:
        SystemsManagerAgent:
          UninstallAfterBuild: true
        UserDataOverride: !Base64 |
          #!/bin/bash
          yum update -y
      WorkingDirectory: /tmp
      Tags:
        Team: platform

JSON

{
    "Resources": {
        "RecipeWithExtras": {
            "Type": "AWS::ImageBuilder::ImageRecipe",
            "Properties": {
                "Name": "recipe-with-extras",
                "Version": "1.0.0",
                "ParentImage": {
                    "Ref": "LatestAmazonLinux2Ami"
                },
                "Components": [
                    {
                        "ComponentArn": {
                            "Fn::GetAtt": ["HardeningComponent", "Arn"]
                        }
                    }
                ],
                "AmiTags": {
                    "CostCenter": "12345",
                    "PatchLevel": "latest"
                },
                "AmiWatermarks": [
                    "production-approved",
                    "security-hardened"
                ],
                "AdditionalInstanceConfiguration": {
                    "SystemsManagerAgent": {
                        "UninstallAfterBuild": true
                    },
                    "UserDataOverride": {
                        "Fn::Base64": "#!/bin/bash\nyum update -y\n"
                    }
                },
                "WorkingDirectory": "/tmp",
                "Tags": {
                    "Team": "platform"
                }
            }
        }
    }
}

See also