class CfnContainerRecipe (construct)

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

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ImageBuilder::ContainerRecipe.

Creates a new container recipe. Container 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 * as imagebuilder from '@aws-cdk/aws-imagebuilder';
const cfnContainerRecipe = new imagebuilder.CfnContainerRecipe(this, 'MyCfnContainerRecipe', {
  components: [{
    componentArn: 'componentArn',
    parameters: [{
      name: 'name',
      value: ['value'],
    }],
  }],
  containerType: 'containerType',
  name: 'name',
  parentImage: 'parentImage',
  targetRepository: {
    repositoryName: 'repositoryName',
    service: 'service',
  },
  version: 'version',

  // the properties below are optional
  description: 'description',
  dockerfileTemplateData: 'dockerfileTemplateData',
  dockerfileTemplateUri: 'dockerfileTemplateUri',
  imageOsVersionOverride: 'imageOsVersionOverride',
  instanceConfiguration: {
    blockDeviceMappings: [{
      deviceName: 'deviceName',
      ebs: {
        deleteOnTermination: false,
        encrypted: false,
        iops: 123,
        kmsKeyId: 'kmsKeyId',
        snapshotId: 'snapshotId',
        throughput: 123,
        volumeSize: 123,
        volumeType: 'volumeType',
      },
      noDevice: 'noDevice',
      virtualName: 'virtualName',
    }],
    image: 'image',
  },
  kmsKeyId: 'kmsKeyId',
  platformOverride: 'platformOverride',
  tags: {
    tagsKey: 'tags',
  },
  workingDirectory: 'workingDirectory',
});

Initializer

new CfnContainerRecipe(scope: Construct, id: string, props: CfnContainerRecipeProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnContainerRecipeProps — - resource properties.

Create a new AWS::ImageBuilder::ContainerRecipe.

Construct Props

Name	Type	Description
components	`IResolvable` `\|` `IResolvable` `\|` `ComponentConfigurationProperty[]`	Build and test components that are included in the container recipe.
containerType	`string`	Specifies the type of container, such as Docker.
name	`string`	The name of the container recipe.
parentImage	`string`	The base image for the container recipe.
targetRepository	`IResolvable` `\|` `TargetContainerRepositoryProperty`	The destination repository for the container image.
version	`string`	The semantic version of the container recipe.
description?	`string`	The description of the container recipe.
dockerfileTemplateData?	`string`	Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
dockerfileTemplateUri?	`string`	The S3 URI for the Dockerfile that will be used to build your container image.
imageOsVersionOverride?	`string`	Specifies the operating system version for the base image.
instanceConfiguration?	`IResolvable` `\|` `InstanceConfigurationProperty`	A group of options that can be used to configure an instance for building and testing container images.
kmsKeyId?	`string`	Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
platformOverride?	`string`	Specifies the operating system platform when you use a custom base image.
tags?	`{ [string]: string }`	Tags that are attached to the container recipe.
workingDirectory?	`string`	The working directory for use during build and test workflows.

components

Type: IResolvable | IResolvable | ComponentConfigurationProperty[]

Build and test components that are included in the container recipe.

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

containerType

Type: string

Specifies the type of container, such as Docker.

name

Type: string

The name of the container recipe.

parentImage

Type: string

The base image for the container recipe.

targetRepository

Type: IResolvable | TargetContainerRepositoryProperty

The destination repository for the container image.

version

Type: string

The semantic version of the container recipe.

The semantic version has four nodes: ../. 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

description?

Type: string (optional)

The description of the container recipe.

dockerfileTemplateData?

Type: string (optional)

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.

The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

dockerfileTemplateUri?

Type: string (optional)

The S3 URI for the Dockerfile that will be used to build your container image.

imageOsVersionOverride?

Type: string (optional)

Specifies the operating system version for the base image.

instanceConfiguration?

Type: IResolvable | InstanceConfigurationProperty (optional)

A group of options that can be used to configure an instance for building and testing container images.

kmsKeyId?

Type: string (optional)

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

platformOverride?

Type: string (optional)

Specifies the operating system platform when you use a custom base image.

tags?

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

Tags that are attached to the container recipe.

workingDirectory?

Type: string (optional)

The working directory for use during build and test workflows.

Properties

Name	Type	Description
attrArn	`string`	Returns the Amazon Resource Name (ARN) of the container recipe.
attrName	`string`	Returns the name of the container recipe.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
components	`IResolvable` `\|` `IResolvable` `\|` `ComponentConfigurationProperty[]`	Build and test components that are included in the container recipe.
containerType	`string`	Specifies the type of container, such as Docker.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the container recipe.
node	`ConstructNode`	The construct tree node associated with this construct.
parentImage	`string`	The base image for the container 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`	Tags that are attached to the container recipe.
targetRepository	`IResolvable` `\|` `TargetContainerRepositoryProperty`	The destination repository for the container image.
version	`string`	The semantic version of the container recipe.
description?	`string`	The description of the container recipe.
dockerfileTemplateData?	`string`	Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
dockerfileTemplateUri?	`string`	The S3 URI for the Dockerfile that will be used to build your container image.
imageOsVersionOverride?	`string`	Specifies the operating system version for the base image.
instanceConfiguration?	`IResolvable` `\|` `InstanceConfigurationProperty`	A group of options that can be used to configure an instance for building and testing container images.
kmsKeyId?	`string`	Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
platformOverride?	`string`	Specifies the operating system platform when you use a custom base image.
workingDirectory?	`string`	The working directory for use 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 container recipe.

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

attrName

Type: string

Returns the name of the container recipe.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

components

Type: IResolvable | IResolvable | ComponentConfigurationProperty[]

Build and test components that are included in the container recipe.

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

containerType

Type: string

Specifies the type of container, such as Docker.

creationStack

Type: string[]

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 container recipe.

node

Type: ConstructNode

The construct tree node associated with this construct.

parentImage

Type: string

The base image for the container 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).

targetRepository

Type: IResolvable | TargetContainerRepositoryProperty

The destination repository for the container image.

version

Type: string

The semantic version of the container recipe.

The semantic version has four nodes: ../. 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

description?

Type: string (optional)

The description of the container recipe.

dockerfileTemplateData?

Type: string (optional)

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.

The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

dockerfileTemplateUri?

Type: string (optional)

The S3 URI for the Dockerfile that will be used to build your container image.

imageOsVersionOverride?

Type: string (optional)

Specifies the operating system version for the base image.

instanceConfiguration?

Type: IResolvable | InstanceConfigurationProperty (optional)

A group of options that can be used to configure an instance for building and testing container images.

kmsKeyId?

Type: string (optional)

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

platformOverride?

Type: string (optional)

Specifies the operating system platform when you use a custom base image.

workingDirectory?

Type: string (optional)

The working directory for use 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)`.
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)	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.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(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.

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

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.

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.

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 }