ImagePipeline

Defines the automation configuration for building, testing, and distributing images. A pipeline references the resources that its builds use, such as the recipe and infrastructure configuration. It also holds the settings that control its builds, such as the schedule and custom workflows.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN) of the image pipeline.

Link copied to clipboard

Image Builder tracks the number of consecutive failures for scheduled pipeline executions and takes one of the following actions each time it runs on a schedule:

Link copied to clipboard

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

Link copied to clipboard

The date on which this image pipeline was created.

Link copied to clipboard

The date on which this image pipeline was last run.

Link copied to clipboard

The next date when the pipeline is scheduled to run.

Link copied to clipboard

The date on which this image pipeline was last updated.

Link copied to clipboard

The description of the image pipeline.

Link copied to clipboard

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

Link copied to clipboard

Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

Link copied to clipboard

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Link copied to clipboard

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

Link copied to clipboard

Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

Link copied to clipboard

The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. Builds that you start manually use the tags from the StartImagePipelineExecution request instead.

Link copied to clipboard

The image tests configuration of the image pipeline.

Link copied to clipboard

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

Link copied to clipboard

The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.

Link copied to clipboard

The CloudWatch Logs configuration for the pipeline: the log group for image build logs and the log group for pipeline execution logs.

Link copied to clipboard
val name: String?

The name of the image pipeline.

Link copied to clipboard

The platform of the image pipeline, inherited from the recipe that the pipeline uses.

Link copied to clipboard

The schedule of the image pipeline.

Link copied to clipboard

The status of the image pipeline. A disabled pipeline doesn't run on its schedule, but you can still start builds manually. Image Builder can also disable a pipeline automatically when consecutive scheduled builds fail.

Link copied to clipboard

The tags of this image pipeline.

Link copied to clipboard

Contains the workflows that run for the image pipeline.

Functions

Link copied to clipboard
inline fun copy(block: ImagePipeline.Builder.() -> Unit = {}): ImagePipeline
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String