software.amazon.awscdk.services.imagebuilder

Interface CfnImagePipelineProps

All Known Implementing Classes:

CfnImagePipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.962Z")
public interface CfnImagePipelineProps

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 and Description
static class	CfnImagePipelineProps.Builder A builder for CfnImagePipelineProps
static class	CfnImagePipelineProps.Jsii$Proxy An implementation for CfnImagePipelineProps

Method Summary

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

Method Detail

getInfrastructureConfigurationArn

java.lang.String getInfrastructureConfigurationArn()

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

getName

java.lang.String getName()

The name of the image pipeline.

getContainerRecipeArn

default java.lang.String getContainerRecipeArn()

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

getDescription

default java.lang.String getDescription()

The description of this image pipeline.

getDistributionConfigurationArn

default java.lang.String getDistributionConfigurationArn()

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

getEnhancedImageMetadataEnabled

default java.lang.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

default java.lang.String getImageRecipeArn()

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

getImageScanningConfiguration

default java.lang.Object getImageScanningConfiguration()

`AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration`.

getImageTestsConfiguration

default java.lang.Object getImageTestsConfiguration()

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

getSchedule

default java.lang.Object getSchedule()

The schedule of the image pipeline.

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

getStatus

default java.lang.String getStatus()

The status of the image pipeline.

getTags

default java.util.Map<java.lang.String,java.lang.String> getTags()

The tags of this image pipeline.

builder

static CfnImagePipelineProps.Builder builder()

Returns:

a CfnImagePipelineProps.Builder of CfnImagePipelineProps