> **Experimental**
>
> `@aws-cdk/aws-imagebuilder-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# ContainerRecipeProps

Properties for creating a Container Recipe resource.

Used as props by: [ContainerRecipe](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.ContainerRecipe.html)

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/container-recipe.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/@aws-cdk/aws-imagebuilder-alpha/lib/container-recipe.ts#L65)

## Example

TypeScript:

```ts
const containerRecipe = new imagebuilder.ContainerRecipe(this, 'MyContainerRecipe', {
  baseImage: imagebuilder.BaseContainerImage.fromDockerHub('amazonlinux', 'latest'),
  targetRepository: imagebuilder.Repository.fromEcr(
    ecr.Repository.fromRepositoryName(this, 'Repository', 'my-container-repo')
  )
});

const containerPipeline = new imagebuilder.ImagePipeline(this, 'MyContainerPipeline', {
  recipe: exampleContainerRecipe
});
```

Python:

```python
container_recipe = imagebuilder.ContainerRecipe(self, "MyContainerRecipe",
    base_image=imagebuilder.BaseContainerImage.from_docker_hub("amazonlinux", "latest"),
    target_repository=imagebuilder.Repository.from_ecr(
        ecr.Repository.from_repository_name(self, "Repository", "my-container-repo"))
)

container_pipeline = imagebuilder.ImagePipeline(self, "MyContainerPipeline",
    recipe=example_container_recipe
)
```

Java:

```java
ContainerRecipe containerRecipe = ContainerRecipe.Builder.create(this, "MyContainerRecipe")
        .baseImage(BaseContainerImage.fromDockerHub("amazonlinux", "latest"))
        .targetRepository(Repository.fromEcr(Repository.fromRepositoryName(this, "Repository", "my-container-repo")))
        .build();

ImagePipeline containerPipeline = ImagePipeline.Builder.create(this, "MyContainerPipeline")
        .recipe(exampleContainerRecipe)
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var containerRecipe = new ContainerRecipe(this, "MyContainerRecipe", new ContainerRecipeProps {
    BaseImage = BaseContainerImage.FromDockerHub("amazonlinux", "latest"),
    TargetRepository = Repository.FromEcr(Repository.FromRepositoryName(this, "Repository", "my-container-repo"))
});

var containerPipeline = new ImagePipeline(this, "MyContainerPipeline", new ImagePipelineProps {
    Recipe = exampleContainerRecipe
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
containerRecipe := imagebuilder.NewContainerRecipe(this, jsii.String("MyContainerRecipe"), &ContainerRecipeProps{
	BaseImage: imagebuilder.BaseContainerImage_*FromDockerHub(jsii.String("amazonlinux"), jsii.String("latest")),
	TargetRepository: imagebuilder.Repository_*FromEcr(ecr.Repository_*FromRepositoryName(this, jsii.String("Repository"), jsii.String("my-container-repo"))),
})

containerPipeline := imagebuilder.NewImagePipeline(this, jsii.String("MyContainerPipeline"), &ImagePipelineProps{
	Recipe: exampleContainerRecipe,
})
```

## Properties

- `baseImage`: [BaseContainerImage](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.BaseContainerImage.html) (required) — The base image for customizations specified in the container recipe.

- `components`: [ComponentConfiguration](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.ComponentConfiguration.html)[] = None — The list of component configurations to apply in the image build.

- `containerRecipeName`: string — The name of the container recipe.

  **Default:** a name is generated

- `containerRecipeVersion`: string = 1.0.x — The version of the container recipe.

- `description`: string = None — The description of the container recipe.

- `dockerfile`: [DockerfileData](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.DockerfileData.html) — The dockerfile template used to build the container image.

  **Default:** a standard dockerfile template will be generated to pull the base image, perform environment setup, and run all components in the recipe

- `instanceBlockDevices`: [BlockDevice](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.BlockDevice.html)[] — The block devices to attach to the instance used for building, testing, and distributing the container image.

  **Default:** the block devices of the instance image will be used

- `instanceImage`: [ContainerInstanceImage](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.ContainerInstanceImage.html) — The image to use to launch the instance used for building, testing, and distributing the container image.

  **Default:** Image Builder will use the appropriate ECS-optimized AMI

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) = None — The KMS key used to encrypt the dockerfile template.

- `osVersion`: [OSVersion](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.OSVersion.html) — The operating system (OS) version of the base image.

  **Default:** Image Builder will determine the OS version of the base image, if sourced from a third-party container registry. Otherwise, the OS version of the base image is required.

- `tags`: { [key: string]: string } = None — The tags to apply to the container recipe.

- `targetRepository`: [Repository](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.Repository.html) (required) — The container repository where the output container image is stored.

- `workingDirectory`: string — The working directory for use during build and test workflows.

  **Default:** the Image Builder default working directory is used. For Linux and macOS builds, this would be /tmp. For Windows builds, this would be C:/
