class CfnImageRecipe (construct)

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

Implements IConstruct, IDependable, IInspectable, IImageRecipeRef, IEnvironmentAware, ITaggable

Creates a new image recipe.

Image recipes define how images are configured, tested, and assessed.

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 cfnImageRecipe = new imagebuilder.CfnImageRecipe(this, 'MyCfnImageRecipe', {
  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',
  }],
  components: [{
    componentArn: 'componentArn',
    parameters: [{
      name: 'name',
      value: ['value'],
    }],
  }],
  description: 'description',
  tags: {
    tagsKey: 'tags',
  },
  workingDirectory: 'workingDirectory',
});

Initializer

new CfnImageRecipe(scope: Construct, id: string, props: CfnImageRecipeProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnImageRecipeProps — Resource properties.

Create a new AWS::ImageBuilder::ImageRecipe.

Construct Props

Name	Type	Description
name	`string`	The name of the image recipe.
parentImage	`string`	The base image for customizations specified in the image recipe.
version	`string`	The semantic version of the image recipe. This version follows the semantic version syntax.
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.
components?	`IResolvable` `\| (IResolvable` `\|` `ComponentConfigurationProperty)[]`	The components that are included in the image 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.

name

Type: string

The name of the image recipe.

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

version

Type: string

The semantic version of the image recipe. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

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.

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.

blockDeviceMappings?

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

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

components?

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

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.

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.

Properties

Name	Type	Description
attrArn	`string`	Returns the Amazon Resource Name (ARN) of the image recipe.
attrLatestVersion	`IResolvable`	The latest version references of the image recipe.
attrLatestVersionArn	`string`	The latest version Amazon Resource Name (ARN) of the Image Builder resource.
attrLatestVersionMajor	`string`	The latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.
attrLatestVersionMinor	`string`	The latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.
attrLatestVersionPatch	`string`	The latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.
attrName	`string`	The name of the image recipe.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
env	`ResourceEnvironment`
imageRecipeRef	`ImageRecipeReference`	A reference to a ImageRecipe resource.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the image recipe.
node	`Node`	The tree node.
parentImage	`string`	The base image for customizations specified in the image recipe.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
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.
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.
components?	`IResolvable` `\| (IResolvable` `\|` `ComponentConfigurationProperty)[]`	The components that are included in the image recipe.
description?	`string`	The description of the image recipe.
tagsRaw?	`{ [string]: string }`	The tags of the image recipe.
workingDirectory?	`string`	The working directory to be used during build and test workflows.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

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

For example, arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03 .

attrLatestVersion

Type: IResolvable

The latest version references of the image recipe.

attrLatestVersionArn

Type: string

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

attrLatestVersionMajor

Type: string

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

attrLatestVersionMinor

Type: string

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

attrLatestVersionPatch

Type: string

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

attrName

Type: string

The name of the image recipe.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

env

Type: ResourceEnvironment

imageRecipeRef

Type: ImageRecipeReference

A reference to a ImageRecipe resource.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the image recipe.

node

Type: Node

The tree node.

parentImage

Type: string

The base image for customizations specified in the image recipe.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

version

Type: string

The semantic version of the image recipe.

This version follows the semantic version syntax.

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.

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.

blockDeviceMappings?

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

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

components?

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

The components that are included in the image recipe.

description?

Type: string (optional)

The description of the image recipe.

tagsRaw?

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)
static arnForImageRecipe(resource)
static isCfnImageRecipe(x)	Checks whether the given object is a CfnImageRecipe.

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

(Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }

static arnForImageRecipe(resource)

public static arnForImageRecipe(resource: IImageRecipeRef): string

Parameters

resource IImageRecipeRef

Returns

string

static isCfnImageRecipe(x)

public static isCfnImageRecipe(x: any): boolean

Parameters

x any

Returns

boolean

Checks whether the given object is a CfnImageRecipe.