Package software.amazon.awscdk.services.imagebuilder

Class CfnImagePipeline.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnImagePipeline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImagePipeline>

Enclosing class:

CfnImagePipeline

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

A fluent builder for CfnImagePipeline.

Method Summary

Modifier and Type	Method	Description
CfnImagePipeline	build()
CfnImagePipeline.Builder	containerRecipeArn(String containerRecipeArn)	The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
static CfnImagePipeline.Builder	create(software.constructs.Construct scope, String id)
CfnImagePipeline.Builder	description(String description)	The description of this image pipeline.
CfnImagePipeline.Builder	distributionConfigurationArn(String distributionConfigurationArn)	The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
CfnImagePipeline.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImagePipeline.Builder	enhancedImageMetadataEnabled(IResolvable enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImagePipeline.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.
CfnImagePipeline.Builder	imageRecipeArn(String imageRecipeArn)	The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
CfnImagePipeline.Builder	imageScanningConfiguration(IResolvable imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImagePipeline.Builder	imageScanningConfiguration(CfnImagePipeline.ImageScanningConfigurationProperty imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImagePipeline.Builder	imageTestsConfiguration(IResolvable imageTestsConfiguration)	The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
CfnImagePipeline.Builder	imageTestsConfiguration(CfnImagePipeline.ImageTestsConfigurationProperty imageTestsConfiguration)	The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
CfnImagePipeline.Builder	infrastructureConfigurationArn(String infrastructureConfigurationArn)	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
CfnImagePipeline.Builder	name(String name)	The name of the image pipeline.
CfnImagePipeline.Builder	schedule(IResolvable schedule)	The schedule of the image pipeline.
CfnImagePipeline.Builder	schedule(CfnImagePipeline.ScheduleProperty schedule)	The schedule of the image pipeline.
CfnImagePipeline.Builder	status(String status)	The status of the image pipeline.
CfnImagePipeline.Builder	tags(Map<String,String> tags)	The tags of this image pipeline.
CfnImagePipeline.Builder	workflows(List<? extends Object> workflows)	Contains the workflows that run for the image pipeline.
CfnImagePipeline.Builder	workflows(IResolvable workflows)	Contains the workflows that run for the image pipeline.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnImagePipeline.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnImagePipeline.Builder.

infrastructureConfigurationArn

@Stability(Stable)
public CfnImagePipeline.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-infrastructureconfigurationarn

name

@Stability(Stable)
public CfnImagePipeline.Builder name(String name)

The name of the image pipeline.

Parameters:

name - The name of the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-name

containerRecipeArn

@Stability(Stable)
public CfnImagePipeline.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-containerrecipearn

description

@Stability(Stable)
public CfnImagePipeline.Builder description(String description)

The description of this image pipeline.

Parameters:

description - The description of this image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-description

distributionConfigurationArn

@Stability(Stable)
public CfnImagePipeline.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-distributionconfigurationarn

enhancedImageMetadataEnabled

@Stability(Stable)
public CfnImagePipeline.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 parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-enhancedimagemetadataenabled

enhancedImageMetadataEnabled

@Stability(Stable)
public CfnImagePipeline.Builder enhancedImageMetadataEnabled(IResolvable 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 parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-enhancedimagemetadataenabled

executionRole

@Stability(Stable)
public CfnImagePipeline.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-executionrole

imageRecipeArn

@Stability(Stable)
public CfnImagePipeline.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagerecipearn

imageScanningConfiguration

@Stability(Stable)
public CfnImagePipeline.Builder imageScanningConfiguration(IResolvable imageScanningConfiguration)

Contains settings for vulnerability scans.

Parameters:

imageScanningConfiguration - Contains settings for vulnerability scans. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration

imageScanningConfiguration

@Stability(Stable)
public CfnImagePipeline.Builder imageScanningConfiguration(CfnImagePipeline.ImageScanningConfigurationProperty imageScanningConfiguration)

Contains settings for vulnerability scans.

Parameters:

imageScanningConfiguration - Contains settings for vulnerability scans. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration

imageTestsConfiguration

@Stability(Stable)
public CfnImagePipeline.Builder imageTestsConfiguration(IResolvable imageTestsConfiguration)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

Parameters:

imageTestsConfiguration - The configuration of the image tests that run after image creation to ensure the quality of the image that was created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration

imageTestsConfiguration

@Stability(Stable)
public CfnImagePipeline.Builder imageTestsConfiguration(CfnImagePipeline.ImageTestsConfigurationProperty imageTestsConfiguration)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

Parameters:

imageTestsConfiguration - The configuration of the image tests that run after image creation to ensure the quality of the image that was created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration

schedule

@Stability(Stable)
public CfnImagePipeline.Builder schedule(IResolvable schedule)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

Parameters:

schedule - The schedule of the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-schedule

schedule

@Stability(Stable)
public CfnImagePipeline.Builder schedule(CfnImagePipeline.ScheduleProperty schedule)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

Parameters:

schedule - The schedule of the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-schedule

status

@Stability(Stable)
public CfnImagePipeline.Builder status(String status)

The status of the image pipeline.

Parameters:

status - The status of the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-status

tags

@Stability(Stable)
public CfnImagePipeline.Builder tags(Map<String,String> tags)

The tags of this image pipeline.

Parameters:

tags - The tags of this image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-tags

workflows

@Stability(Stable)
public CfnImagePipeline.Builder workflows(IResolvable workflows)

Contains the workflows that run for the image pipeline.

Parameters:

workflows - Contains the workflows that run for the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-workflows

workflows

@Stability(Stable)
public CfnImagePipeline.Builder workflows(List<? extends Object> workflows)

Contains the workflows that run for the image pipeline.

Parameters:

workflows - Contains the workflows that run for the image pipeline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-workflows

build

@Stability(Stable)
public CfnImagePipeline build()

Specified by:

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

Returns:

a newly built instance of CfnImagePipeline.