software.amazon.awscdk.services.imagebuilder

Interface CfnImageProps

All Known Implementing Classes:

CfnImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:33.586Z")
public interface CfnImageProps

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")
         .imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
                 .imageTestsEnabled(false)
                 .timeoutMinutes(123)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnImageProps.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	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration.
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.
default java.lang.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.
java.lang.String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
default java.util.Map<java.lang.String,java.lang.String>	getTags() The tags of the image.

Method Detail

getInfrastructureConfigurationArn

java.lang.String getInfrastructureConfigurationArn()

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

getContainerRecipeArn

default java.lang.String getContainerRecipeArn()

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

getDistributionConfigurationArn

default java.lang.String getDistributionConfigurationArn()

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

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.

getImageTestsConfiguration

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

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

The tags of the image.

builder

static CfnImageProps.Builder builder()

Returns:

a CfnImageProps.Builder of CfnImageProps