interface CfnImageRecipeProps

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnImageRecipeProps
Java	software.amazon.awscdk.services.imagebuilder.CfnImageRecipeProps
Python	aws_cdk.aws_imagebuilder.CfnImageRecipeProps
TypeScript	@aws-cdk/aws-imagebuilder » CfnImageRecipeProps

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 * as imagebuilder from '@aws-cdk/aws-imagebuilder';
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',
  },
  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 of the image recipe.
name	string	The name of the image recipe.
parentImage	string	The parent image of the image recipe.
version	string	The semantic 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.
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 of the image recipe.

Components are orchestration documents that define a sequence of steps for downloading, installing, configuring, and testing software packages. They also define validation and security hardening steps. A component is defined using a YAML document format.

---

name

Type: string

The name of the image recipe.

---

parentImage

Type: string

The parent image of the image recipe.

The string must be either an Image ARN or an AMI ID.

---

version

Type: string

The semantic version of the image recipe.

---

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.

---

blockDeviceMappings?

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

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

---

description?

Type: string (optional)

The description of the image recipe.

---

tags?

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

The tags of the image recipe.

---

workingDirectory?

Type: string (optional)

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