AWS Fundamentals Logo
AWS Fundamentals
AWS::ImageBuilder::Image

ImageBuilder Image

Resource schema for AWS::ImageBuilder::Image

Properties

13 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
ContainerRecipeArn
string
Create-only
DeletionSettings
DeletionSettings
Write-only
DistributionConfigurationArn
string
Create-only
EnhancedImageMetadataEnabled
boolean
Create-only
ExecutionRole
string
ImagePipelineExecutionSettings
ImagePipelineExecutionSettings
Write-only
ImageRecipeArn
string
Create-only
ImageScanningConfiguration
ImageScanningConfiguration
Create-only
ImageTestsConfiguration
ImageTestsConfiguration
Create-only
InfrastructureConfigurationArn
string
Create-only
LoggingConfiguration
ImageLoggingConfiguration
Tags
object
Workflows
Array<WorkflowConfiguration>
Create-only

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the image.
ImageIdstringThe AMI ID of the EC2 AMI in current region.
ImageUristringURI for containers created in current Region with default ECR image tag
LatestVersionLatestVersionThe latest version references of the image.
NamestringThe name of the image.

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::Image

Resources:
  MyResource:
    Type: AWS::ImageBuilder::Image
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

read

imagebuilder:GetImage

create

ecr:BatchGetRepositoryScanningConfigurationiam:GetRoleiam:PassRoleiam:CreateServiceLinkedRoleimagebuilder:GetImageRecipeimagebuilder:GetInfrastructureConfigurationimagebuilder:GetDistributionConfigurationimagebuilder:GetWorkflow

update

imagebuilder:TagResourceimagebuilder:UntagResource

list

imagebuilder:ListImagesimagebuilder:ListImageBuildVersions

delete

imagebuilder:GetImageimagebuilder:DeleteImageimagebuilder:UntagResourceimagebuilder:CancelImageCreation

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

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

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

ImageRecipeArnContainerRecipeArnInfrastructureConfigurationArnWorkflowsDistributionConfigurationArnImageTestsConfigurationImageScanningConfigurationEnhancedImageMetadataEnabled

Related Resources

External Links