Package software.amazon.awscdk.services.imagebuilder

Interface CfnImageRecipeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageRecipeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:39.948Z")
@Stability(Stable)
public interface CfnImageRecipeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnImageRecipe.

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.*;
 CfnImageRecipeProps cfnImageRecipeProps = CfnImageRecipeProps.builder()
         .components(List.of(ComponentConfigurationProperty.builder()
                 .componentArn("componentArn")
                 .parameters(List.of(ComponentParameterProperty.builder()
                         .name("name")
                         .value(List.of("value"))
                         .build()))
                 .build()))
         .name("name")
         .parentImage("parentImage")
         .version("version")
         // the properties below are optional
         .additionalInstanceConfiguration(AdditionalInstanceConfigurationProperty.builder()
                 .systemsManagerAgent(SystemsManagerAgentProperty.builder()
                         .uninstallAfterBuild(false)
                         .build())
                 .userDataOverride("userDataOverride")
                 .build())
         .amiTags(Map.of(
                 "amiTagsKey", "amiTags"))
         .blockDeviceMappings(List.of(InstanceBlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 .ebs(EbsInstanceBlockDeviceSpecificationProperty.builder()
                         .deleteOnTermination(false)
                         .encrypted(false)
                         .iops(123)
                         .kmsKeyId("kmsKeyId")
                         .snapshotId("snapshotId")
                         .throughput(123)
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice("noDevice")
                 .virtualName("virtualName")
                 .build()))
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workingDirectory("workingDirectory")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnImageRecipeProps.Builder	builder()
default Object	getAdditionalInstanceConfiguration()	Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
default Object	getAmiTags()	Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
default Object	getBlockDeviceMappings()	The block device mappings to apply when creating images from this recipe.
Object	getComponents()	The components that are included in the image recipe.
default String	getDescription()	The description of the image recipe.
String	getName()	The name of the image recipe.
String	getParentImage()	The base image for customizations specified in the image recipe.
default Map<String,String>	getTags()	The tags of the image recipe.
String	getVersion()	The version of the image recipe.
default String	getWorkingDirectory()	The working directory to be used during build and test workflows.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponents

@Stability(Stable)
@NotNull
Object getComponents()

The components that are included in the image recipe.

Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnImageRecipe.ComponentConfigurationProperty>

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the image recipe.

See Also:

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

getParentImage

@Stability(Stable)
@NotNull
String getParentImage()

The base image for customizations specified in the image recipe.

You can specify the parent image using one of the following options:

• AMI ID
• Image Builder image Amazon Resource Name (ARN)
• AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN.
• AWS Marketplace product ID

See Also:

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

getVersion

@Stability(Stable)
@NotNull
String getVersion()

The version of the image recipe.

See Also:

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

getAdditionalInstanceConfiguration

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

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

Returns union: either IResolvable or CfnImageRecipe.AdditionalInstanceConfigurationProperty

See Also:

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

getAmiTags

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

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getBlockDeviceMappings

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

The block device mappings to apply when creating images from this recipe.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnImageRecipe.InstanceBlockDeviceMappingProperty>

See Also:

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

getDescription

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

The description of the image recipe.

See Also:

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

getTags

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

The tags of the image recipe.

See Also:

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

getWorkingDirectory

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

The working directory to be used during build and test workflows.

See Also:

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

builder

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

Returns:

a CfnImageRecipeProps.Builder of CfnImageRecipeProps