Interface ImagePipeline.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ImagePipeline.Builder,ImagePipeline>, SdkBuilder<ImagePipeline.Builder,ImagePipeline>, SdkPojo
Enclosing class:
ImagePipeline
@Mutable @NotThreadSafe public static interface ImagePipeline.Builder extends SdkPojo, CopyableBuilder<ImagePipeline.Builder,ImagePipeline>

  • Method Details

    • arn

      ImagePipeline.Builder arn(String 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

      ImagePipeline.Builder name(String 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

      ImagePipeline.Builder description(String 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

      ImagePipeline.Builder platform(String 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

      ImagePipeline.Builder platform(Platform 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

      ImagePipeline.Builder enhancedImageMetadataEnabled(Boolean 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

      ImagePipeline.Builder imageRecipeArn(String 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

      ImagePipeline.Builder containerRecipeArn(String 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

      ImagePipeline.Builder infrastructureConfigurationArn(String 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

      ImagePipeline.Builder distributionConfigurationArn(String 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

      ImagePipeline.Builder imageTestsConfiguration(ImageTestsConfiguration 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 the ImageTestsConfiguration.Builder avoiding the need to create one manually via ImageTestsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageTestsConfiguration(ImageTestsConfiguration).

      Parameters:
      imageTestsConfiguration - a consumer that will call methods on ImageTestsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedule

      ImagePipeline.Builder schedule(Schedule 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

      default ImagePipeline.Builder schedule(Consumer<Schedule.Builder> schedule)

      The schedule of the image pipeline.

      This is a convenience method that creates an instance of the Schedule.Builder avoiding the need to create one manually via Schedule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(Schedule).

      Parameters:
      schedule - a consumer that will call methods on Schedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ImagePipeline.Builder status(String 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

      ImagePipeline.Builder status(PipelineStatus 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

      ImagePipeline.Builder dateCreated(String 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

      ImagePipeline.Builder dateUpdated(String 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

      ImagePipeline.Builder dateLastRun(String 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.

    • lastRunStatus

      ImagePipeline.Builder lastRunStatus(String lastRunStatus)

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

      Parameters:
      lastRunStatus - The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastRunStatus

      ImagePipeline.Builder lastRunStatus(ImageStatus lastRunStatus)

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

      Parameters:
      lastRunStatus - The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dateNextRun

      ImagePipeline.Builder dateNextRun(String 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

      ImagePipeline.Builder tags(Map<String,String> 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 the ImageScanningConfiguration.Builder avoiding the need to create one manually via ImageScanningConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageScanningConfiguration(ImageScanningConfiguration).

      Parameters:
      imageScanningConfiguration - a consumer that will call methods on ImageScanningConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRole

      ImagePipeline.Builder 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.

      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

      ImagePipeline.Builder workflows(Collection<WorkflowConfiguration> 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

      ImagePipeline.Builder workflows(WorkflowConfiguration... 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

      ImagePipeline.Builder workflows(Consumer<WorkflowConfiguration.Builder>... workflows)

      Contains the workflows that run for the image pipeline.

      This is a convenience method that creates an instance of the WorkflowConfiguration.Builder avoiding the need to create one manually via WorkflowConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workflows(List<WorkflowConfiguration>).

      Parameters:
      workflows - a consumer that will call methods on WorkflowConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingConfiguration

      ImagePipeline.Builder loggingConfiguration(PipelineLoggingConfiguration loggingConfiguration)

      Defines logging configuration for the output image.

      Parameters:
      loggingConfiguration - Defines logging configuration for the output image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default ImagePipeline.Builder loggingConfiguration(Consumer<PipelineLoggingConfiguration.Builder> loggingConfiguration)

      Defines logging configuration for the output image.

      This is a convenience method that creates an instance of the PipelineLoggingConfiguration.Builder avoiding the need to create one manually via PipelineLoggingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(PipelineLoggingConfiguration).

      Parameters:
      loggingConfiguration - a consumer that will call methods on PipelineLoggingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • consecutiveFailures

      ImagePipeline.Builder consecutiveFailures(Integer 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 exceeds 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.

      Parameters:
      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 exceeds 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.