Package software.amazon.awscdk.services.imagebuilder.alpha

Class ImagePipelineProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.alpha.ImagePipelineProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ImagePipelineProps>

Enclosing interface:

ImagePipelineProps

@Stability(Experimental)
public static final class ImagePipelineProps.Builder
extends Object
implements software.amazon.jsii.Builder<ImagePipelineProps>

A builder for ImagePipelineProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ImagePipelineProps	build()	Builds the configured instance.
ImagePipelineProps.Builder	description(String description)	Sets the value of ImagePipelineProps.getDescription()
ImagePipelineProps.Builder	distributionConfiguration(IDistributionConfiguration distributionConfiguration)	Sets the value of ImagePipelineProps.getDistributionConfiguration()
ImagePipelineProps.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)	Sets the value of ImagePipelineProps.getEnhancedImageMetadataEnabled()
ImagePipelineProps.Builder	executionRole(IRole executionRole)	Sets the value of ImagePipelineProps.getExecutionRole()
ImagePipelineProps.Builder	imageLogGroup(ILogGroup imageLogGroup)	Sets the value of ImagePipelineProps.getImageLogGroup()
ImagePipelineProps.Builder	imagePipelineLogGroup(ILogGroup imagePipelineLogGroup)	Sets the value of ImagePipelineProps.getImagePipelineLogGroup()
ImagePipelineProps.Builder	imagePipelineName(String imagePipelineName)	Sets the value of ImagePipelineProps.getImagePipelineName()
ImagePipelineProps.Builder	imageScanningEcrRepository(IRepository imageScanningEcrRepository)	Sets the value of ImagePipelineProps.getImageScanningEcrRepository()
ImagePipelineProps.Builder	imageScanningEcrTags(List<String> imageScanningEcrTags)	Sets the value of ImagePipelineProps.getImageScanningEcrTags()
ImagePipelineProps.Builder	imageScanningEnabled(Boolean imageScanningEnabled)	Sets the value of ImagePipelineProps.getImageScanningEnabled()
ImagePipelineProps.Builder	imageTestsEnabled(Boolean imageTestsEnabled)	Sets the value of ImagePipelineProps.getImageTestsEnabled()
ImagePipelineProps.Builder	infrastructureConfiguration(IInfrastructureConfiguration infrastructureConfiguration)	Sets the value of ImagePipelineProps.getInfrastructureConfiguration()
ImagePipelineProps.Builder	recipe(IRecipeBase recipe)	Sets the value of ImagePipelineProps.getRecipe()
ImagePipelineProps.Builder	schedule(ImagePipelineSchedule schedule)	Sets the value of ImagePipelineProps.getSchedule()
ImagePipelineProps.Builder	status(ImagePipelineStatus status)	Sets the value of ImagePipelineProps.getStatus()
ImagePipelineProps.Builder	tags(Map<String,String> tags)	Sets the value of ImagePipelineProps.getTags()
ImagePipelineProps.Builder	workflows(List<? extends WorkflowConfiguration> workflows)	Sets the value of ImagePipelineProps.getWorkflows()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

recipe

@Stability(Experimental)
public ImagePipelineProps.Builder recipe(IRecipeBase recipe)

Sets the value of ImagePipelineProps.getRecipe()

Parameters:

recipe - The recipe that defines the base image, components, and customizations used to build the image. This parameter is required. This can either be an image recipe, or a container recipe.

Returns:

this

description

@Stability(Experimental)
public ImagePipelineProps.Builder description(String description)

Sets the value of ImagePipelineProps.getDescription()

Parameters:

description - The description of the image pipeline.

Returns:

this

distributionConfiguration

@Stability(Experimental)
public ImagePipelineProps.Builder distributionConfiguration(IDistributionConfiguration distributionConfiguration)

Sets the value of ImagePipelineProps.getDistributionConfiguration()

Parameters:

distributionConfiguration - The distribution configuration used for distributing the image.

Returns:

this

enhancedImageMetadataEnabled

@Stability(Experimental)
public ImagePipelineProps.Builder enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)

Sets the value of ImagePipelineProps.getEnhancedImageMetadataEnabled()

Parameters:

enhancedImageMetadataEnabled - If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.

Returns:

this

executionRole

@Stability(Experimental)
public ImagePipelineProps.Builder executionRole(IRole executionRole)

Sets the value of ImagePipelineProps.getExecutionRole()

Parameters:

