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.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:27.531Z")
@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)
         .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())
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html

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	getExecutionRole()	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
default String	getImageRecipeArn()	The Amazon Resource Name (ARN) of the image recipe.
default Object	getImageScanningConfiguration()	Contains settings for vulnerability scans.
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.
default Object	getWorkflows()	Contains the build and test workflows that are associated with 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-infrastructureconfigurationarn

getContainerRecipeArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-containerrecipearn

getDistributionConfigurationArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-distributionconfigurationarn

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-enhancedimagemetadataenabled

getExecutionRole

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

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-executionrole

getImageRecipeArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagerecipearn

getImageScanningConfiguration

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

Contains settings for vulnerability scans.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagetestsconfiguration

getTags

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

The tags of the image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-tags

getWorkflows

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

Contains the build and test workflows that are associated with the image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-workflows

builder

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

Returns:

a CfnImageProps.Builder of CfnImageProps