AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getImage

Provides details about an Image Builder Image.

Example Usage

Latest

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.ImageBuilder.GetImage.InvokeAsync(new Aws.ImageBuilder.GetImageArgs
        {
            Arn = "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := imagebuilder.LookupImage(ctx, &imagebuilder.LookupImageArgs{
			Arn: "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var example = Output.of(ImagebuilderFunctions.getImage(GetImageArgs.builder()
            .arn("arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.get_image(arn="arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.imagebuilder.getImage({
    arn: "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:imagebuilder:getImage
      Arguments:
        arn: arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x

Using getImage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
def get_image(arn: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(arn: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

> Note: This function is named LookupImage in the Go SDK.

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:imagebuilder/getImage:getImage
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Arn string

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

Tags Dictionary<string, string>

Key-value map of resource tags for the image.

Arn string

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

Tags map[string]string

Key-value map of resource tags for the image.

arn String

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

tags Map<String,String>

Key-value map of resource tags for the image.

arn string

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

tags {[key: string]: string}

Key-value map of resource tags for the image.

arn str

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

tags Mapping[str, str]

Key-value map of resource tags for the image.

arn String

Amazon Resource Name (ARN) of the image. The suffix can either be specified with wildcards (x.x.x) to fetch the latest build version or a full build version (e.g., 2020.11.26/1) to fetch an exact version.

tags Map<String>

Key-value map of resource tags for the image.

getImage Result

The following output properties are available:

Arn string
BuildVersionArn string

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

Id string

The provider-assigned unique ID for this managed resource.

ImageRecipeArn string

Amazon Resource Name (ARN) of the image recipe.

ImageTestsConfigurations List<GetImageImageTestsConfiguration>

List of an object with image tests configuration.

InfrastructureConfigurationArn string

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

Name string

Name of the AMI.

OsVersion string

Operating System version of the image.

OutputResources List<GetImageOutputResource>

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.

Version string

Version of the image.

Arn string
BuildVersionArn string

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

Id string

The provider-assigned unique ID for this managed resource.

ImageRecipeArn string

Amazon Resource Name (ARN) of the image recipe.

ImageTestsConfigurations []GetImageImageTestsConfiguration

List of an object with image tests configuration.

InfrastructureConfigurationArn string

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

Name string

Name of the AMI.

OsVersion string

Operating System version of the image.

OutputResources []GetImageOutputResource

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.

Version string

Version of the image.

arn String
buildVersionArn String

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

id String

The provider-assigned unique ID for this managed resource.

imageRecipeArn String

Amazon Resource Name (ARN) of the image recipe.

imageTestsConfigurations List<GetImageImageTestsConfiguration>

List of an object with image tests configuration.

infrastructureConfigurationArn String

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

name String

Name of the AMI.

osVersion String

Operating System version of the image.

outputResources List<GetImageOutputResource>

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.

version String

Version of the image.

arn string
buildVersionArn string

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

id string

The provider-assigned unique ID for this managed resource.

imageRecipeArn string

Amazon Resource Name (ARN) of the image recipe.

imageTestsConfigurations GetImageImageTestsConfiguration[]

List of an object with image tests configuration.

infrastructureConfigurationArn string

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

name string

Name of the AMI.

osVersion string

Operating System version of the image.

outputResources GetImageOutputResource[]

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.

version string

Version of the image.

arn str
build_version_arn str

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

id str

The provider-assigned unique ID for this managed resource.

image_recipe_arn str

Amazon Resource Name (ARN) of the image recipe.

image_tests_configurations Sequence[GetImageImageTestsConfiguration]

List of an object with image tests configuration.

infrastructure_configuration_arn str

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

name str

Name of the AMI.

os_version str

Operating System version of the image.

output_resources Sequence[GetImageOutputResource]

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.

version str

Version of the image.

arn String
buildVersionArn String

Build version Amazon Resource Name (ARN) of the image. This will always have the #.#.#/# suffix.

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.

id String

The provider-assigned unique ID for this managed resource.

imageRecipeArn String

Amazon Resource Name (ARN) of the image recipe.

imageTestsConfigurations List<Property Map>

List of an object with image tests configuration.

infrastructureConfigurationArn String

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

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.

version String

Version of the image.

Supporting Types

GetImageImageTestsConfiguration

ImageTestsEnabled bool

Whether image tests are enabled.

TimeoutMinutes int

Number of minutes before image tests time out.

ImageTestsEnabled bool

Whether image tests are enabled.

TimeoutMinutes int

Number of minutes before image tests time out.

imageTestsEnabled Boolean

Whether image tests are enabled.

timeoutMinutes Integer

Number of minutes before image tests time out.

imageTestsEnabled boolean

Whether image tests are enabled.

timeoutMinutes number

Number of minutes before image tests time out.

image_tests_enabled bool

Whether image tests are enabled.

timeout_minutes int

Number of minutes before image tests time out.

imageTestsEnabled Boolean

Whether image tests are enabled.

timeoutMinutes Number

Number of minutes before image tests time out.

GetImageOutputResource

Amis List<GetImageOutputResourceAmi>

Set of objects with each Amazon Machine Image (AMI) created.

Amis []GetImageOutputResourceAmi

Set of objects with each Amazon Machine Image (AMI) created.

amis List<GetImageOutputResourceAmi>

Set of objects with each Amazon Machine Image (AMI) created.

amis GetImageOutputResourceAmi[]

Set of objects with each Amazon Machine Image (AMI) created.

amis Sequence[GetImageOutputResourceAmi]

Set of objects with each Amazon Machine Image (AMI) created.

amis List<Property Map>

Set of objects with each Amazon Machine Image (AMI) created.

GetImageOutputResourceAmi

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 AMI.

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 AMI.

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 AMI.

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 AMI.

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 AMI.

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 AMI.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.