executionRole - The execution role used to perform workflow actions to build this image. By default, the Image Builder Service Linked Role (SLR) will be created automatically and used as the execution role. However, when providing a custom set of image workflows for the pipeline, an execution role will be generated with the minimal permissions needed to execute the workflows.

Returns:

this

imageLogGroup

@Stability(Experimental)
public ImagePipelineProps.Builder imageLogGroup(ILogGroup imageLogGroup)

Sets the value of ImagePipelineProps.getImageLogGroup()

Parameters:

imageLogGroup - The log group to use for images created from the image pipeline. By default, a log group will be created with the format /aws/imagebuilder/<image-name>.

Returns:

this

imagePipelineLogGroup

@Stability(Experimental)
public ImagePipelineProps.Builder imagePipelineLogGroup(ILogGroup imagePipelineLogGroup)

Sets the value of ImagePipelineProps.getImagePipelineLogGroup()

Parameters:

imagePipelineLogGroup - The log group to use for the image pipeline. By default, a log group will be created with the format /aws/imagebuilder/pipeline/<pipeline-name>

Returns:

this

imagePipelineName

@Stability(Experimental)
public ImagePipelineProps.Builder imagePipelineName(String imagePipelineName)

Sets the value of ImagePipelineProps.getImagePipelineName()

Parameters:

imagePipelineName - The name of the image pipeline.

Returns:

this

imageScanningEcrRepository

@Stability(Experimental)
public ImagePipelineProps.Builder imageScanningEcrRepository(IRepository imageScanningEcrRepository)

Sets the value of ImagePipelineProps.getImageScanningEcrRepository()

Parameters:

imageScanningEcrRepository - The container repository that Amazon Inspector scans to identify findings for your container images. If a repository is not provided, Image Builder creates a repository named image-builder-image-scanning-repository for vulnerability scanning.

Returns:

this

imageScanningEcrTags

@Stability(Experimental)
public ImagePipelineProps.Builder imageScanningEcrTags(List<String> imageScanningEcrTags)

Sets the value of ImagePipelineProps.getImageScanningEcrTags()

Parameters:

imageScanningEcrTags - The tags for Image Builder to apply to the output container image that Amazon Inspector scans.

Returns:

this

imageScanningEnabled

@Stability(Experimental)
public ImagePipelineProps.Builder imageScanningEnabled(Boolean imageScanningEnabled)

Sets the value of ImagePipelineProps.getImageScanningEnabled()

Parameters:

imageScanningEnabled - Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

Returns:

this

imageTestsEnabled

@Stability(Experimental)
public ImagePipelineProps.Builder imageTestsEnabled(Boolean imageTestsEnabled)

Sets the value of ImagePipelineProps.getImageTestsEnabled()

Parameters:

imageTestsEnabled - Whether to run tests after building an image.

Returns:

this

infrastructureConfiguration

@Stability(Experimental)
public ImagePipelineProps.Builder infrastructureConfiguration(IInfrastructureConfiguration infrastructureConfiguration)

Sets the value of ImagePipelineProps.getInfrastructureConfiguration()

Parameters:

infrastructureConfiguration - The infrastructure configuration used for building the image. A default infrastructure configuration will be used if one is not provided.

The default configuration will create an instance profile and role with minimal permissions needed to build the image, attached to the EC2 instance.

Returns:

this

schedule

@Stability(Experimental)
public ImagePipelineProps.Builder schedule(ImagePipelineSchedule schedule)

Sets the value of ImagePipelineProps.getSchedule()

Parameters:

schedule - The schedule of the image pipeline. This configures how often and when a pipeline automatically creates a new image.

Returns:

this

status

@Stability(Experimental)
public ImagePipelineProps.Builder status(ImagePipelineStatus status)

Sets the value of ImagePipelineProps.getStatus()

Parameters:

status - Indicates whether the pipeline is enabled to be triggered by the provided schedule.

Returns:

this

tags

@Stability(Experimental)
public ImagePipelineProps.Builder tags(Map<String,String> tags)

Sets the value of ImagePipelineProps.getTags()

Parameters:

tags - The tags to apply to the image pipeline.

Returns:

this

workflows

@Stability(Experimental)
public ImagePipelineProps.Builder workflows(List<? extends WorkflowConfiguration> workflows)

Sets the value of ImagePipelineProps.getWorkflows()

Parameters:

workflows - The list of workflow configurations used to build the image.

Returns:

this

build

@Stability(Experimental)
public ImagePipelineProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ImagePipelineProps>

Returns:

a new instance of ImagePipelineProps

Throws:

NullPointerException - if any required attribute was not provided