Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. imagebuilder
  5. Image
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.imagebuilder.Image

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Manages an Image Builder Image.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.imagebuilder.Image("example", {
    distributionConfigurationArn: exampleAwsImagebuilderDistributionConfiguration.arn,
    imageRecipeArn: exampleAwsImagebuilderImageRecipe.arn,
    infrastructureConfigurationArn: exampleAwsImagebuilderInfrastructureConfiguration.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.Image("example",
    distribution_configuration_arn=example_aws_imagebuilder_distribution_configuration["arn"],
    image_recipe_arn=example_aws_imagebuilder_image_recipe["arn"],
    infrastructure_configuration_arn=example_aws_imagebuilder_infrastructure_configuration["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/imagebuilder"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := imagebuilder.NewImage(ctx, "example", &imagebuilder.ImageArgs{
			DistributionConfigurationArn:   pulumi.Any(exampleAwsImagebuilderDistributionConfiguration.Arn),
			ImageRecipeArn:                 pulumi.Any(exampleAwsImagebuilderImageRecipe.Arn),
			InfrastructureConfigurationArn: pulumi.Any(exampleAwsImagebuilderInfrastructureConfiguration.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ImageBuilder.Image("example", new()
    {
        DistributionConfigurationArn = exampleAwsImagebuilderDistributionConfiguration.Arn,
        ImageRecipeArn = exampleAwsImagebuilderImageRecipe.Arn,
        InfrastructureConfigurationArn = exampleAwsImagebuilderInfrastructureConfiguration.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.Image;
import com.pulumi.aws.imagebuilder.ImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Image("example", ImageArgs.builder()
            .distributionConfigurationArn(exampleAwsImagebuilderDistributionConfiguration.arn())
            .imageRecipeArn(exampleAwsImagebuilderImageRecipe.arn())
            .infrastructureConfigurationArn(exampleAwsImagebuilderInfrastructureConfiguration.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:imagebuilder:Image
    properties:
      distributionConfigurationArn: ${exampleAwsImagebuilderDistributionConfiguration.arn}
      imageRecipeArn: ${exampleAwsImagebuilderImageRecipe.arn}
      infrastructureConfigurationArn: ${exampleAwsImagebuilderInfrastructureConfiguration.arn}

    Create Image Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);
    @overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          infrastructure_configuration_arn: Optional[str] = None,
          container_recipe_arn: Optional[str] = None,
          distribution_configuration_arn: Optional[str] = None,
          enhanced_image_metadata_enabled: Optional[bool] = None,
          execution_role: Optional[str] = None,
          image_recipe_arn: Optional[str] = None,
          image_scanning_configuration: Optional[ImageImageScanningConfigurationArgs] = None,
          image_tests_configuration: Optional[ImageImageTestsConfigurationArgs] = None,
          tags: Optional[Mapping[str, str]] = None,
          workflows: Optional[Sequence[ImageWorkflowArgs]] = None)
    func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
    public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
    public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

    type: aws:imagebuilder:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var imageResource = new Aws.ImageBuilder.Image("imageResource", new()
{
    InfrastructureConfigurationArn = "string",
    ContainerRecipeArn = "string",
    DistributionConfigurationArn = "string",
    EnhancedImageMetadataEnabled = false,
    ExecutionRole = "string",
    ImageRecipeArn = "string",
    ImageScanningConfiguration = new Aws.ImageBuilder.Inputs.ImageImageScanningConfigurationArgs
    {
        EcrConfiguration = new Aws.ImageBuilder.Inputs.ImageImageScanningConfigurationEcrConfigurationArgs
        {
            ContainerTags = new[]
            {
                "string",
            },
            RepositoryName = "string",
        },
        ImageScanningEnabled = false,
    },
    ImageTestsConfiguration = new Aws.ImageBuilder.Inputs.ImageImageTestsConfigurationArgs
    {
        ImageTestsEnabled = false,
        TimeoutMinutes = 0,
    },
    Tags = 
    {
        { "string", "string" },
    },
    Workflows = new[]
    {
        new Aws.ImageBuilder.Inputs.ImageWorkflowArgs
        {
            WorkflowArn = "string",
            OnFailure = "string",
            ParallelGroup = "string",
            Parameters = new[]
            {
                new Aws.ImageBuilder.Inputs.ImageWorkflowParameterArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
        },
    },
});

    example, err := imagebuilder.NewImage(ctx, "imageResource", &imagebuilder.ImageArgs{
	InfrastructureConfigurationArn: pulumi.String("string"),
	ContainerRecipeArn:             pulumi.String("string"),
	DistributionConfigurationArn:   pulumi.String("string"),
	EnhancedImageMetadataEnabled:   pulumi.Bool(false),
	ExecutionRole:                  pulumi.String("string"),
	ImageRecipeArn:                 pulumi.String("string"),
	ImageScanningConfiguration: &imagebuilder.ImageImageScanningConfigurationArgs{
		EcrConfiguration: &imagebuilder.ImageImageScanningConfigurationEcrConfigurationArgs{
			ContainerTags: pulumi.StringArray{
				pulumi.String("string"),
			},
			RepositoryName: pulumi.String("string"),
		},
		ImageScanningEnabled: pulumi.Bool(false),
	},
	ImageTestsConfiguration: &imagebuilder.ImageImageTestsConfigurationArgs{
		ImageTestsEnabled: pulumi.Bool(false),
		TimeoutMinutes:    pulumi.Int(0),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Workflows: imagebuilder.ImageWorkflowArray{
		&imagebuilder.ImageWorkflowArgs{
			WorkflowArn:   pulumi.String("string"),
			OnFailure:     pulumi.String("string"),
			ParallelGroup: pulumi.String("string"),
			Parameters: imagebuilder.ImageWorkflowParameterArray{
				&imagebuilder.ImageWorkflowParameterArgs{
					Name:  pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
	},
})

    var imageResource = new Image("imageResource", ImageArgs.builder()
    .infrastructureConfigurationArn("string")
    .containerRecipeArn("string")
    .distributionConfigurationArn("string")
    .enhancedImageMetadataEnabled(false)
    .executionRole("string")
    .imageRecipeArn("string")
    .imageScanningConfiguration(ImageImageScanningConfigurationArgs.builder()
        .ecrConfiguration(ImageImageScanningConfigurationEcrConfigurationArgs.builder()
            .containerTags("string")
            .repositoryName("string")
            .build())
        .imageScanningEnabled(false)
        .build())
    .imageTestsConfiguration(ImageImageTestsConfigurationArgs.builder()
        .imageTestsEnabled(false)
        .timeoutMinutes(0)
        .build())
    .tags(Map.of("string", "string"))
    .workflows(ImageWorkflowArgs.builder()
        .workflowArn("string")
        .onFailure("string")
        .parallelGroup("string")
        .parameters(ImageWorkflowParameterArgs.builder()
            .name("string")
            .value("string")
            .build())
        .build())
    .build());

    image_resource = aws.imagebuilder.Image("imageResource",
    infrastructure_configuration_arn="string",
    container_recipe_arn="string",
    distribution_configuration_arn="string",
    enhanced_image_metadata_enabled=False,
    execution_role="string",
    image_recipe_arn="string",
    image_scanning_configuration={
        "ecr_configuration": {
            "container_tags": ["string"],
            "repository_name": "string",
        },
        "image_scanning_enabled": False,
    },
    image_tests_configuration={
        "image_tests_enabled": False,
        "timeout_minutes": 0,
    },
    tags={
        "string": "string",
    },
    workflows=[{
        "workflow_arn": "string",
        "on_failure": "string",
        "parallel_group": "string",
        "parameters": [{
            "name": "string",
            "value": "string",
        }],
    }])

    const imageResource = new aws.imagebuilder.Image("imageResource", {
    infrastructureConfigurationArn: "string",
    containerRecipeArn: "string",
    distributionConfigurationArn: "string",
    enhancedImageMetadataEnabled: false,
    executionRole: "string",
    imageRecipeArn: "string",
    imageScanningConfiguration: {
        ecrConfiguration: {
            containerTags: ["string"],
            repositoryName: "string",
        },
        imageScanningEnabled: false,
    },
    imageTestsConfiguration: {
        imageTestsEnabled: false,
        timeoutMinutes: 0,
    },
    tags: {
        string: "string",
    },
    workflows: [{
        workflowArn: "string",
        onFailure: "string",
        parallelGroup: "string",
        parameters: [{
            name: "string",
            value: "string",
        }],
    }],
});

    type: aws:imagebuilder:Image
properties:
    containerRecipeArn: string
    distributionConfigurationArn: string
    enhancedImageMetadataEnabled: false
    executionRole: string
    imageRecipeArn: string
    imageScanningConfiguration:
        ecrConfiguration:
            containerTags:
                - string
            repositoryName: string
        imageScanningEnabled: false
    imageTestsConfiguration:
        imageTestsEnabled: false
        timeoutMinutes: 0
    infrastructureConfigurationArn: string
    tags:
        string: string
    workflows:
        - onFailure: string
          parallelGroup: string
          parameters:
            - name: string
              value: string
          workflowArn: string

    Image Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Image resource accepts the following input properties:

    InfrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ExecutionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Workflows List<ImageWorkflow>
    Configuration block with the workflow configuration. Detailed below.
    InfrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ExecutionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImageImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImageImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    Tags map[string]string
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Workflows []ImageWorkflowArgs
    Configuration block with the workflow configuration. Detailed below.
    infrastructureConfigurationArn String

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole String
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    tags Map<String,String>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    workflows List<ImageWorkflow>
    Configuration block with the workflow configuration. Detailed below.
    infrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    containerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    distributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    tags {[key: string]: string}
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    workflows ImageWorkflow[]
    Configuration block with the workflow configuration. Detailed below.
    infrastructure_configuration_arn str

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    container_recipe_arn str
    Amazon Resource Name (ARN) of the container recipe.
    distribution_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhanced_image_metadata_enabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    execution_role str
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    image_recipe_arn str
    Amazon Resource Name (ARN) of the image recipe.
    image_scanning_configuration ImageImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    image_tests_configuration ImageImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    tags Mapping[str, str]
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    workflows Sequence[ImageWorkflowArgs]
    Configuration block with the workflow configuration. Detailed below.
    infrastructureConfigurationArn String

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole String
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration Property Map
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration Property Map
    Configuration block with image tests configuration. Detailed below.
    tags Map<String>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    workflows List<Property Map>
    Configuration block with the workflow configuration. Detailed below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the image.
    DateCreated string
    Date the image was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the AMI.
    OsVersion string
    Operating System version of the image.
    OutputResources List<ImageOutputResource>
    List of objects with resources created by the image.
    Platform string
    Platform of the image.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version of the image.
    Arn string
    Amazon Resource Name (ARN) of the image.
    DateCreated string
    Date the image was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the AMI.
    OsVersion string
    Operating System version of the image.
    OutputResources []ImageOutputResource
    List of objects with resources created by the image.
    Platform string
    Platform of the image.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version of the image.
    arn String
    Amazon Resource Name (ARN) of the image.
    dateCreated String
    Date the image was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the AMI.
    osVersion String
    Operating System version of the image.
    outputResources List<ImageOutputResource>
    List of objects with resources created by the image.
    platform String
    Platform of the image.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version of the image.
    arn string
    Amazon Resource Name (ARN) of the image.
    dateCreated string
    Date the image was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the AMI.
    osVersion string
    Operating System version of the image.
    outputResources ImageOutputResource[]
    List of objects with resources created by the image.
    platform string
    Platform of the image.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version string
    Version of the image.
    arn str
    Amazon Resource Name (ARN) of the image.
    date_created str
    Date the image was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the AMI.
    os_version str
    Operating System version of the image.
    output_resources Sequence[ImageOutputResource]
    List of objects with resources created by the image.
    platform str
    Platform of the image.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version str
    Version of the image.
    arn String
    Amazon Resource Name (ARN) of the image.
    dateCreated String
    Date the image was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the AMI.
    osVersion String
    Operating System version of the image.
    outputResources List<Property Map>
    List of objects with resources created by the image.
    platform String
    Platform of the image.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version of the image.

    Look up Existing Image Resource

    Get an existing Image resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ImageState, opts?: CustomResourceOptions): Image
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        container_recipe_arn: Optional[str] = None,
        date_created: Optional[str] = None,
        distribution_configuration_arn: Optional[str] = None,
        enhanced_image_metadata_enabled: Optional[bool] = None,
        execution_role: Optional[str] = None,
        image_recipe_arn: Optional[str] = None,
        image_scanning_configuration: Optional[ImageImageScanningConfigurationArgs] = None,
        image_tests_configuration: Optional[ImageImageTestsConfigurationArgs] = None,
        infrastructure_configuration_arn: Optional[str] = None,
        name: Optional[str] = None,
        os_version: Optional[str] = None,
        output_resources: Optional[Sequence[ImageOutputResourceArgs]] = None,
        platform: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None,
        workflows: Optional[Sequence[ImageWorkflowArgs]] = None) -> Image
    func GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)
    public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)
    public static Image get(String name, Output<String> id, ImageState state, CustomResourceOptions options)
    resources:  _:    type: aws:imagebuilder:Image    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the image.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DateCreated string
    Date the image was created.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ExecutionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    InfrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    Name string
    Name of the AMI.
    OsVersion string
    Operating System version of the image.
    OutputResources List<ImageOutputResource>
    List of objects with resources created by the image.
    Platform string
    Platform of the image.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version of the image.
    Workflows List<ImageWorkflow>
    Configuration block with the workflow configuration. Detailed below.
    Arn string
    Amazon Resource Name (ARN) of the image.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DateCreated string
    Date the image was created.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ExecutionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImageImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImageImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    InfrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    Name string
    Name of the AMI.
    OsVersion string
    Operating System version of the image.
    OutputResources []ImageOutputResourceArgs
    List of objects with resources created by the image.
    Platform string
    Platform of the image.
    Tags map[string]string
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version of the image.
    Workflows []ImageWorkflowArgs
    Configuration block with the workflow configuration. Detailed below.
    arn String
    Amazon Resource Name (ARN) of the image.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated String
    Date the image was created.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole String
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn String

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    name String
    Name of the AMI.
    osVersion String
    Operating System version of the image.
    outputResources List<ImageOutputResource>
    List of objects with resources created by the image.
    platform String
    Platform of the image.
    tags Map<String,String>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version of the image.
    workflows List<ImageWorkflow>
    Configuration block with the workflow configuration. Detailed below.
    arn string
    Amazon Resource Name (ARN) of the image.
    containerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated string
    Date the image was created.
    distributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole string
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImageImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImageImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn string

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    name string
    Name of the AMI.
    osVersion string
    Operating System version of the image.
    outputResources ImageOutputResource[]
    List of objects with resources created by the image.
    platform string
    Platform of the image.
    tags {[key: string]: string}
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version string
    Version of the image.
    workflows ImageWorkflow[]
    Configuration block with the workflow configuration. Detailed below.
    arn str
    Amazon Resource Name (ARN) of the image.
    container_recipe_arn str
    Amazon Resource Name (ARN) of the container recipe.
    date_created str
    Date the image was created.
    distribution_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhanced_image_metadata_enabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    execution_role str
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    image_recipe_arn str
    Amazon Resource Name (ARN) of the image recipe.
    image_scanning_configuration ImageImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    image_tests_configuration ImageImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    infrastructure_configuration_arn str

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    name str
    Name of the AMI.
    os_version str
    Operating System version of the image.
    output_resources Sequence[ImageOutputResourceArgs]
    List of objects with resources created by the image.
    platform str
    Platform of the image.
    tags Mapping[str, str]
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version str
    Version of the image.
    workflows Sequence[ImageWorkflowArgs]
    Configuration block with the workflow configuration. Detailed below.
    arn String
    Amazon Resource Name (ARN) of the image.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated String
    Date the image was created.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    executionRole String
    Amazon Resource Name (ARN) of the service-linked role to be used by Image Builder to execute workflows.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration Property Map
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration Property Map
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn String

    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.

    The following arguments are optional:

    name String
    Name of the AMI.
    osVersion String
    Operating System version of the image.
    outputResources List<Property Map>
    List of objects with resources created by the image.
    platform String
    Platform of the image.
    tags Map<String>
    Key-value map of resource tags for the Image Builder Image. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version of the image.
    workflows List<Property Map>
    Configuration block with the workflow configuration. Detailed below.

    Supporting Types

    ImageImageScanningConfiguration, ImageImageScanningConfigurationArgs

    EcrConfiguration ImageImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration. Detailed below.
    ImageScanningEnabled bool
    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. Defaults to false.
    EcrConfiguration ImageImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration. Detailed below.
    ImageScanningEnabled bool
    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. Defaults to false.
    ecrConfiguration ImageImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration. Detailed below.
    imageScanningEnabled Boolean
    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. Defaults to false.
    ecrConfiguration ImageImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration. Detailed below.
    imageScanningEnabled boolean
    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. Defaults to false.
    ecr_configuration ImageImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration. Detailed below.
    image_scanning_enabled bool
    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. Defaults to false.
    ecrConfiguration Property Map
    Configuration block with ECR configuration. Detailed below.
    imageScanningEnabled Boolean
    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. Defaults to false.

    ImageImageScanningConfigurationEcrConfiguration, ImageImageScanningConfigurationEcrConfigurationArgs

    ContainerTags List<string>
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.
    ContainerTags []string
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.
    containerTags List<String>
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.
    containerTags string[]
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    repositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.
    container_tags Sequence[str]
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    repository_name str
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.
    containerTags List<String>
    Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images.

    ImageImageTestsConfiguration, ImageImageTestsConfigurationArgs

    ImageTestsEnabled bool
    Whether image tests are enabled. Defaults to true.
    TimeoutMinutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    ImageTestsEnabled bool
    Whether image tests are enabled. Defaults to true.
    TimeoutMinutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled Boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes Integer
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes number
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    image_tests_enabled bool
    Whether image tests are enabled. Defaults to true.
    timeout_minutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled Boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes Number
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.

    ImageOutputResource, ImageOutputResourceArgs

    Amis List<ImageOutputResourceAmi>
    Set of objects with each Amazon Machine Image (AMI) created.
    Containers List<ImageOutputResourceContainer>
    Set of objects with each container image created and stored in the output repository.
    Amis []ImageOutputResourceAmi
    Set of objects with each Amazon Machine Image (AMI) created.
    Containers []ImageOutputResourceContainer
    Set of objects with each container image created and stored in the output repository.
    amis List<ImageOutputResourceAmi>
    Set of objects with each Amazon Machine Image (AMI) created.
    containers List<ImageOutputResourceContainer>
    Set of objects with each container image created and stored in the output repository.
    amis ImageOutputResourceAmi[]
    Set of objects with each Amazon Machine Image (AMI) created.
    containers ImageOutputResourceContainer[]
    Set of objects with each container image created and stored in the output repository.
    amis Sequence[ImageOutputResourceAmi]
    Set of objects with each Amazon Machine Image (AMI) created.
    containers Sequence[ImageOutputResourceContainer]
    Set of objects with each container image created and stored in the output repository.
    amis List<Property Map>
    Set of objects with each Amazon Machine Image (AMI) created.
    containers List<Property Map>
    Set of objects with each container image created and stored in the output repository.

    ImageOutputResourceAmi, ImageOutputResourceAmiArgs

    AccountId string
    Account identifier of the AMI.
    Description string
    Description of the AMI.
    Image string
    Identifier of the AMI.
    Name string
    Name of the AMI.
    Region string
    Region of the container image.
    AccountId string
    Account identifier of the AMI.
    Description string
    Description of the AMI.
    Image string
    Identifier of the AMI.
    Name string
    Name of the AMI.
    Region string
    Region of the container image.
    accountId String
    Account identifier of the AMI.
    description String
    Description of the AMI.
    image String
    Identifier of the AMI.
    name String
    Name of the AMI.
    region String
    Region of the container image.
    accountId string
    Account identifier of the AMI.
    description string
    Description of the AMI.
    image string
    Identifier of the AMI.
    name string
    Name of the AMI.
    region string
    Region of the container image.
    account_id str
    Account identifier of the AMI.
    description str
    Description of the AMI.
    image str
    Identifier of the AMI.
    name str
    Name of the AMI.
    region str
    Region of the container image.
    accountId String
    Account identifier of the AMI.
    description String
    Description of the AMI.
    image String
    Identifier of the AMI.
    name String
    Name of the AMI.
    region String
    Region of the container image.

    ImageOutputResourceContainer, ImageOutputResourceContainerArgs

    ImageUris List<string>
    Set of URIs for created containers.
    Region string
    Region of the container image.
    ImageUris []string
    Set of URIs for created containers.
    Region string
    Region of the container image.
    imageUris List<String>
    Set of URIs for created containers.
    region String
    Region of the container image.
    imageUris string[]
    Set of URIs for created containers.
    region string
    Region of the container image.
    image_uris Sequence[str]
    Set of URIs for created containers.
    region str
    Region of the container image.
    imageUris List<String>
    Set of URIs for created containers.
    region String
    Region of the container image.

    ImageWorkflow, ImageWorkflowArgs

    WorkflowArn string

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    OnFailure string
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    ParallelGroup string
    The parallel group in which to run a test Workflow.
    Parameters List<ImageWorkflowParameter>
    Configuration block for the workflow parameters. Detailed below.
    WorkflowArn string

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    OnFailure string
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    ParallelGroup string
    The parallel group in which to run a test Workflow.
    Parameters []ImageWorkflowParameter
    Configuration block for the workflow parameters. Detailed below.
    workflowArn String

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    onFailure String
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    parallelGroup String
    The parallel group in which to run a test Workflow.
    parameters List<ImageWorkflowParameter>
    Configuration block for the workflow parameters. Detailed below.
    workflowArn string

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    onFailure string
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    parallelGroup string
    The parallel group in which to run a test Workflow.
    parameters ImageWorkflowParameter[]
    Configuration block for the workflow parameters. Detailed below.
    workflow_arn str

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    on_failure str
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    parallel_group str
    The parallel group in which to run a test Workflow.
    parameters Sequence[ImageWorkflowParameter]
    Configuration block for the workflow parameters. Detailed below.
    workflowArn String

    Amazon Resource Name (ARN) of the Image Builder Workflow.

    The following arguments are optional:

    onFailure String
    The action to take if the workflow fails. Must be one of CONTINUE or ABORT.
    parallelGroup String
    The parallel group in which to run a test Workflow.
    parameters List<Property Map>
    Configuration block for the workflow parameters. Detailed below.

    ImageWorkflowParameter, ImageWorkflowParameterArgs

    Name string
    The name of the Workflow parameter.
    Value string
    The value of the Workflow parameter.
    Name string
    The name of the Workflow parameter.
    Value string
    The value of the Workflow parameter.
    name String
    The name of the Workflow parameter.
    value String
    The value of the Workflow parameter.
    name string
    The name of the Workflow parameter.
    value string
    The value of the Workflow parameter.
    name str
    The name of the Workflow parameter.
    value str
    The value of the Workflow parameter.
    name String
    The name of the Workflow parameter.
    value String
    The value of the Workflow parameter.

    Import

    Using pulumi import, import aws_imagebuilder_image resources using the Amazon Resource Name (ARN). For example:

    $ pulumi import aws:imagebuilder/image:Image example arn:aws:imagebuilder:us-east-1:123456789012:image/example/1.0.0/1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws