ImagePipeline

Details of an image pipeline.

arn

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

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

Required: No

containerRecipeArn

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

Type: String

Required: No

dateCreated

The date on which this image pipeline was created.

Type: String

Required: No

dateLastRun

This is no longer supported, and does not return a value.

Type: String

Required: No

dateNextRun

The next date when the pipeline is scheduled to run.

Type: String

Required: No

dateUpdated

The date on which this image pipeline was last updated.

Type: String

Required: No

description

The description of the image pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

distributionConfigurationArn

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

Type: String

Required: No

enhancedImageMetadataEnabled

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Type: Boolean

Required: No

executionRole

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

imageRecipeArn

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

Type: String

Required: No

imageScanningConfiguration

Contains settings for vulnerability scans.

Type: ImageScanningConfiguration object

Required: No

imageTestsConfiguration

The image tests configuration of the image pipeline.

Type: ImageTestsConfiguration object

Required: No

infrastructureConfigurationArn

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

Type: String

Required: No

name

The name of the image pipeline.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: No

platform

The platform of the image pipeline.

Type: String

Valid Values: Windows | Linux

Required: No

schedule

The schedule of the image pipeline.

Type: Schedule object

Required: No

status

The status of the image pipeline.

Type: String

Valid Values: DISABLED | ENABLED

Required: No

tags

The tags of this image pipeline.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

workflows

Contains the workflows that run for the image pipeline.

Type: Array of WorkflowConfiguration objects

Required: No

ImagePipeline

Contents

See Also