AWS Fundamentals Logo
AWS Fundamentals
AWS::ImageBuilder::ContainerRecipe

ImageBuilder ContainerRecipe

Resource schema for AWS::ImageBuilder::ContainerRecipe

Properties

15 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
Components
Array<ComponentConfiguration>
Create-only
ContainerType
string
Create-only
Description
string
Create-only
DockerfileTemplateData
string
Create-onlyWrite-only
DockerfileTemplateUri
string
Create-onlyWrite-only
ImageOsVersionOverride
string
Create-onlyWrite-only
InstanceConfiguration
InstanceConfiguration
Create-only
KmsKeyId
string
Create-only
Name
string
Create-only
ParentImage
string
Create-only
PlatformOverride
string
Create-onlyWrite-only
Tags
object
TargetRepository
TargetContainerRepository
Create-only
Version
string
Create-only
WorkingDirectory
string
Create-only

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the container recipe.
LatestVersionLatestVersionThe latest version references of the container 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::ContainerRecipe

Resources:
  MyResource:
    Type: AWS::ImageBuilder::ContainerRecipe
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

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

create

iam:GetRoleiam:CreateServiceLinkedRoleimagebuilder:GetComponentimagebuilder:TagResourceimagebuilder:GetContainerRecipeimagebuilder:CreateContainerRecipeimagebuilder:GetImagekms:Encrypt

read

imagebuilder:GetContainerRecipekms:Decrypt

update

imagebuilder:TagResourceimagebuilder:UntagResource

delete

imagebuilder:UntagResourceimagebuilder:GetContainerRecipeimagebuilder:DeleteContainerRecipe

list

imagebuilder:ListContainerRecipes

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
Properties17
Required0
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

NameVersionContainerTypeTargetRepositoryInstanceConfigurationParentImageDescriptionDockerfileTemplateUriDockerfileTemplateDataImageOsVersionOverrideKmsKeyIdPlatformOverrideWorkingDirectoryComponents

Related Resources

External Links