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

Experimental

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

IImage Interface

An EC2 Image Builder Image.

IImage

extends

• IResource

implemented by

• Image

Stability

Experimental

Source

lib/image.ts

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

imageArnstringimage_arnstrimageArnStringImageArnstringImageArn*stringrequired#

The ARN of the image.

imageNamestringimage_namestrimageNameStringImageNamestringImageName*stringrequired#

The name of the image.

imageVersionstringimage_versionstrimageVersionStringImageVersionstringImageVersion*stringrequired#

The version of the image.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

Grant custom actions to the given grantee for the image.

2 parameters

Parameters

• granteegranteegranteegranteeGrantee — The principal.
• actionsactionsactionsactionsActions — The list of actions.

grantDefaultExecutionRolePermissions(grantee: IGrantable): Grant[]def grant_default_execution_role_permissions(self, grantee: IGrantable) -> typing.List[Grant]public List<Grant> grantDefaultExecutionRolePermissions(IGrantable grantee)public Grant[] GrantDefaultExecutionRolePermissions(IGrantable grantee)func GrantDefaultExecutionRolePermissions(Grantee IGrantable) *[]Grant#

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

1 parameter

Parameters

• granteegranteegranteegranteeGrantee — The execution role used for the image build.

grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#

Grant read permissions to the given grantee for the image.

1 parameter

Parameters

• granteegranteegranteegranteeGrantee — The principal.

toBaseImage(): BaseImagedef to_base_image(self, ) -> BaseImagepublic BaseImage toBaseImage()public BaseImage ToBaseImage()func ToBaseImage() BaseImage#

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

toContainerBaseImage(): BaseContainerImagedef to_container_base_image(self, ) -> BaseContainerImagepublic BaseContainerImage toContainerBaseImage()public BaseContainerImage ToContainerBaseImage()func ToContainerBaseImage() BaseContainerImage#

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining