interface CfnImageRecipeProps

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnImageRecipeProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImageRecipeProps
Java	software.amazon.awscdk.services.imagebuilder.CfnImageRecipeProps
Python	aws_cdk.aws_imagebuilder.CfnImageRecipeProps
TypeScript	aws-cdk-lib » aws_imagebuilder » CfnImageRecipeProps

Properties for defining a CfnImageRecipe.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const cfnImageRecipeProps: imagebuilder.CfnImageRecipeProps = {
  components: [{
    componentArn: 'componentArn',
    parameters: [{
      name: 'name',
      value: ['value'],
    }],
  }],
  name: 'name',
  parentImage: 'parentImage',
  version: 'version',

  // the properties below are optional
  additionalInstanceConfiguration: {
    systemsManagerAgent: {
      uninstallAfterBuild: false,
    },
    userDataOverride: 'userDataOverride',
  },
  amiTags: {
    amiTagsKey: 'amiTags',
  },
  blockDeviceMappings: [{
    deviceName: 'deviceName',
    ebs: {
      deleteOnTermination: false,
      encrypted: false,
      iops: 123,
      kmsKeyId: 'kmsKeyId',
      snapshotId: 'snapshotId',
      throughput: 123,
      volumeSize: 123,
      volumeType: 'volumeType',
    },
    noDevice: 'noDevice',
    virtualName: 'virtualName',
  }],
  description: 'description',
  tags: {
    tagsKey: 'tags',
  },
  workingDirectory: 'workingDirectory',
};

Properties

Name	Type	Description
components	IResolvable | (IResolvable | ComponentConfigurationProperty)[]	The components that are included in the image recipe.
name	string	The name of the image recipe.
parentImage	string	The base image for customizations specified in the image recipe.
version	string	The version of the image recipe.
additionalInstanceConfiguration?	IResolvable | AdditionalInstanceConfigurationProperty	Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
amiTags?	{ [string]: string } | IResolvable	Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
blockDeviceMappings?	IResolvable | (IResolvable | InstanceBlockDeviceMappingProperty)[]	The block device mappings to apply when creating images from this recipe.
description?	string	The description of the image recipe.
tags?	{ [string]: string }	The tags of the image recipe.
workingDirectory?	string	The working directory to be used during build and test workflows.

---

components

Type: IResolvable | (IResolvable | ComponentConfigurationProperty)[]

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.

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

---

name

Type: string

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

---

parentImage

Type: string

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

---

version

Type: string

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

---

additionalInstanceConfiguration?

Type: IResolvable | AdditionalInstanceConfigurationProperty (optional)

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.

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

---

amiTags?

Type: { [string]: string } | IResolvable (optional)

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

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

---

blockDeviceMappings?

Type: IResolvable | (IResolvable | InstanceBlockDeviceMappingProperty)[] (optional)

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

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

---

description?

Type: string (optional)

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

---

tags?

Type: { [string]: string } (optional)

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

---

workingDirectory?

Type: string (optional)

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