interface CfnContainerRecipeMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ImageBuilder.Mixins.CfnContainerRecipeMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsimagebuilder/mixins#CfnContainerRecipeMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.imagebuilder.mixins.CfnContainerRecipeMixinProps |
 Python | aws_cdk.mixins_preview.aws_imagebuilder.mixins.CfnContainerRecipeMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_imagebuilder » mixins » CfnContainerRecipeMixinProps |
Properties for CfnContainerRecipePropsMixin.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as imagebuilder_mixins } from '@aws-cdk/mixins-preview/aws-imagebuilder';
const cfnContainerRecipeMixinProps: imagebuilder_mixins.CfnContainerRecipeMixinProps = {
components: [{
componentArn: 'componentArn',
parameters: [{
name: 'name',
value: ['value'],
}],
}],
containerType: 'containerType',
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',
name: 'name',
parentImage: 'parentImage',
platformOverride: 'platformOverride',
tags: {
tagsKey: 'tags',
},
targetRepository: {
repositoryName: 'repositoryName',
service: 'service',
},
version: 'version',
workingDirectory: 'workingDirectory',
};
Properties
| Name | Type | Description |
|---|---|---|
| components? | IResolvable | (IResolvable | Component)[] | Build and test components that are included in the container recipe. |
| container | string | Specifies the type of container, such as Docker. |
| description? | string | The description of the container recipe. |
| dockerfile | 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. |
| dockerfile | string | The S3 URI for the Dockerfile that will be used to build your container image. |
| image | string | Specifies the operating system version for the base image. |
| instance | IResolvable | Instance | A group of options that can be used to configure an instance for building and testing container images. |
| kms | string | The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region. |
| name? | string | The name of the container recipe. |
| parent | string | The base image for customizations specified in the container recipe. |
| platform | string | Specifies the operating system platform when you use a custom base image. |
| tags? | { [string]: string } | Tags that are attached to the container recipe. |
| target | IResolvable | Target | The destination repository for the container image. |
| version? | string | The semantic version of the container recipe. This version follows the semantic version syntax. |
| working | string | The working directory for use during build and test workflows. |
components?
Type:
IResolvable | (IResolvable | Component)[]
(optional)
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
(optional)
Specifies the type of container, such as Docker.
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 | Instance
(optional)
A group of options that can be used to configure an instance for building and testing container images.
kmsKeyId?
Type:
string
(optional)
The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region.
This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
name?
Type:
string
(optional)
The name of the container recipe.
parentImage?
Type:
string
(optional)
The base image for customizations specified in the container recipe.
This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest .
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.
targetRepository?
Type:
IResolvable | Target
(optional)
The destination repository for the container image.
version?
Type:
string
(optional)
The semantic version of the container 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.
workingDirectory?
Type:
string
(optional)
The working directory for use during build and test workflows.