Skip to content

Resource: awsImagebuilderImagePipeline

Manages an Image Builder Image Pipeline.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.imagebuilderImagePipeline.ImagebuilderImagePipeline(this, "example", {
  imageRecipeArn: "${aws_imagebuilder_image_recipe.example.arn}",
  infrastructureConfigurationArn:
    "${aws_imagebuilder_infrastructure_configuration.example.arn}",
  name: "example",
  schedule: {
    scheduleExpression: "cron(0 0 * * ? *)",
  },
});

Argument Reference

The following arguments are required:

  • infrastructureConfigurationArn - (Required) Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
  • name - (Required) Name of the image pipeline.

The following arguments are optional:

  • containerRecipeArn - (Optional) Amazon Resource Name (ARN) of the container recipe.
  • description - (Optional) Description of the image pipeline.
  • distributionConfigurationArn - (Optional) Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
  • enhancedImageMetadataEnabled - (Optional) Whether additional information about the image being created is collected. Defaults to true.
  • imageRecipeArn - (Optional) Amazon Resource Name (ARN) of the image recipe.
  • imageTestsConfiguration - (Optional) Configuration block with image tests configuration. Detailed below.
  • schedule - (Optional) Configuration block with schedule settings. Detailed below.
  • status - (Optional) Status of the image pipeline. Valid values are disabled and enabled. Defaults to enabled.
  • tags - (Optional) Key-value map of resource tags for the image pipeline. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

imageTestsConfiguration

The following arguments are optional:

  • imageTestsEnabled - (Optional) Whether image tests are enabled. Defaults to true.
  • timeoutMinutes - (Optional) Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.

schedule

The following arguments are required:

  • scheduleExpression - (Required) Cron expression of how often the pipeline start condition is evaluated. For example, cron(00 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(00 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

The following arguments are optional:

  • pipelineExecutionStartCondition - (Optional) Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

  • timezone - (Optional) The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of the image pipeline.
  • dateCreated - Date the image pipeline was created.
  • dateLastRun - Date the image pipeline was last run.
  • dateNextRun - Date the image pipeline will run next.
  • dateUpdated - Date the image pipeline was updated.
  • platform - Platform of the image pipeline.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

awsImagebuilderImagePipeline resources can be imported using the Amazon Resource Name (ARN), e.g.,

$ terraform import aws_imagebuilder_image_pipeline.example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example