@aws-cdk/aws-imagebuilder-alpha.ImageAttributes

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ImageAttributes Struct

Properties for an EC2 Image Builder image.

Stability

Experimental

Source

lib/image.ts

Example

// Import by name
const existingImageByName = imagebuilder.Image.fromImageName(
  this,
  'ExistingImageByName',
  'my-existing-image'
);

// Import by ARN
const existingImageByArn = imagebuilder.Image.fromImageArn(
  this,
  'ExistingImageByArn',
  'arn:aws:imagebuilder:us-east-1:123456789012:image/imported-image/1.0.0'
);

// Import by attributes
const existingImageByAttributes = imagebuilder.Image.fromImageAttributes(this, 'ExistingImageByAttributes', {
  imageName: 'shared-base-image',
  imageVersion: '2024.11.25'
});

// Grant permissions to imported images
const role = new iam.Role(this, 'ImageAccessRole', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com')
});

existingImageByName.grantRead(role);
existingImageByArn.grant(role, 'imagebuilder:GetImage', 'imagebuilder:ListImagePackages');

Properties

imageArn?optionalstringimage_arn?optionalstrimageArn?optionalStringImageArn?optionalstringImageArn?optional*string#

The ARN of the image.

Default: derived from the imageName

imageName?optionalstringimage_name?optionalstrimageName?optionalStringImageName?optionalstringImageName?optional*string#

The name of the image.

Default: derived from the imageArn

imageVersion?optionalstringimage_version?optionalstrimageVersion?optionalStringImageVersion?optionalstringImageVersion?optional*string#

The version of the image.

Default: the latest version of the image, x.x.x