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

Interface IImagePipeline.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IImagePipeline, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IImagePipeline.Jsii$Proxy

Enclosing interface:

IImagePipeline

@Internal
public static interface IImagePipeline.Jsii$Default
extends IImagePipeline, IResource.Jsii$Default

Internal default implementation for IImagePipeline.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.imagebuilder.alpha.IImagePipeline

IImagePipeline.Jsii$Default, IImagePipeline.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default String	getImagePipelineArn()	(experimental) The ARN of the image pipeline.
default String	getImagePipelineName()	(experimental) The name of the image pipeline.
default software.constructs.Node	getNode()	The tree node.
default Stack	getStack()	The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant custom actions to the given grantee for the image pipeline.
default List<Grant>	grantDefaultExecutionRolePermissions(IGrantable grantee)	(experimental) Grants the default permissions for building an image to the provided execution role.
default Grant	grantRead(IGrantable grantee)	(experimental) Grant read permissions to the given grantee for the image pipeline.
default Grant	grantStartExecution(IGrantable grantee)	(experimental) Grant permissions to the given grantee to start an execution of the image pipeline.
default Rule	onCVEDetected(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder CVE detected events.
default Rule	onEvent(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder events.
default Rule	onImageBuildCompleted(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image build completion events.
default Rule	onImageBuildFailed(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image build failure events.
default Rule	onImageBuildStateChange(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image state change events.
default Rule	onImageBuildSucceeded(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image success events.
default Rule	onImagePipelineAutoDisabled(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.
default Rule	onWaitForAction(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Methods inherited from interface software.amazon.awscdk.services.imagebuilder.alpha.IImagePipeline

onCVEDetected, onEvent, onImageBuildCompleted, onImageBuildFailed, onImageBuildStateChange, onImageBuildSucceeded, onImagePipelineAutoDisabled, onWaitForAction

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getImagePipelineArn

@Stability(Experimental)
@NotNull
default String getImagePipelineArn()

(experimental) The ARN of the image pipeline.

Specified by:

getImagePipelineArn in interface IImagePipeline

getImagePipelineName

@Stability(Experimental)
@NotNull
default String getImagePipelineName()

(experimental) The name of the image pipeline.

Specified by:

getImagePipelineName in interface IImagePipeline

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

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

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

Specified by:

grant in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

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

grantDefaultExecutionRolePermissions

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

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

Specified by:

grantDefaultExecutionRolePermissions in interface IImagePipeline

Parameters:

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

grantRead

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

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

Specified by:

grantRead in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

grantStartExecution

@Stability(Experimental)
@NotNull
default Grant grantStartExecution(@NotNull
 IGrantable grantee)

(experimental) Grant permissions to the given grantee to start an execution of the image pipeline.

Specified by:

grantStartExecution in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

onCVEDetected

@Stability(Experimental)
@NotNull
default Rule onCVEDetected(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder CVE detected events.

Specified by:

onCVEDetected in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onEvent

@Stability(Experimental)
@NotNull
default Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder events.

Specified by:

onEvent in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildCompleted

@Stability(Experimental)
@NotNull
default Rule onImageBuildCompleted(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image build completion events.

Specified by:

onImageBuildCompleted in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildFailed

@Stability(Experimental)
@NotNull
default Rule onImageBuildFailed(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image build failure events.

Specified by:

onImageBuildFailed in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildStateChange

@Stability(Experimental)
@NotNull
default Rule onImageBuildStateChange(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image state change events.

Specified by:

onImageBuildStateChange in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildSucceeded

@Stability(Experimental)
@NotNull
default Rule onImageBuildSucceeded(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image success events.

Specified by:

onImageBuildSucceeded in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImagePipelineAutoDisabled

@Stability(Experimental)
@NotNull
default Rule onImagePipelineAutoDisabled(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.

Specified by:

onImagePipelineAutoDisabled in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onWaitForAction

@Stability(Experimental)
@NotNull
default Rule onWaitForAction(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Specified by:

onWaitForAction in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html