Interface ImagePipeline.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ImagePipeline.Builder,
,ImagePipeline> SdkBuilder<ImagePipeline.Builder,
,ImagePipeline> SdkPojo
- Enclosing class:
ImagePipeline
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the image pipeline.containerRecipeArn
(String containerRecipeArn) The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.dateCreated
(String dateCreated) The date on which this image pipeline was created.dateLastRun
(String dateLastRun) This is no longer supported, and does not return a value.dateNextRun
(String dateNextRun) The next date when the pipeline is scheduled to run.dateUpdated
(String dateUpdated) The date on which this image pipeline was last updated.description
(String description) The description of the image pipeline.distributionConfigurationArn
(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.enhancedImageMetadataEnabled
(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.executionRole
(String executionRole) The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.imageRecipeArn
(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.default ImagePipeline.Builder
imageScanningConfiguration
(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration) Contains settings for vulnerability scans.imageScanningConfiguration
(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.default ImagePipeline.Builder
imageTestsConfiguration
(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image tests configuration of the image pipeline.imageTestsConfiguration
(ImageTestsConfiguration imageTestsConfiguration) The image tests configuration of the image pipeline.infrastructureConfigurationArn
(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.The name of the image pipeline.The platform of the image pipeline.The platform of the image pipeline.default ImagePipeline.Builder
schedule
(Consumer<Schedule.Builder> schedule) The schedule of the image pipeline.The schedule of the image pipeline.The status of the image pipeline.status
(PipelineStatus status) The status of the image pipeline.The tags of this image pipeline.workflows
(Collection<WorkflowConfiguration> workflows) Contains the workflows that run for the image pipeline.workflows
(Consumer<WorkflowConfiguration.Builder>... workflows) Contains the workflows that run for the image pipeline.workflows
(WorkflowConfiguration... workflows) Contains the workflows that run for the image pipeline.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the image pipeline.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the image pipeline.
- Parameters:
name
- The name of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the image pipeline.
- Parameters:
description
- The description of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platform
The platform of the image pipeline.
- Parameters:
platform
- The platform of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platform
The platform of the image pipeline.
- Parameters:
platform
- The platform of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
- Parameters:
imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
- Parameters:
containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- Parameters:
infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- Parameters:
distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageTestsConfiguration
The image tests configuration of the image pipeline.
- Parameters:
imageTestsConfiguration
- The image tests configuration of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageTestsConfiguration
default ImagePipeline.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image tests configuration of the image pipeline.
This is a convenience method that creates an instance of theImageTestsConfiguration.Builder
avoiding the need to create one manually viaImageTestsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimageTestsConfiguration(ImageTestsConfiguration)
.- Parameters:
imageTestsConfiguration
- a consumer that will call methods onImageTestsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
schedule
The schedule of the image pipeline.
- Parameters:
schedule
- The schedule of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schedule
The schedule of the image pipeline.
This is a convenience method that creates an instance of theSchedule.Builder
avoiding the need to create one manually viaSchedule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschedule(Schedule)
.- Parameters:
schedule
- a consumer that will call methods onSchedule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the image pipeline.
- Parameters:
status
- The status of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the image pipeline.
- Parameters:
status
- The status of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dateCreated
The date on which this image pipeline was created.
- Parameters:
dateCreated
- The date on which this image pipeline was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateUpdated
The date on which this image pipeline was last updated.
- Parameters:
dateUpdated
- The date on which this image pipeline was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateLastRun
This is no longer supported, and does not return a value.
- Parameters:
dateLastRun
- This is no longer supported, and does not return a value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateNextRun
The next date when the pipeline is scheduled to run.
- Parameters:
dateNextRun
- The next date when the pipeline is scheduled to run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags of this image pipeline.
- Parameters:
tags
- The tags of this image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageScanningConfiguration
ImagePipeline.Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.
- Parameters:
imageScanningConfiguration
- Contains settings for vulnerability scans.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageScanningConfiguration
default ImagePipeline.Builder imageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration) Contains settings for vulnerability scans.
This is a convenience method that creates an instance of theImageScanningConfiguration.Builder
avoiding the need to create one manually viaImageScanningConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimageScanningConfiguration(ImageScanningConfiguration)
.- Parameters:
imageScanningConfiguration
- a consumer that will call methods onImageScanningConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
executionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
- Parameters:
executionRole
- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflows
Contains the workflows that run for the image pipeline.
- Parameters:
workflows
- Contains the workflows that run for the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflows
Contains the workflows that run for the image pipeline.
- Parameters:
workflows
- Contains the workflows that run for the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflows
Contains the workflows that run for the image pipeline.
This is a convenience method that creates an instance of theWorkflowConfiguration.Builder
avoiding the need to create one manually viaWorkflowConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflows(List<WorkflowConfiguration>)
.- Parameters:
workflows
- a consumer that will call methods onWorkflowConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-