Package software.amazon.awscdk.services.imagebuilder

Class CfnImagePipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.imagebuilder.CfnImagePipeline
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IImagePipelineRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.010Z") @Stability(Stable) public class CfnImagePipeline extends CfnResource implements IInspectable, IImagePipelineRef, ITaggable
An image pipeline is the automation configuration for building secure OS images on AWS .

The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance types, a subnet for your VPC, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

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.*;
 CfnImagePipeline cfnImagePipeline = CfnImagePipeline.Builder.create(this, "MyCfnImagePipeline")
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         .name("name")
         // the properties below are optional
         .containerRecipeArn("containerRecipeArn")
         .description("description")
         .distributionConfigurationArn("distributionConfigurationArn")
         .enhancedImageMetadataEnabled(false)
         .executionRole("executionRole")
         .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())
         .loggingConfiguration(PipelineLoggingConfigurationProperty.builder()
                 .imageLogGroupName("imageLogGroupName")
                 .pipelineLogGroupName("pipelineLogGroupName")
                 .build())
         .schedule(ScheduleProperty.builder()
                 .autoDisablePolicy(AutoDisablePolicyProperty.builder()
                         .failureCount(123)
                         .build())
                 .pipelineExecutionStartCondition("pipelineExecutionStartCondition")
                 .scheduleExpression("scheduleExpression")
                 .build())
         .status("status")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnImagePipeline

      protected CfnImagePipeline(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnImagePipeline

      protected CfnImagePipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnImagePipeline

      @Stability(Stable) public CfnImagePipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnImagePipelineProps props)
      Create a new AWS::ImageBuilder::ImagePipeline.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForImagePipeline

      @Stability(Stable) @NotNull public static String arnForImagePipeline(@NotNull IImagePipelineRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnImagePipeline

      @Stability(Stable) @NotNull public static Boolean isCfnImagePipeline(@NotNull Object x)
      Checks whether the given object is a CfnImagePipeline.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) of the image pipeline.

      For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline .

    • getAttrDeploymentId

      @Stability(Stable) @NotNull public String getAttrDeploymentId()
      The deployment ID of the pipeline, used for resource create/update triggers.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      Returns the name of the image pipeline.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getImagePipelineRef

      @Stability(Stable) @NotNull public ImagePipelineReference getImagePipelineRef()
      A reference to a ImagePipeline resource.
      Specified by:
      getImagePipelineRef in interface IImagePipelineRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getInfrastructureConfigurationArn

      @Stability(Stable) @NotNull public String getInfrastructureConfigurationArn()
      The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

    • setInfrastructureConfigurationArn

      @Stability(Stable) public void setInfrastructureConfigurationArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the image pipeline.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the image pipeline.

    • getContainerRecipeArn

      @Stability(Stable) @Nullable public String getContainerRecipeArn()
      The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

    • setContainerRecipeArn

      @Stability(Stable) public void setContainerRecipeArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of this image pipeline.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of this image pipeline.

    • getDistributionConfigurationArn

      @Stability(Stable) @Nullable public String getDistributionConfigurationArn()
      The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

    • setDistributionConfigurationArn

      @Stability(Stable) public void setDistributionConfigurationArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

    • getEnhancedImageMetadataEnabled

      @Stability(Stable) @Nullable public Object getEnhancedImageMetadataEnabled()
      Collects additional information about the image being created, including the operating system (OS) version and package list.

      Returns union: either Boolean or IResolvable

    • setEnhancedImageMetadataEnabled

      @Stability(Stable) public void setEnhancedImageMetadataEnabled(@Nullable Boolean value)
      Collects additional information about the image being created, including the operating system (OS) version and package list.

    • setEnhancedImageMetadataEnabled

      @Stability(Stable) public void setEnhancedImageMetadataEnabled(@Nullable IResolvable value)
      Collects additional information about the image being created, including the operating system (OS) version and package list.

    • getExecutionRole

      @Stability(Stable) @Nullable public String getExecutionRole()
      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

    • setExecutionRole

      @Stability(Stable) public void setExecutionRole(@Nullable String value)
      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

    • getImageRecipeArn

      @Stability(Stable) @Nullable public String getImageRecipeArn()
      The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

    • setImageRecipeArn

      @Stability(Stable) public void setImageRecipeArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

    • getImageScanningConfiguration

      @Stability(Stable) @Nullable public Object getImageScanningConfiguration()
      Contains settings for vulnerability scans.

      Returns union: either IResolvable or CfnImagePipeline.ImageScanningConfigurationProperty

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable IResolvable value)
      Contains settings for vulnerability scans.

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable CfnImagePipeline.ImageScanningConfigurationProperty value)
      Contains settings for vulnerability scans.

    • getImageTestsConfiguration

      @Stability(Stable) @Nullable public Object getImageTestsConfiguration()
      The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

      Returns union: either IResolvable or CfnImagePipeline.ImageTestsConfigurationProperty

    • setImageTestsConfiguration

      @Stability(Stable) public void setImageTestsConfiguration(@Nullable IResolvable value)
      The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

    • setImageTestsConfiguration

      @Stability(Stable) public void setImageTestsConfiguration(@Nullable CfnImagePipeline.ImageTestsConfigurationProperty value)
      The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

    • getLoggingConfiguration

      @Stability(Stable) @Nullable public Object getLoggingConfiguration()
      Defines logging configuration for the output image.

      Returns union: either IResolvable or CfnImagePipeline.PipelineLoggingConfigurationProperty

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable IResolvable value)
      Defines logging configuration for the output image.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable CfnImagePipeline.PipelineLoggingConfigurationProperty value)
      Defines logging configuration for the output image.

    • getSchedule

      @Stability(Stable) @Nullable public Object getSchedule()
      The schedule of the image pipeline.

      Returns union: either IResolvable or CfnImagePipeline.ScheduleProperty

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable IResolvable value)
      The schedule of the image pipeline.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable CfnImagePipeline.ScheduleProperty value)
      The schedule of the image pipeline.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of the image pipeline.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of the image pipeline.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The tags of this image pipeline.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The tags of this image pipeline.

    • getWorkflows

      @Stability(Stable) @Nullable public Object getWorkflows()
      Contains the workflows that run for the image pipeline.

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

    • setWorkflows

      @Stability(Stable) public void setWorkflows(@Nullable IResolvable value)
      Contains the workflows that run for the image pipeline.

    • setWorkflows

      @Stability(Stable) public void setWorkflows(@Nullable List<Object> value)
      Contains the workflows that run for the image pipeline.