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

Properties for creating an Image Pipeline resource.

Extends: ImagePipelineProps
Used as props by: ImagePipeline

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/image-pipeline.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-imagebuilder-alpha/lib/image-pipeline.ts#L156)

## Example

```ts
const workflowPipeline = new imagebuilder.ImagePipeline(this, 'WorkflowPipeline', {
  recipe: exampleImageRecipe,
  workflows: [
    { workflow: imagebuilder.AmazonManagedWorkflow.buildImage(this, 'BuildWorkflow') },
    { workflow: imagebuilder.AmazonManagedWorkflow.testImage(this, 'TestWorkflow') }
  ]
});
```

## Properties

- `description`: string = None — The description of the image pipeline.

- `distributionConfiguration`: [IDistributionConfiguration](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.IDistributionConfiguration.html) = None — The distribution configuration used for distributing the image.

- `enhancedImageMetadataEnabled`: boolean = true — If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The execution role used to perform workflow actions to build this image.

  **Default:** Image Builder will use the SLR if possible. Otherwise, an execution role will be generated

  By default, the Image Builder Service Linked Role (SLR) will be created automatically and used as the execution
  role. However, when providing a custom set of image workflows for the pipeline, an execution role will be
  generated with the minimal permissions needed to execute the workflows.

- `imageLogGroup`: [ILogGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html) — The log group to use for images created from the image pipeline.

  **Default:** a log group will be created

  By default, a log group will be created with the
  format `/aws/imagebuilder/<image-name>`.

- `imagePipelineLogGroup`: [ILogGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html) — The log group to use for the image pipeline.

  **Default:** a log group will be created

  By default, a log group will be created with the format
  `/aws/imagebuilder/pipeline/<pipeline-name>`

- `imagePipelineName`: string — The name of the image pipeline.

  **Default:** a name is generated

- `imageScanningEcrRepository`: [IRepository](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.IRepository.html) — The container repository that Amazon Inspector scans to identify findings for your container images.

  **Default:** if scanning is enabled, a repository will be created by Image Builder if one is not provided

  If a
  repository is not provided, Image Builder creates a repository named `image-builder-image-scanning-repository`
  for vulnerability scanning.

- `imageScanningEcrTags`: string[] = None — The tags for Image Builder to apply to the output container image that Amazon Inspector scans.

- `imageScanningEnabled`: boolean = false — Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

- `imageTestsEnabled`: boolean = true — Whether to run tests after building an image.

- `infrastructureConfiguration`: [IInfrastructureConfiguration](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.IInfrastructureConfiguration.html) — The infrastructure configuration used for building the image.

  **Default:** an infrastructure configuration will be created with the default settings

  A default infrastructure configuration will be used if one is not provided.

  The default configuration will create an instance profile and role with minimal permissions needed to build the
  image, attached to the EC2 instance.

- `recipe`: [IRecipeBase](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.IRecipeBase.html) (required) — The recipe that defines the base image, components, and customizations used to build the image.

  This can either be
  an image recipe, or a container recipe.

- `schedule`: [ImagePipelineSchedule](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.ImagePipelineSchedule.html) — The schedule of the image pipeline.

  **Default:** none, a manual image pipeline will be created

  This configures how often and when a pipeline automatically creates a new
  image.

- `status`: [ImagePipelineStatus](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.ImagePipelineStatus.html) = ImagePipelineStatus.ENABLED — Indicates whether the pipeline is enabled to be triggered by the provided schedule.

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

- `workflows`: [WorkflowConfiguration](/cdk/api/v2/docs/@aws-cdk_aws-imagebuilder-alpha.WorkflowConfiguration.html)[] — The list of workflow configurations used to build the image.

  **Default:** Image Builder will use a default set of workflows for the build to build, test, and distribute the image