AWS v6.76.0, Apr 8 25

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.imagebuilder.getImageRecipe

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = aws.imagebuilder.getImageRecipe({
    arn: "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
});

import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.get_image_recipe(arn="arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0")

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.LookupImageRecipe(ctx, &imagebuilder.LookupImageRecipeArgs{
			Arn: "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
		}, nil)
		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 = Aws.ImageBuilder.GetImageRecipe.Invoke(new()
    {
        Arn = "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.ImagebuilderFunctions;
import com.pulumi.aws.imagebuilder.inputs.GetImageRecipeArgs;
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) {
        final var example = ImagebuilderFunctions.getImageRecipe(GetImageRecipeArgs.builder()
            .arn("arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:imagebuilder:getImageRecipe
      arguments:
        arn: arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0

Using getImageRecipe

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.

TypeScript
Python
Go
C#
Java
YAML

function getImageRecipe(args: GetImageRecipeArgs, opts?: InvokeOptions): Promise<GetImageRecipeResult>
function getImageRecipeOutput(args: GetImageRecipeOutputArgs, opts?: InvokeOptions): Output<GetImageRecipeResult>

def get_image_recipe(arn: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetImageRecipeResult
def get_image_recipe_output(arn: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetImageRecipeResult]

func LookupImageRecipe(ctx *Context, args *LookupImageRecipeArgs, opts ...InvokeOption) (*LookupImageRecipeResult, error)
func LookupImageRecipeOutput(ctx *Context, args *LookupImageRecipeOutputArgs, opts ...InvokeOption) LookupImageRecipeResultOutput

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

public static class GetImageRecipe 
{
    public static Task<GetImageRecipeResult> InvokeAsync(GetImageRecipeArgs args, InvokeOptions? opts = null)
    public static Output<GetImageRecipeResult> Invoke(GetImageRecipeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImageRecipeResult> getImageRecipe(GetImageRecipeArgs args, InvokeOptions options)
public static Output<GetImageRecipeResult> getImageRecipe(GetImageRecipeArgs args, InvokeOptions options)

fn::invoke:
  function: aws:imagebuilder/getImageRecipe:getImageRecipe
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: ARN of the image recipe.
Tags Dictionary<string, string>: Key-value map of resource tags for the image recipe.

Arn string: ARN of the image recipe.
Tags map[string]string: Key-value map of resource tags for the image recipe.

arn String: ARN of the image recipe.
tags Map<String,String>: Key-value map of resource tags for the image recipe.

arn string: ARN of the image recipe.
tags {[key: string]: string}: Key-value map of resource tags for the image recipe.

arn str: ARN of the image recipe.
tags Mapping[str, str]: Key-value map of resource tags for the image recipe.

arn String: ARN of the image recipe.
tags Map<String>: Key-value map of resource tags for the image recipe.

getImageRecipe Result

The following output properties are available:

Arn string
BlockDeviceMappings List<GetImageRecipeBlockDeviceMapping>: Set of objects with block device mappings for the image recipe.
Components List<GetImageRecipeComponent>: List of objects with components for the image recipe.
DateCreated string: Date the image recipe was created.
Description string: Description of the image recipe.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the image recipe.
Owner string: Owner of the image recipe.
ParentImage string: Base image of the image recipe.
Platform string: Platform of the image recipe.
Tags Dictionary<string, string>: Key-value map of resource tags for the image recipe.
UserDataBase64 string: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
Version string: Version of the image recipe.
WorkingDirectory string: Working directory used during build and test workflows.

Arn string
BlockDeviceMappings []GetImageRecipeBlockDeviceMapping: Set of objects with block device mappings for the image recipe.
Components []GetImageRecipeComponent: List of objects with components for the image recipe.
DateCreated string: Date the image recipe was created.
Description string: Description of the image recipe.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the image recipe.
Owner string: Owner of the image recipe.
ParentImage string: Base image of the image recipe.
Platform string: Platform of the image recipe.
Tags map[string]string: Key-value map of resource tags for the image recipe.
UserDataBase64 string: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
Version string: Version of the image recipe.
WorkingDirectory string: Working directory used during build and test workflows.

arn String
blockDeviceMappings List<GetImageRecipeBlockDeviceMapping>: Set of objects with block device mappings for the image recipe.
components List<GetImageRecipeComponent>: List of objects with components for the image recipe.
dateCreated String: Date the image recipe was created.
description String: Description of the image recipe.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the image recipe.
owner String: Owner of the image recipe.
parentImage String: Base image of the image recipe.
platform String: Platform of the image recipe.
tags Map<String,String>: Key-value map of resource tags for the image recipe.
userDataBase64 String: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
version String: Version of the image recipe.
workingDirectory String: Working directory used during build and test workflows.

arn string
blockDeviceMappings GetImageRecipeBlockDeviceMapping[]: Set of objects with block device mappings for the image recipe.
components GetImageRecipeComponent[]: List of objects with components for the image recipe.
dateCreated string: Date the image recipe was created.
description string: Description of the image recipe.
id string: The provider-assigned unique ID for this managed resource.
name string: Name of the image recipe.
owner string: Owner of the image recipe.
parentImage string: Base image of the image recipe.
platform string: Platform of the image recipe.
tags {[key: string]: string}: Key-value map of resource tags for the image recipe.
userDataBase64 string: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
version string: Version of the image recipe.
workingDirectory string: Working directory used during build and test workflows.

arn str
block_device_mappings Sequence[GetImageRecipeBlockDeviceMapping]: Set of objects with block device mappings for the image recipe.
components Sequence[GetImageRecipeComponent]: List of objects with components for the image recipe.
date_created str: Date the image recipe was created.
description str: Description of the image recipe.
id str: The provider-assigned unique ID for this managed resource.
name str: Name of the image recipe.
owner str: Owner of the image recipe.
parent_image str: Base image of the image recipe.
platform str: Platform of the image recipe.
tags Mapping[str, str]: Key-value map of resource tags for the image recipe.
user_data_base64 str: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
version str: Version of the image recipe.
working_directory str: Working directory used during build and test workflows.

arn String
blockDeviceMappings List<Property Map>: Set of objects with block device mappings for the image recipe.
components List<Property Map>: List of objects with components for the image recipe.
dateCreated String: Date the image recipe was created.
description String: Description of the image recipe.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the image recipe.
owner String: Owner of the image recipe.
parentImage String: Base image of the image recipe.
platform String: Platform of the image recipe.
tags Map<String>: Key-value map of resource tags for the image recipe.
userDataBase64 String: Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
version String: Version of the image recipe.
workingDirectory String: Working directory used during build and test workflows.

Supporting Types

GetImageRecipeBlockDeviceMapping

DeviceName string: Name of the device. For example, /dev/sda or /dev/xvdb.
Ebs List<GetImageRecipeBlockDeviceMappingEb>: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
NoDevice string: Whether to remove a mapping from the parent image.
VirtualName string: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

DeviceName string: Name of the device. For example, /dev/sda or /dev/xvdb.
Ebs []GetImageRecipeBlockDeviceMappingEb: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
NoDevice string: Whether to remove a mapping from the parent image.
VirtualName string: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

deviceName String: Name of the device. For example, /dev/sda or /dev/xvdb.
ebs List<GetImageRecipeBlockDeviceMappingEb>: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
noDevice String: Whether to remove a mapping from the parent image.
virtualName String: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

deviceName string: Name of the device. For example, /dev/sda or /dev/xvdb.
ebs GetImageRecipeBlockDeviceMappingEb[]: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
noDevice string: Whether to remove a mapping from the parent image.
virtualName string: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

device_name str: Name of the device. For example, /dev/sda or /dev/xvdb.
ebs Sequence[GetImageRecipeBlockDeviceMappingEb]: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
no_device str: Whether to remove a mapping from the parent image.
virtual_name str: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

deviceName String: Name of the device. For example, /dev/sda or /dev/xvdb.
ebs List<Property Map>: Single list of object with Elastic Block Storage (EBS) block device mapping settings.
noDevice String: Whether to remove a mapping from the parent image.
virtualName String: Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

GetImageRecipeBlockDeviceMappingEb

DeleteOnTermination string: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
Encrypted string: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
Iops int: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
KmsKeyId string: ARN of the Key Management Service (KMS) Key for encryption.
SnapshotId string: Identifier of the EC2 Volume Snapshot.
Throughput int: For GP3 volumes only. The throughput in MiB/s that the volume supports.
VolumeSize int: Size of the volume, in GiB.
VolumeType string: Type of the volume. For example, gp2 or io2.

DeleteOnTermination string: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
Encrypted string: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
Iops int: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
KmsKeyId string: ARN of the Key Management Service (KMS) Key for encryption.
SnapshotId string: Identifier of the EC2 Volume Snapshot.
Throughput int: For GP3 volumes only. The throughput in MiB/s that the volume supports.
VolumeSize int: Size of the volume, in GiB.
VolumeType string: Type of the volume. For example, gp2 or io2.

deleteOnTermination String: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
encrypted String: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
iops Integer: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
kmsKeyId String: ARN of the Key Management Service (KMS) Key for encryption.
snapshotId String: Identifier of the EC2 Volume Snapshot.
throughput Integer: For GP3 volumes only. The throughput in MiB/s that the volume supports.
volumeSize Integer: Size of the volume, in GiB.
volumeType String: Type of the volume. For example, gp2 or io2.

deleteOnTermination string: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
encrypted string: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
iops number: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
kmsKeyId string: ARN of the Key Management Service (KMS) Key for encryption.
snapshotId string: Identifier of the EC2 Volume Snapshot.
throughput number: For GP3 volumes only. The throughput in MiB/s that the volume supports.
volumeSize number: Size of the volume, in GiB.
volumeType string: Type of the volume. For example, gp2 or io2.

delete_on_termination str: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
encrypted str: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
iops int: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
kms_key_id str: ARN of the Key Management Service (KMS) Key for encryption.
snapshot_id str: Identifier of the EC2 Volume Snapshot.
throughput int: For GP3 volumes only. The throughput in MiB/s that the volume supports.
volume_size int: Size of the volume, in GiB.
volume_type str: Type of the volume. For example, gp2 or io2.

deleteOnTermination String: Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
encrypted String: Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.
iops Number: Number of Input/Output (I/O) operations per second to provision for an io1 or io2 volume.
kmsKeyId String: ARN of the Key Management Service (KMS) Key for encryption.
snapshotId String: Identifier of the EC2 Volume Snapshot.
throughput Number: For GP3 volumes only. The throughput in MiB/s that the volume supports.
volumeSize Number: Size of the volume, in GiB.
volumeType String: Type of the volume. For example, gp2 or io2.

GetImageRecipeComponent

ComponentArn string: ARN of the Image Builder Component.
Parameters List<GetImageRecipeComponentParameter>: Set of parameters that are used to configure the component.

ComponentArn string: ARN of the Image Builder Component.
Parameters []GetImageRecipeComponentParameter: Set of parameters that are used to configure the component.

componentArn String: ARN of the Image Builder Component.
parameters List<GetImageRecipeComponentParameter>: Set of parameters that are used to configure the component.

componentArn string: ARN of the Image Builder Component.
parameters GetImageRecipeComponentParameter[]: Set of parameters that are used to configure the component.

component_arn str: ARN of the Image Builder Component.
parameters Sequence[GetImageRecipeComponentParameter]: Set of parameters that are used to configure the component.

componentArn String: ARN of the Image Builder Component.
parameters List<Property Map>: Set of parameters that are used to configure the component.

GetImageRecipeComponentParameter

Name string: Name of the image recipe.
Value string: Value of the component parameter.

Name string: Name of the image recipe.
Value string: Value of the component parameter.

name String: Name of the image recipe.
value String: Value of the component parameter.

name string: Name of the image recipe.
value string: Value of the component parameter.

name str: Name of the image recipe.
value str: Value of the component parameter.

name String: Name of the image recipe.
value String: Value of the component parameter.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-aws

aws.imagebuilder.getImageRecipe

On this page

On this page

Example Usage

Using getImageRecipe

getImageRecipe Result

Supporting Types

GetImageRecipeBlockDeviceMapping

GetImageRecipeBlockDeviceMappingEb

GetImageRecipeComponent

GetImageRecipeComponentParameter

Package Details

On this page

On this page