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.
Contents
- arn
-
The Amazon Resource Name (ARN) of the image pipeline.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?: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
- consecutiveFailures
-
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:
-
If the pipeline execution is successful, the number of consecutive failures resets to zero.
-
If the pipeline execution fails, Image Builder increments the number of consecutive failures. If the failure count reaches the limit defined in the AutoDisablePolicy, Image Builder disables the pipeline.
The consecutive failure count is also reset to zero under the following conditions:
-
The pipeline runs manually and succeeds.
-
The pipeline configuration is updated.
If the pipeline runs manually and fails, the count remains the same. The next scheduled run continues to increment where it left off before.
Type: Integer
Valid Range: Minimum value of 0.
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
-
The date on which this image pipeline was last run.
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
-
Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to
true.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 that Amazon Inspector runs against the test instance during image creation.
Type: ImageScanningConfiguration object
Required: No
- imageTags
-
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.
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-Z0-9\s_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
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
- lastRunStatus
-
The status of the last image that this pipeline built, such as
BUILDING,TESTING,FAILED, orAVAILABLE.Type: String
Valid Values:
PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED | DISABLEDRequired: No
- loggingConfiguration
-
The CloudWatch Logs configuration for the pipeline: the log group for image build logs and the log group for pipeline execution logs.
Type: PipelineLoggingConfiguration object
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, inherited from the recipe that the pipeline uses.
Type: String
Valid Values:
Windows | Linux | macOSRequired: No
- schedule
-
The schedule of the image pipeline.
Type: Schedule object
Required: No
- status
-
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.
Type: String
Valid Values:
DISABLED | ENABLEDRequired: No
-
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-Z0-9\s_.:/=+\-@]*$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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: