interface IImage 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.IImage
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#IImage
Java	software.amazon.awscdk.services.imagebuilder.alpha.IImage
Python	aws_cdk.aws_imagebuilder_alpha.IImage
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » IImage

Implemented by Image

Obtainable from AmazonManagedImage.amazonLinux2(), AmazonManagedImage.amazonLinux2023(), AmazonManagedImage.fromAmazonManagedImageAttributes(), AmazonManagedImage.fromAmazonManagedImageName(), AmazonManagedImage.macOS14(), AmazonManagedImage.macOS15(), AmazonManagedImage.redHatEnterpriseLinux10(), AmazonManagedImage.suseLinuxEnterpriseServer15(), AmazonManagedImage.ubuntuServer2204(), AmazonManagedImage.ubuntuServer2404(), AmazonManagedImage.windowsServer2016Core(), AmazonManagedImage.windowsServer2016Full(), AmazonManagedImage.windowsServer2019Core(), AmazonManagedImage.windowsServer2019Full(), AmazonManagedImage.windowsServer2022Core(), AmazonManagedImage.windowsServer2022Full(), AmazonManagedImage.windowsServer2025Core(), AmazonManagedImage.windowsServer2025Full(), Image.fromImageArn(), Image.fromImageAttributes(), Image.fromImageName()

An EC2 Image Builder Image.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
imageArn🔹	string	The ARN of the image.
imageName🔹	string	The name of the image.
imageVersion🔹	string	The version of the image.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

imageArn🔹

Type: string

The ARN of the image.

---

imageName🔹

Type: string

The name of the image.

---

imageVersion🔹

Type: string

The version of the image.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant custom actions to the given grantee for the image.
grantDefaultExecutionRolePermissions(grantee)🔹	Grants the default permissions for building an image to the provided execution role.
grantRead(grantee)🔹	Grant read permissions to the given grantee for the image.
toBaseImage()🔹	Converts the image to a BaseImage, to use as the parent image in an image recipe.
toContainerBaseImage()🔹	Converts the image to a ContainerBaseImage, to use as the parent image in a container recipe.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• actions string — The list of actions.

Returns

• Grant

Grant custom actions to the given grantee for the image.

---

grantDefaultExecutionRolePermissions(grantee)🔹

public grantDefaultExecutionRolePermissions(grantee: IGrantable): Grant[]

Parameters

• grantee IGrantable — The execution role used for the image build.

Returns

• Grant[]

Grants the default permissions for building an image to the provided execution role.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Grant read permissions to the given grantee for the image.

---

toBaseImage()🔹

public toBaseImage(): BaseImage

Returns

• BaseImage

Converts the image to a BaseImage, to use as the parent image in an image recipe.

---

toContainerBaseImage()🔹

public toContainerBaseImage(): BaseContainerImage

Returns

• BaseContainerImage

Converts the image to a ContainerBaseImage, to use as the parent image in a container recipe.