IImage

class aws_cdk.aws_imagebuilder_alpha.IImage(*args, **kwargs)

Bases: IResource, Protocol

(experimental) An EC2 Image Builder Image.

Stability:

experimental

Methods

apply_removal_policy(policy)

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).

Parameters:

policy (RemovalPolicy)

Return type:

None

grant(grantee, *actions)

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

Parameters:
  • grantee (IGrantable) – The principal.

  • actions (str) – The list of actions.

Stability:

experimental

Return type:

Grant

grant_default_execution_role_permissions(grantee)

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

Parameters:

grantee (IGrantable) – The execution role used for the image build.

Stability:

experimental

Return type:

List[Grant]

grant_read(grantee)

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

Parameters:

grantee (IGrantable) – The principal.

Stability:

experimental

Return type:

Grant

to_base_image()

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

Stability:

experimental

Return type:

BaseImage

to_container_base_image()

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

Stability:

experimental

Return type:

BaseContainerImage

Attributes

env

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.

image_arn

(experimental) The ARN of the image.

Stability:

experimental

Attribute:

true

image_name

(experimental) The name of the image.

Stability:

experimental

Attribute:

true

image_version

(experimental) The version of the image.

Stability:

experimental

Attribute:

true

node

The tree node.

stack

The stack in which this resource is defined.