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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.435Z")
@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()
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         // the properties below are optional
         .containerRecipeArn("containerRecipeArn")
         .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())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

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 is used for this pipeline.
default String	getDistributionConfigurationArn()	The Amazon Resource Name (ARN) of the distribution configuration.
default Object	getEnhancedImageMetadataEnabled()	Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
default String	getImageRecipeArn()	The Amazon Resource Name (ARN) of the image recipe.
default Object	getImageScanningConfiguration()	AWS::ImageBuilder::Image.ImageScanningConfiguration.
default Object	getImageTestsConfiguration()	The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
String	getInfrastructureConfigurationArn()	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
default Map<String,String>	getTags()	The tags of the image.

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.

getContainerRecipeArn

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

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

getDistributionConfigurationArn

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

The Amazon Resource Name (ARN) of the distribution configuration.

getEnhancedImageMetadataEnabled

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

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

getImageRecipeArn

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

The Amazon Resource Name (ARN) of the image recipe.

getImageScanningConfiguration

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

AWS::ImageBuilder::Image.ImageScanningConfiguration.

getImageTestsConfiguration

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

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

getTags

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

The tags of the image.

builder

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

Returns:

a CfnImageProps.Builder of CfnImageProps