Image class

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"])
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_imagebuilder_image" "example" {
  distribution_configuration_arn   = exampleAwsImagebuilderDistributionConfiguration.arn
  image_recipe_arn                 = exampleAwsImagebuilderImageRecipe.arn
  infrastructure_configuration_arn = 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.ArrayList;
import java.util.Arrays;
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}

Import

Identity Schema

Required

  • arn (String) ARN of the Image Builder image.

Using pulumi import, import aws.imagebuilder.Image resources using the ARN. For example:

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

Constructors

Image(String name, {ImageArgs? args, CustomResourceOptions? options})
Creates a new Image. name The Pulumi resource name. args Arguments used to configure this Image. The set of arguments for Image. options Resource options controlling this resource's behavior.
Image.reference(String urn)
Creates a typed reference to an existing Image resource.

Properties

arn ↔ Output<String>
ARN of the image.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
containerRecipeArn ↔ Output<String?>
ARN of the container recipe.
latefinal
dateCreated ↔ Output<String>
Date the image was created.
latefinal
distributionConfigurationArn ↔ Output<String?>
ARN of the Image Builder Distribution Configuration.
latefinal
enhancedImageMetadataEnabled ↔ Output<bool?>
Whether additional information about the image being created is collected. Defaults to true.
latefinal
executionRole ↔ Output<String>
ARN of the service-linked role to be used by Image Builder to execute workflows.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
imageRecipeArn ↔ Output<String?>
ARN of the image recipe.
latefinal
imageScanningConfiguration ↔ Output<ImageImageScanningConfiguration>
Configuration block with image scanning configuration. Detailed below.
latefinal
imageTestsConfiguration ↔ Output<ImageImageTestsConfiguration>
Configuration block with image tests configuration. Detailed below.
latefinal
infrastructureConfigurationArn ↔ Output<String>
ARN of the Image Builder Infrastructure Configuration.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
loggingConfiguration ↔ Output<ImageLoggingConfiguration?>
Configuration block with logging configuration. Detailed below.
latefinal
name ↔ Output<String>
Name of the AMI.
latefinal
osVersion ↔ Output<String>
Operating System version of the image.
latefinal
outputResources ↔ Output<List<ImageOutputResource>>
List of objects with resources created by the image.
latefinal
platform ↔ Output<String>
Platform of the image.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
version ↔ Output<String>
Version of the image.
latefinal
workflows ↔ Output<List<ImageWorkflow>>
Configuration block with the workflow configuration. Detailed below.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ImageState? state, CustomResourceOptions? options}) → Image
Gets an existing Image resource's state with the given name and id.