Package software.amazon.awscdk.services.imagebuilder

Class CfnImage.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnImage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImage>

Enclosing class:

CfnImage

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

A fluent builder for CfnImage.

Method Summary

Modifier and Type	Method	Description
CfnImage	build()
CfnImage.Builder	containerRecipeArn(String containerRecipeArn)	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
static CfnImage.Builder	create(software.constructs.Construct scope, String id)
CfnImage.Builder	deletionSettings(IResolvable deletionSettings)	The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
CfnImage.Builder	deletionSettings(CfnImage.DeletionSettingsProperty deletionSettings)	The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.
CfnImage.Builder	distributionConfigurationArn(String distributionConfigurationArn)	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CfnImage.Builder	distributionConfigurationArn(IDistributionConfigurationRef distributionConfigurationArn)	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CfnImage.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImage.Builder	enhancedImageMetadataEnabled(IResolvable enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImage.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.
CfnImage.Builder	imagePipelineExecutionSettings(IResolvable imagePipelineExecutionSettings)	The settings for starting an image pipeline execution.
CfnImage.Builder	imagePipelineExecutionSettings(CfnImage.ImagePipelineExecutionSettingsProperty imagePipelineExecutionSettings)	The settings for starting an image pipeline execution.
CfnImage.Builder	imageRecipeArn(String imageRecipeArn)	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
CfnImage.Builder	imageRecipeArn(IImageRecipeRef imageRecipeArn)	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
CfnImage.Builder	imageScanningConfiguration(IResolvable imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImage.Builder	imageScanningConfiguration(CfnImage.ImageScanningConfigurationProperty imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImage.Builder	imageTestsConfiguration(IResolvable imageTestsConfiguration)	The image tests configuration of the image.
CfnImage.Builder	imageTestsConfiguration(CfnImage.ImageTestsConfigurationProperty imageTestsConfiguration)	The image tests configuration of the image.
CfnImage.Builder	infrastructureConfigurationArn(String infrastructureConfigurationArn)	The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
CfnImage.Builder	infrastructureConfigurationArn(IInfrastructureConfigurationRef infrastructureConfigurationArn)	The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
CfnImage.Builder	loggingConfiguration(IResolvable loggingConfiguration)	The logging configuration that's defined for the image.
CfnImage.Builder	loggingConfiguration(CfnImage.ImageLoggingConfigurationProperty loggingConfiguration)	The logging configuration that's defined for the image.
CfnImage.Builder	tags(Map<String,String> tags)	The tags of the image.
CfnImage.Builder	workflows(List<? extends Object> workflows)	Contains an array of workflow configuration objects.
CfnImage.Builder	workflows(IResolvable workflows)	Contains an array of workflow configuration objects.

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

containerRecipeArn

@Stability(Stable)
public CfnImage.Builder containerRecipeArn(String containerRecipeArn)

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. This parameter is required.

Returns:

this

See Also:

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

deletionSettings

@Stability(Stable)
public CfnImage.Builder deletionSettings(IResolvable deletionSettings)

The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.

Parameters:

deletionSettings - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image. This parameter is required.

Returns:

this

See Also:

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

deletionSettings

@Stability(Stable)
public CfnImage.Builder deletionSettings(CfnImage.DeletionSettingsProperty deletionSettings)

The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.

Parameters:

deletionSettings - The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image. This parameter is required.

Returns:

this

See Also:

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

distributionConfigurationArn

@Stability(Stable)
public CfnImage.Builder distributionConfigurationArn(String distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline. This parameter is required.

Returns:

this

See Also:

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

distributionConfigurationArn

@Stability(Stable)
public CfnImage.Builder distributionConfigurationArn(IDistributionConfigurationRef distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline. This parameter is required.

Returns:

this

See Also:

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

enhancedImageMetadataEnabled

@Stability(Stable)
public CfnImage.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-image.html#cfn-imagebuilder-image-enhancedimagemetadataenabled

enhancedImageMetadataEnabled

@Stability(Stable)
public CfnImage.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-image.html#cfn-imagebuilder-image-enhancedimagemetadataenabled

executionRole

@Stability(Stable)
public CfnImage.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-image.html#cfn-imagebuilder-image-executionrole

imagePipelineExecutionSettings

@Stability(Stable)
public CfnImage.Builder imagePipelineExecutionSettings(IResolvable imagePipelineExecutionSettings)

The settings for starting an image pipeline execution.

Parameters:

imagePipelineExecutionSettings - The settings for starting an image pipeline execution. This parameter is required.

Returns:

this

See Also:

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

imagePipelineExecutionSettings

@Stability(Stable)
public CfnImage.Builder imagePipelineExecutionSettings(CfnImage.ImagePipelineExecutionSettingsProperty imagePipelineExecutionSettings)

The settings for starting an image pipeline execution.

Parameters:

imagePipelineExecutionSettings - The settings for starting an image pipeline execution. This parameter is required.

Returns:

this

See Also:

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

imageRecipeArn

@Stability(Stable)
public CfnImage.Builder imageRecipeArn(String imageRecipeArn)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Parameters:

imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. This parameter is required.

Returns:

this

See Also:

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

imageRecipeArn

@Stability(Stable)
public CfnImage.Builder imageRecipeArn(IImageRecipeRef imageRecipeArn)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Parameters:

imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. This parameter is required.

Returns:

this

See Also:

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

imageScanningConfiguration

@Stability(Stable)
public CfnImage.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-image.html#cfn-imagebuilder-image-imagescanningconfiguration

imageScanningConfiguration

@Stability(Stable)
public CfnImage.Builder imageScanningConfiguration(CfnImage.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-image.html#cfn-imagebuilder-image-imagescanningconfiguration

imageTestsConfiguration

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

The image tests configuration of the image.

Parameters:

imageTestsConfiguration - The image tests configuration of the image. This parameter is required.

Returns:

this

See Also:

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

imageTestsConfiguration

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

The image tests configuration of the image.

Parameters:

imageTestsConfiguration - The image tests configuration of the image. This parameter is required.

Returns:

this

See Also:

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

infrastructureConfigurationArn

@Stability(Stable)
public CfnImage.Builder infrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested. This parameter is required.

Returns:

this

See Also:

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

infrastructureConfigurationArn

@Stability(Stable)
public CfnImage.Builder infrastructureConfigurationArn(IInfrastructureConfigurationRef infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested. This parameter is required.

Returns:

this

See Also:

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

loggingConfiguration

@Stability(Stable)
public CfnImage.Builder loggingConfiguration(IResolvable loggingConfiguration)

The logging configuration that's defined for the image.

Image Builder uses the defined settings to direct execution log output during image creation.

Parameters:

loggingConfiguration - The logging configuration that's defined for the image. This parameter is required.

Returns:

this

See Also:

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

loggingConfiguration

@Stability(Stable)
public CfnImage.Builder loggingConfiguration(CfnImage.ImageLoggingConfigurationProperty loggingConfiguration)

The logging configuration that's defined for the image.

Image Builder uses the defined settings to direct execution log output during image creation.

Parameters:

loggingConfiguration - The logging configuration that's defined for the image. This parameter is required.

Returns:

this

See Also:

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

tags

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

The tags of the image.

Parameters:

tags - The tags of the image. This parameter is required.

Returns:

this

See Also:

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

workflows

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

Contains an array of workflow configuration objects.

Parameters:

workflows - Contains an array of workflow configuration objects. This parameter is required.

Returns:

this

See Also:

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

workflows

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

Contains an array of workflow configuration objects.

Parameters:

workflows - Contains an array of workflow configuration objects. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnImage build()

Specified by:

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

Returns:

a newly built instance of CfnImage.