Package software.amazon.awscdk.services.imagebuilder

Interface CfnImagePipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImagePipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.434Z")
@Stability(Stable)
public interface CfnImagePipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnImagePipeline.

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.*;
 CfnImagePipelineProps cfnImagePipelineProps = CfnImagePipelineProps.builder()
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         .name("name")
         // the properties below are optional
         .containerRecipeArn("containerRecipeArn")
         .description("description")
         .distributionConfigurationArn("distributionConfigurationArn")
         .enhancedImageMetadataEnabled(false)
         .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())
         .schedule(ScheduleProperty.builder()
                 .pipelineExecutionStartCondition("pipelineExecutionStartCondition")
                 .scheduleExpression("scheduleExpression")
                 .build())
         .status("status")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnImagePipelineProps.Builder	builder()
default String	getContainerRecipeArn()	The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
default String	getDescription()	The description of this image pipeline.
default String	getDistributionConfigurationArn()	The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
default Object	getEnhancedImageMetadataEnabled()	Collects additional information about the image being created, including the operating system (OS) version and package list.
default String	getImageRecipeArn()	The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
default Object	getImageScanningConfiguration()	AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.
default Object	getImageTestsConfiguration()	The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
String	getInfrastructureConfigurationArn()	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
String	getName()	The name of the image pipeline.
default Object	getSchedule()	The schedule of the image pipeline.
default String	getStatus()	The status of the image pipeline.
default Map<String,String>	getTags()	The tags of this image pipeline.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInfrastructureConfigurationArn

@Stability(Stable)
@NotNull
String getInfrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

getName

@Stability(Stable)
@NotNull
String getName()

The name of the image pipeline.

getContainerRecipeArn

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

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

getDescription

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

The description of this image pipeline.

getDistributionConfigurationArn

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

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

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.

getImageRecipeArn

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

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

getImageScanningConfiguration

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

AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.

getImageTestsConfiguration

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

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

getSchedule

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

The schedule of the image pipeline.

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

getStatus

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

The status of the image pipeline.

getTags

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

The tags of this image pipeline.

builder

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

Returns:

a CfnImagePipelineProps.Builder of CfnImagePipelineProps