Show / Hide Table of Contents

Interface IImage

(experimental) An EC2 Image Builder Image.

Inherited Members
IResource.ApplyRemovalPolicy(RemovalPolicy)
IResource.Stack
IEnvironmentAware.Env
Namespace: Amazon.CDK.AWS.ImageBuilder.Alpha
Assembly: Amazon.CDK.AWS.ImageBuilder.Alpha.dll
Syntax (csharp)
public interface IImage : IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IImage Inherits IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

Stability: Experimental

Synopsis

Properties

ImageArn

(experimental) The ARN of the image.

ImageName

(experimental) The name of the image.

ImageVersion

(experimental) The version of the image.

Methods

Grant(IGrantable, params string[])

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

GrantDefaultExecutionRolePermissions(IGrantable)

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

GrantRead(IGrantable)

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

ToBaseImage()

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

ToContainerBaseImage()

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

Properties

ImageArn

(experimental) The ARN of the image.

string ImageArn { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

ImageName

(experimental) The name of the image.

string ImageName { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

ImageVersion

(experimental) The version of the image.

string ImageVersion { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

Grant(IGrantable, params string[])

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

Grant Grant(IGrantable grantee, params string[] actions)
Parameters
grantee IGrantable

The principal.

actions string[]

The list of actions.

Returns

Grant

Remarks

Stability: Experimental

GrantDefaultExecutionRolePermissions(IGrantable)

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

Grant[] GrantDefaultExecutionRolePermissions(IGrantable grantee)
Parameters
grantee IGrantable

The execution role used for the image build.

Returns

Grant[]

Remarks

Stability: Experimental

GrantRead(IGrantable)

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

Grant GrantRead(IGrantable grantee)
Parameters
grantee IGrantable

The principal.

Returns

Grant

Remarks

Stability: Experimental

ToBaseImage()

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

BaseImage ToBaseImage()
Returns

BaseImage

Remarks

Stability: Experimental

ToContainerBaseImage()

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

BaseContainerImage ToContainerBaseImage()
Returns

BaseContainerImage

Remarks

Stability: Experimental

Back to top Generated by DocFX