Package software.amazon.awscdk.services.imagebuilder

Interface CfnImageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-03T13:58:24.487Z")
@Stability(Stable)
public interface CfnImageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnImage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 CfnImageProps cfnImageProps = CfnImageProps.builder()
         .containerRecipeArn("containerRecipeArn")
         .deletionSettings(DeletionSettingsProperty.builder()
                 .executionRole("executionRole")
                 .build())
         .distributionConfigurationArn("distributionConfigurationArn")
         .enhancedImageMetadataEnabled(false)
         .executionRole("executionRole")
         .imagePipelineExecutionSettings(ImagePipelineExecutionSettingsProperty.builder()
                 .deploymentId("deploymentId")
                 .onUpdate(false)
                 .build())
         .imageRecipeArn("imageRecipeArn")
         .imageScanningConfiguration(ImageScanningConfigurationProperty.builder()
                 .ecrConfiguration(EcrConfigurationProperty.builder()
                         .containerTags(List.of("containerTags"))
                         .repositoryName("repositoryName")
                         .build())
                 .imageScanningEnabled(false)
                 .build())
         .imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
                 .imageTestsEnabled(false)
                 .timeoutMinutes(123)
                 .build())
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         .loggingConfiguration(ImageLoggingConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workflows(List.of(WorkflowConfigurationProperty.builder()
                 .onFailure("onFailure")
                 .parallelGroup("parallelGroup")
                 .parameters(List.of(WorkflowParameterProperty.builder()
                         .name("name")
                         .value(List.of("value"))
                         .build()))
                 .workflowArn("workflowArn")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnImageProps.Builder	A builder for CfnImageProps
static final class	CfnImageProps.Jsii$Proxy	An implementation for CfnImageProps

Method Summary

Modifier and Type	Method	Description
static CfnImageProps.Builder	builder()
default String	getContainerRecipeArn()	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
default Object	getDeletionSettings()	Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.
default Object	getDistributionConfigurationArn()	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
default Object	getEnhancedImageMetadataEnabled()	Collects additional information about the image being created, including the operating system (OS) version and package list.
default String	getExecutionRole()	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
default Object	getImagePipelineExecutionSettings()	The image pipeline execution settings of the image.
default Object	getImageRecipeArn()	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
default Object	getImageScanningConfiguration()	Contains settings for vulnerability scans.
default Object	getImageTestsConfiguration()	The image tests configuration of the image.
default Object	getInfrastructureConfigurationArn()	The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
default Object	getLoggingConfiguration()	The logging configuration that's defined for the image.
default Map<String,String>	getTags()	The tags of the image.
default Object	getWorkflows()	Contains an array of workflow configuration objects.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerRecipeArn

@Stability(Stable)
@Nullable
default String getContainerRecipeArn()

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

See Also:

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

getDeletionSettings

@Stability(Stable)
@Nullable
default Object getDeletionSettings()

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

Returns union: either IResolvable or CfnImage.DeletionSettingsProperty

See Also:

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

getDistributionConfigurationArn

@Stability(Stable)
@Nullable
default Object getDistributionConfigurationArn()

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

Returns union: either String or IDistributionConfigurationRef

See Also:

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

getEnhancedImageMetadataEnabled

@Stability(Stable)
@Nullable
default Object getEnhancedImageMetadataEnabled()

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 union: either Boolean or IResolvable

See Also:

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

getExecutionRole

@Stability(Stable)
@Nullable
default String getExecutionRole()

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

See Also:

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

getImagePipelineExecutionSettings

@Stability(Stable)
@Nullable
default Object getImagePipelineExecutionSettings()

The image pipeline execution settings of the image.

Returns union: either IResolvable or CfnImage.ImagePipelineExecutionSettingsProperty

See Also:

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

getImageRecipeArn

@Stability(Stable)
@Nullable
default Object getImageRecipeArn()

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

Returns union: either String or IImageRecipeRef

See Also:

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

getImageScanningConfiguration

@Stability(Stable)
@Nullable
default Object getImageScanningConfiguration()

Contains settings for vulnerability scans.

Returns union: either IResolvable or CfnImage.ImageScanningConfigurationProperty

See Also:

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

getImageTestsConfiguration

@Stability(Stable)
@Nullable
default Object getImageTestsConfiguration()

The image tests configuration of the image.

Returns union: either IResolvable or CfnImage.ImageTestsConfigurationProperty

See Also:

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

getInfrastructureConfigurationArn

@Stability(Stable)
@Nullable
default Object getInfrastructureConfigurationArn()

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

Returns union: either String or IInfrastructureConfigurationRef

See Also:

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

getLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getLoggingConfiguration()

The logging configuration that's defined for the image.

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

Returns union: either IResolvable or CfnImage.ImageLoggingConfigurationProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The tags of the image.

See Also:

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

getWorkflows

@Stability(Stable)
@Nullable
default Object getWorkflows()

Contains an array of workflow configuration objects.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnImage.WorkflowConfigurationProperty>

See Also:

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

builder

@Stability(Stable)
static CfnImageProps.Builder builder()

Returns:

a CfnImageProps.Builder of CfnImageProps