Package software.amazon.awscdk.services.imagebuilder.alpha

Interface IImage

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IImage.Jsii$Default

All Known Implementing Classes:

IImage.Jsii$Proxy, Image

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:50.029Z")
@Stability(Experimental)
public interface IImage
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) An EC2 Image Builder Image.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IImage.Jsii$Default	Internal default implementation for IImage.
static final class	IImage.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getImageArn()	(experimental) The ARN of the image.
String	getImageName()	(experimental) The name of the image.
String	getImageVersion()	(experimental) The version of the image.
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant custom actions to the given grantee for the image.
List<Grant>	grantDefaultExecutionRolePermissions(IGrantable grantee)	(experimental) Grants the default permissions for building an image to the provided execution role.
Grant	grantRead(IGrantable grantee)	(experimental) Grant read permissions to the given grantee for the image.
BaseImage	toBaseImage()	(experimental) Converts the image to a BaseImage, to use as the parent image in an image recipe.
BaseContainerImage	toContainerBaseImage()	(experimental) Converts the image to a ContainerBaseImage, to use as the parent image in a container recipe.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageArn

@Stability(Experimental)
@NotNull
String getImageArn()

(experimental) The ARN of the image.

getImageName

@Stability(Experimental)
@NotNull
String getImageName()

(experimental) The name of the image.

getImageVersion

@Stability(Experimental)
@NotNull
String getImageVersion()

(experimental) The version of the image.

grant

@Stability(Experimental)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant custom actions to the given grantee for the image.

Parameters:

grantee - The principal. This parameter is required.

actions - The list of actions. This parameter is required.

grantDefaultExecutionRolePermissions

@Stability(Experimental)
@NotNull
List<Grant> grantDefaultExecutionRolePermissions(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - The execution role used for the image build. This parameter is required.

grantRead

@Stability(Experimental)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

(experimental) Grant read permissions to the given grantee for the image.

Parameters:

grantee - The principal. This parameter is required.

toBaseImage

@Stability(Experimental)
@NotNull
BaseImage toBaseImage()

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

toContainerBaseImage

@Stability(Experimental)
@NotNull
BaseContainerImage toContainerBaseImage()

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