AWS::ImageBuilder::ImageRecipe

ImageBuilder ImageRecipe

Resource schema for AWS::ImageBuilder::ImageRecipe

Properties

10 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`ParentImage`	`string`	RequiredCreate-only
`Version`	`string`	RequiredCreate-only
`AdditionalInstanceConfiguration`	`AdditionalInstanceConfiguration`
`AmiTags`	`object`
`BlockDeviceMappings`	`Array<InstanceBlockDeviceMapping>`	Create-only
`Components`	`Array<ComponentConfiguration>`	Create-only
`Description`	`string`	Create-only
`Tags`	`object`
`WorkingDirectory`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the image recipe.
`LatestVersion`	`LatestVersion`	The latest version references of the image recipe.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ImageBuilder::ImageRecipe

Resources:
  MyResource:
    Type: AWS::ImageBuilder::ImageRecipe
    Properties:
      Name: "my-name"
      Version: "value"
      ParentImage: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:GetRoleiam:CreateServiceLinkedRoleimagebuilder:GetComponentimagebuilder:GetImageimagebuilder:TagResourceimagebuilder:GetImageRecipeimagebuilder:CreateImageRecipeec2:DescribeImages

read

imagebuilder:GetImageRecipe

update

imagebuilder:TagResourceimagebuilder:UntagResource

delete

imagebuilder:UntagResourceimagebuilder:GetImageRecipeimagebuilder:DeleteImageRecipe

list

imagebuilder:ListImageRecipes

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceImageBuilder

Properties12

Required3

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameVersionComponentsParentImageDescriptionBlockDeviceMappingsWorkingDirectory

Related Resources

External Links

AWS Documentation