Skip to content

Resource: awsImagebuilderImage

Manages an Image Builder Image.

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.imagebuilderImage.ImagebuilderImage(this, "example", {
  distributionConfigurationArn:
    "${aws_imagebuilder_distribution_configuration.example.arn}",
  imageRecipeArn: "${aws_imagebuilder_image_recipe.example.arn}",
  infrastructureConfigurationArn:
    "${aws_imagebuilder_infrastructure_configuration.example.arn}",
});

Argument Reference

The following arguments are required:

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

The following arguments are optional:

  • containerRecipeArn - (Optional) - Amazon Resource Name (ARN) of the container recipe.
  • 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.
  • tags - (Optional) Key-value map of resource tags for the Image Builder Image. 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.

Attributes Reference

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

  • arn - Amazon Resource Name (ARN) of the image.
  • dateCreated - Date the image was created.
  • platform - Platform of the image.
  • osVersion - Operating System version of the image.
  • outputResources - List of objects with resources created by the image.
  • amis - Set of objects with each Amazon Machine Image (AMI) created.
    • accountId - Account identifier of the AMI.
    • description - Description of the AMI.
    • image - Identifier of the AMI.
    • name - Name of the AMI.
    • region - Region of the AMI.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
  • version - Version of the image.

Timeouts

Configuration options:

  • create - (Default 60M)

Import

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

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