AWS Classic
getImageRecipe
Provides details about an Image Builder Image Recipe.
Example Usage
using System.Collections.Generic;
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 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.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
})
}
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());
}
}
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")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = pulumi.output(aws.imagebuilder.getImageRecipe({
arn: "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
}));
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.
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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws:imagebuilder/getImageRecipe:getImageRecipe
Arguments:
# Arguments dictionary
The following arguments are supported:
- Arn string
Amazon Resource Name (ARN) of the image recipe.
- Dictionary<string, string>
Key-value map of resource tags for the image recipe.
- Arn string
Amazon Resource Name (ARN) of the image recipe.
- map[string]string
Key-value map of resource tags for the image recipe.
- arn String
Amazon Resource Name (ARN) of the image recipe.
- Map<String,String>
Key-value map of resource tags for the image recipe.
- arn string
Amazon Resource Name (ARN) of the image recipe.
- {[key: string]: string}
Key-value map of resource tags for the image recipe.
- arn str
Amazon Resource Name (ARN) of the image recipe.
- Mapping[str, str]
Key-value map of resource tags for the image recipe.
- arn String
Amazon Resource Name (ARN) of the image recipe.
- Map<String>
Key-value map of resource tags for the image recipe.
getImageRecipe Result
The following output properties are available:
- Arn string
- Block
Device List<GetMappings Image Recipe Block Device Mapping> Set of objects with block device mappings for the image recipe.
- Components
List<Get
Image Recipe Component> List of objects with components for the image recipe.
- Date
Created 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.
- Parent
Image string Base image of the image recipe.
- Platform string
Platform of the image recipe.
- User
Data stringBase64 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.
- Working
Directory string The working directory used during build and test workflows.
- Dictionary<string, string>
Key-value map of resource tags for the image recipe.
- Arn string
- Block
Device []GetMappings Image Recipe Block Device Mapping Set of objects with block device mappings for the image recipe.
- Components
[]Get
Image Recipe Component List of objects with components for the image recipe.
- Date
Created 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.
- Parent
Image string Base image of the image recipe.
- Platform string
Platform of the image recipe.
- User
Data stringBase64 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.
- Working
Directory string The working directory used during build and test workflows.
- map[string]string
Key-value map of resource tags for the image recipe.
- arn String
- block
Device List<GetMappings Image Recipe Block Device Mapping> Set of objects with block device mappings for the image recipe.
- components
List<Get
Image Recipe Component> List of objects with components for the image recipe.
- date
Created 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.
- parent
Image String Base image of the image recipe.
- platform String
Platform of the image recipe.
- user
Data StringBase64 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.
- working
Directory String The working directory used during build and test workflows.
- Map<String,String>
Key-value map of resource tags for the image recipe.
- arn string
- block
Device GetMappings Image Recipe Block Device Mapping[] Set of objects with block device mappings for the image recipe.
- components
Get
Image Recipe Component[] List of objects with components for the image recipe.
- date
Created 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.
- parent
Image string Base image of the image recipe.
- platform string
Platform of the image recipe.
- user
Data stringBase64 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.
- working
Directory string The working directory used during build and test workflows.
- {[key: string]: string}
Key-value map of resource tags for the image recipe.
- arn str
- block_
device_ Sequence[Getmappings Image Recipe Block Device Mapping] Set of objects with block device mappings for the image recipe.
- components
Sequence[Get
Image Recipe Component] 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.
- user_
data_ strbase64 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 The working directory used during build and test workflows.
- Mapping[str, str]
Key-value map of resource tags for the image recipe.
- arn String
- block
Device List<Property Map>Mappings Set of objects with block device mappings for the image recipe.
- components List<Property Map>
List of objects with components for the image recipe.
- date
Created 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.
- parent
Image String Base image of the image recipe.
- platform String
Platform of the image recipe.
- user
Data StringBase64 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.
- working
Directory String The working directory used during build and test workflows.
- Map<String>
Key-value map of resource tags for the image recipe.
Supporting Types
GetImageRecipeBlockDeviceMapping
- Device
Name string Name of the device. For example,
/dev/sda
or/dev/xvdb
.- Ebs
List<Get
Image Recipe Block Device Mapping Eb> Single list of object with Elastic Block Storage (EBS) block device mapping settings.
- No
Device string Whether to remove a mapping from the parent image.
- Virtual
Name string Virtual device name. For example,
ephemeral0
. Instance store volumes are numbered starting from 0.
- Device
Name string Name of the device. For example,
/dev/sda
or/dev/xvdb
.- Ebs
[]Get
Image Recipe Block Device Mapping Eb Single list of object with Elastic Block Storage (EBS) block device mapping settings.
- No
Device string Whether to remove a mapping from the parent image.
- Virtual
Name string Virtual device name. For example,
ephemeral0
. Instance store volumes are numbered starting from 0.
- device
Name String Name of the device. For example,
/dev/sda
or/dev/xvdb
.- ebs
List<Get
Image Recipe Block Device Mapping Eb> Single list of object with Elastic Block Storage (EBS) block device mapping settings.
- no
Device String Whether to remove a mapping from the parent image.
- virtual
Name String Virtual device name. For example,
ephemeral0
. Instance store volumes are numbered starting from 0.
- device
Name string Name of the device. For example,
/dev/sda
or/dev/xvdb
.- ebs
Get
Image Recipe Block Device Mapping Eb[] Single list of object with Elastic Block Storage (EBS) block device mapping settings.
- no
Device string Whether to remove a mapping from the parent image.
- virtual
Name 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[Get
Image Recipe Block Device Mapping Eb] 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.
- device
Name 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.
- no
Device String Whether to remove a mapping from the parent image.
- virtual
Name String Virtual device name. For example,
ephemeral0
. Instance store volumes are numbered starting from 0.
GetImageRecipeBlockDeviceMappingEb
- Delete
On boolTermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- Encrypted bool
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
orio2
volume.- Kms
Key stringId Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.
- Snapshot
Id string 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 string Type of the volume. For example,
gp2
orio2
.
- Delete
On boolTermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- Encrypted bool
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
orio2
volume.- Kms
Key stringId Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.
- Snapshot
Id string 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 string Type of the volume. For example,
gp2
orio2
.
- delete
On BooleanTermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- encrypted Boolean
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
orio2
volume.- kms
Key StringId Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.
- snapshot
Id String Identifier of the EC2 Volume Snapshot.
- throughput Integer
For GP3 volumes only. The throughput in MiB/s that the volume supports.
- volume
Size Integer Size of the volume, in GiB.
- volume
Type String Type of the volume. For example,
gp2
orio2
.
- delete
On booleanTermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- encrypted boolean
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
orio2
volume.- kms
Key stringId Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.
- snapshot
Id string Identifier of the EC2 Volume Snapshot.
- throughput number
For GP3 volumes only. The throughput in MiB/s that the volume supports.
- volume
Size number Size of the volume, in GiB.
- volume
Type string Type of the volume. For example,
gp2
orio2
.
- delete_
on_ booltermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- encrypted bool
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
orio2
volume.- kms_
key_ strid Amazon Resource Name (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
orio2
.
- delete
On BooleanTermination Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image.
- encrypted Boolean
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
orio2
volume.- kms
Key StringId Amazon Resource Name (ARN) of the Key Management Service (KMS) Key for encryption.
- snapshot
Id String Identifier of the EC2 Volume Snapshot.
- throughput Number
For GP3 volumes only. The throughput in MiB/s that the volume supports.
- volume
Size Number Size of the volume, in GiB.
- volume
Type String Type of the volume. For example,
gp2
orio2
.
GetImageRecipeComponent
- Component
Arn string Amazon Resource Name (ARN) of the Image Builder Component.
- Parameters
List<Get
Image Recipe Component Parameter> Set of parameters that are used to configure the component.
- Component
Arn string Amazon Resource Name (ARN) of the Image Builder Component.
- Parameters
[]Get
Image Recipe Component Parameter Set of parameters that are used to configure the component.
- component
Arn String Amazon Resource Name (ARN) of the Image Builder Component.
- parameters
List<Get
Image Recipe Component Parameter> Set of parameters that are used to configure the component.
- component
Arn string Amazon Resource Name (ARN) of the Image Builder Component.
- parameters
Get
Image Recipe Component Parameter[] Set of parameters that are used to configure the component.
- component_
arn str Amazon Resource Name (ARN) of the Image Builder Component.
- parameters
Sequence[Get
Image Recipe Component Parameter] Set of parameters that are used to configure the component.
- component
Arn String Amazon Resource Name (ARN) of the Image Builder Component.
- parameters List<Property Map>
Set of parameters that are used to configure the component.
GetImageRecipeComponentParameter
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.