Package software.amazon.awscdk.cfnpropertymixins.services.imagebuilder

Class CfnImagePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.imagebuilder.CfnImagePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImagePropsMixin>

Enclosing class:

CfnImagePropsMixin

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

A fluent builder for CfnImagePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnImagePropsMixin	build()
CfnImagePropsMixin.Builder	containerRecipeArn(String containerRecipeArn)	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
static CfnImagePropsMixin.Builder	create()
static CfnImagePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnImagePropsMixin.Builder	deletionSettings(CfnImagePropsMixin.DeletionSettingsProperty deletionSettings)	Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.
CfnImagePropsMixin.Builder	deletionSettings(IResolvable deletionSettings)	Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.
CfnImagePropsMixin.Builder	distributionConfigurationArn(String distributionConfigurationArn)	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CfnImagePropsMixin.Builder	distributionConfigurationArn(IDistributionConfigurationRef distributionConfigurationArn)	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CfnImagePropsMixin.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImagePropsMixin.Builder	enhancedImageMetadataEnabled(IResolvable enhancedImageMetadataEnabled)	Collects additional information about the image being created, including the operating system (OS) version and package list.
CfnImagePropsMixin.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.
CfnImagePropsMixin.Builder	imagePipelineExecutionSettings(CfnImagePropsMixin.ImagePipelineExecutionSettingsProperty imagePipelineExecutionSettings)	The image pipeline execution settings of the image.
CfnImagePropsMixin.Builder	imagePipelineExecutionSettings(IResolvable imagePipelineExecutionSettings)	The image pipeline execution settings of the image.
CfnImagePropsMixin.Builder	imageRecipeArn(String imageRecipeArn)	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
CfnImagePropsMixin.Builder	imageRecipeArn(IImageRecipeRef imageRecipeArn)	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
CfnImagePropsMixin.Builder	imageScanningConfiguration(CfnImagePropsMixin.ImageScanningConfigurationProperty imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImagePropsMixin.Builder	imageScanningConfiguration(IResolvable imageScanningConfiguration)	Contains settings for vulnerability scans.
CfnImagePropsMixin.Builder	imageTestsConfiguration(CfnImagePropsMixin.ImageTestsConfigurationProperty imageTestsConfiguration)	The image tests configuration of the image.
CfnImagePropsMixin.Builder	imageTestsConfiguration(IResolvable imageTestsConfiguration)	The image tests configuration of the image.
CfnImagePropsMixin.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.
CfnImagePropsMixin.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.
CfnImagePropsMixin.Builder	loggingConfiguration(CfnImagePropsMixin.ImageLoggingConfigurationProperty loggingConfiguration)	The logging configuration that's defined for the image.
CfnImagePropsMixin.Builder	loggingConfiguration(IResolvable loggingConfiguration)	The logging configuration that's defined for the image.
CfnImagePropsMixin.Builder	tags(Map<String,String> tags)	The tags of the image.
CfnImagePropsMixin.Builder	workflows(List<? extends Object> workflows)	Contains an array of workflow configuration objects.
CfnImagePropsMixin.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 CfnImagePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnImagePropsMixin.Builder.

create

@Stability(Stable)
public static CfnImagePropsMixin.Builder create()

Returns:

a new instance of CfnImagePropsMixin.Builder.

containerRecipeArn

@Stability(Stable)
public CfnImagePropsMixin.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 CfnImagePropsMixin.Builder deletionSettings(IResolvable deletionSettings)

Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

Parameters:

deletionSettings - Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers. 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 CfnImagePropsMixin.Builder deletionSettings(CfnImagePropsMixin.DeletionSettingsProperty deletionSettings)

Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

Parameters:

deletionSettings - Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers. 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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.Builder imagePipelineExecutionSettings(IResolvable imagePipelineExecutionSettings)

The image pipeline execution settings of the image.

Parameters:

imagePipelineExecutionSettings - The image pipeline execution settings 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-imagepipelineexecutionsettings

imagePipelineExecutionSettings

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

The image pipeline execution settings of the image.

Parameters:

imagePipelineExecutionSettings - The image pipeline execution settings 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-imagepipelineexecutionsettings

imageRecipeArn

@Stability(Stable)
public CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.Builder imageScanningConfiguration(CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.Builder imageTestsConfiguration(CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.Builder loggingConfiguration(CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin.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 CfnImagePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnImagePropsMixin.