AWS Classic

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

getContainerRecipe

Provides details about an Image builder Container Recipe.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.ImageBuilder.GetContainerRecipe.InvokeAsync(new Aws.ImageBuilder.GetContainerRecipeArgs
        {
            Arn = "arn:aws:imagebuilder:us-east-1:aws:container-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.LookupContainerRecipe(ctx, &imagebuilder.LookupContainerRecipeArgs{
			Arn: "arn:aws:imagebuilder:us-east-1:aws:container-recipe/example/1.0.0",
		}, 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.getContainerRecipe(GetContainerRecipeArgs.builder()
            .arn("arn:aws:imagebuilder:us-east-1:aws:container-recipe/example/1.0.0")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.get_container_recipe(arn="arn:aws:imagebuilder:us-east-1:aws:container-recipe/example/1.0.0")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.imagebuilder.getContainerRecipe({
    arn: "arn:aws:imagebuilder:us-east-1:aws:container-recipe/example/1.0.0",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:imagebuilder:getContainerRecipe
      Arguments:
        arn: arn:aws:imagebuilder:us-east-1:aws:container-recipe/example/1.0.0

Using getContainerRecipe

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 getContainerRecipe(args: GetContainerRecipeArgs, opts?: InvokeOptions): Promise<GetContainerRecipeResult>
function getContainerRecipeOutput(args: GetContainerRecipeOutputArgs, opts?: InvokeOptions): Output<GetContainerRecipeResult>
def get_container_recipe(arn: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetContainerRecipeResult
def get_container_recipe_output(arn: Optional[pulumi.Input[str]] = None,
                         tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetContainerRecipeResult]
func LookupContainerRecipe(ctx *Context, args *LookupContainerRecipeArgs, opts ...InvokeOption) (*LookupContainerRecipeResult, error)
func LookupContainerRecipeOutput(ctx *Context, args *LookupContainerRecipeOutputArgs, opts ...InvokeOption) LookupContainerRecipeResultOutput

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

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

The following arguments are supported:

Arn string

Amazon Resource Name (ARN) of the container recipe.

Tags Dictionary<string, string>

Key-value map of resource tags for the container recipe.

Arn string

Amazon Resource Name (ARN) of the container recipe.

Tags map[string]string

Key-value map of resource tags for the container recipe.

arn String

Amazon Resource Name (ARN) of the container recipe.

tags Map<String,String>

Key-value map of resource tags for the container recipe.

arn string

Amazon Resource Name (ARN) of the container recipe.

tags {[key: string]: string}

Key-value map of resource tags for the container recipe.

arn str

Amazon Resource Name (ARN) of the container recipe.

tags Mapping[str, str]

Key-value map of resource tags for the container recipe.

arn String

Amazon Resource Name (ARN) of the container recipe.

tags Map<String>

Key-value map of resource tags for the container recipe.

getContainerRecipe Result

The following output properties are available:

Arn string
Components List<GetContainerRecipeComponent>

List of objects with components for the container recipe.

ContainerType string

Type of the container.

DateCreated string

Date the container recipe was created.

Description string

Description of the container recipe.

DockerfileTemplateData string

Dockerfile template used to build the image.

Encrypted bool

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

Id string

The provider-assigned unique ID for this managed resource.

InstanceConfigurations List<GetContainerRecipeInstanceConfiguration>

List of objects with instance configurations for building and testing container images.

KmsKeyId string

KMS key used to encrypt the container image.

Name string

Name of the container recipe.

Owner string

Owner of the container recipe.

ParentImage string

Base image for the container recipe.

Platform string

Platform of the container recipe.

TargetRepositories List<GetContainerRecipeTargetRepository>

Destination repository for the container image.

Version string

Version of the container recipe.

WorkingDirectory string

The working directory used during build and test workflows.

Tags Dictionary<string, string>

Key-value map of resource tags for the container recipe.

Arn string
Components []GetContainerRecipeComponent

List of objects with components for the container recipe.

ContainerType string

Type of the container.

DateCreated string

Date the container recipe was created.

Description string

Description of the container recipe.

DockerfileTemplateData string

Dockerfile template used to build the image.

Encrypted bool

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

Id string

The provider-assigned unique ID for this managed resource.

InstanceConfigurations []GetContainerRecipeInstanceConfiguration

List of objects with instance configurations for building and testing container images.

KmsKeyId string

KMS key used to encrypt the container image.

Name string

Name of the container recipe.

Owner string

Owner of the container recipe.

ParentImage string

Base image for the container recipe.

Platform string

Platform of the container recipe.

TargetRepositories []GetContainerRecipeTargetRepository

Destination repository for the container image.

Version string

Version of the container recipe.

WorkingDirectory string

The working directory used during build and test workflows.

Tags map[string]string

Key-value map of resource tags for the container recipe.

arn String
components List<GetContainerRecipeComponent>

List of objects with components for the container recipe.

containerType String

Type of the container.

dateCreated String

Date the container recipe was created.

description String

Description of the container recipe.

dockerfileTemplateData String

Dockerfile template used to build the image.

encrypted Boolean

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

id String

The provider-assigned unique ID for this managed resource.

instanceConfigurations List<GetContainerRecipeInstanceConfiguration>

List of objects with instance configurations for building and testing container images.

kmsKeyId String

KMS key used to encrypt the container image.

name String

Name of the container recipe.

owner String

Owner of the container recipe.

parentImage String

Base image for the container recipe.

platform String

Platform of the container recipe.

targetRepositories List<GetContainerRecipeTargetRepository>

Destination repository for the container image.

version String

Version of the container recipe.

workingDirectory String

The working directory used during build and test workflows.

tags Map<String,String>

Key-value map of resource tags for the container recipe.

arn string
components GetContainerRecipeComponent[]

List of objects with components for the container recipe.

containerType string

Type of the container.

dateCreated string

Date the container recipe was created.

description string

Description of the container recipe.

dockerfileTemplateData string

Dockerfile template used to build the image.

encrypted boolean

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

id string

The provider-assigned unique ID for this managed resource.

instanceConfigurations GetContainerRecipeInstanceConfiguration[]

List of objects with instance configurations for building and testing container images.

kmsKeyId string

KMS key used to encrypt the container image.

name string

Name of the container recipe.

owner string

Owner of the container recipe.

parentImage string

Base image for the container recipe.

platform string

Platform of the container recipe.

targetRepositories GetContainerRecipeTargetRepository[]

Destination repository for the container image.

version string

Version of the container recipe.

workingDirectory string

The working directory used during build and test workflows.

tags {[key: string]: string}

Key-value map of resource tags for the container recipe.

arn str
components Sequence[GetContainerRecipeComponent]

List of objects with components for the container recipe.

container_type str

Type of the container.

date_created str

Date the container recipe was created.

description str

Description of the container recipe.

dockerfile_template_data str

Dockerfile template used to build the image.

encrypted bool

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

id str

The provider-assigned unique ID for this managed resource.

instance_configurations Sequence[GetContainerRecipeInstanceConfiguration]

List of objects with instance configurations for building and testing container images.

kms_key_id str

KMS key used to encrypt the container image.

name str

Name of the container recipe.

owner str

Owner of the container recipe.

parent_image str

Base image for the container recipe.

platform str

Platform of the container recipe.

target_repositories Sequence[GetContainerRecipeTargetRepository]

Destination repository for the container image.

version str

Version of the container recipe.

working_directory str

The working directory used during build and test workflows.

tags Mapping[str, str]

Key-value map of resource tags for the container recipe.

arn String
components List<Property Map>

List of objects with components for the container recipe.

containerType String

Type of the container.

dateCreated String

Date the container recipe was created.

description String

Description of the container recipe.

dockerfileTemplateData String

Dockerfile template used to build the image.

encrypted Boolean

Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image.

id String

The provider-assigned unique ID for this managed resource.

instanceConfigurations List<Property Map>

List of objects with instance configurations for building and testing container images.

kmsKeyId String

KMS key used to encrypt the container image.

name String

Name of the container recipe.

owner String

Owner of the container recipe.

parentImage String

Base image for the container recipe.

platform String

Platform of the container recipe.

targetRepositories List<Property Map>

Destination repository for the container image.

version String

Version of the container recipe.

workingDirectory String

The working directory used during build and test workflows.

tags Map<String>

Key-value map of resource tags for the container recipe.

Supporting Types

GetContainerRecipeComponent

ComponentArn string

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

Parameters List<GetContainerRecipeComponentParameter>

Set of parameters that are used to configure the component.

ComponentArn string

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

Parameters []GetContainerRecipeComponentParameter

Set of parameters that are used to configure the component.

componentArn String

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

parameters List<GetContainerRecipeComponentParameter>

Set of parameters that are used to configure the component.

componentArn string

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

parameters GetContainerRecipeComponentParameter[]

Set of parameters that are used to configure the component.

component_arn str

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

parameters Sequence[GetContainerRecipeComponentParameter]

Set of parameters that are used to configure the component.

componentArn String

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

parameters List<Property Map>

Set of parameters that are used to configure the component.

GetContainerRecipeComponentParameter

Name string

Name of the container recipe.

Value string

Value of the component parameter.

Name string

Name of the container recipe.

Value string

Value of the component parameter.

name String

Name of the container recipe.

value String

Value of the component parameter.

name string

Name of the container recipe.

value string

Value of the component parameter.

name str

Name of the container recipe.

value str

Value of the component parameter.

name String

Name of the container recipe.

value String

Value of the component parameter.

GetContainerRecipeInstanceConfiguration

BlockDeviceMappings List<GetContainerRecipeInstanceConfigurationBlockDeviceMapping>

Set of objects with block device mappings for the instance configuration.

Image string

AMI ID of the base image for container build and test instance.

BlockDeviceMappings []GetContainerRecipeInstanceConfigurationBlockDeviceMapping

Set of objects with block device mappings for the instance configuration.

Image string

AMI ID of the base image for container build and test instance.

blockDeviceMappings List<GetContainerRecipeInstanceConfigurationBlockDeviceMapping>

Set of objects with block device mappings for the instance configuration.

image String

AMI ID of the base image for container build and test instance.

blockDeviceMappings GetContainerRecipeInstanceConfigurationBlockDeviceMapping[]

Set of objects with block device mappings for the instance configuration.

image string

AMI ID of the base image for container build and test instance.

block_device_mappings Sequence[GetContainerRecipeInstanceConfigurationBlockDeviceMapping]

Set of objects with block device mappings for the instance configuration.

image str

AMI ID of the base image for container build and test instance.

blockDeviceMappings List<Property Map>

Set of objects with block device mappings for the instance configuration.

image String

AMI ID of the base image for container build and test instance.

GetContainerRecipeInstanceConfigurationBlockDeviceMapping

DeviceName string

Name of the device. For example, /dev/sda or /dev/xvdb.

Ebs List<GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb>

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 []GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb

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<GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb>

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 GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb[]

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[GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb]

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.

GetContainerRecipeInstanceConfigurationBlockDeviceMappingEb

DeleteOnTermination bool

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 or io2 volume.

KmsKeyId string

KMS key used to encrypt the container image.

SnapshotId string

Identifier of the EC2 Volume Snapshot.

VolumeSize int

Size of the volume, in GiB.

VolumeType string

Type of the volume. For example, gp2 or io2.

DeleteOnTermination bool

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 or io2 volume.

KmsKeyId string

KMS key used to encrypt the container image.

SnapshotId string

Identifier of the EC2 Volume Snapshot.

VolumeSize int

Size of the volume, in GiB.

VolumeType string

Type of the volume. For example, gp2 or io2.

deleteOnTermination Boolean

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 or io2 volume.

kmsKeyId String

KMS key used to encrypt the container image.

snapshotId String

Identifier of the EC2 Volume Snapshot.

volumeSize Integer

Size of the volume, in GiB.

volumeType String

Type of the volume. For example, gp2 or io2.

deleteOnTermination boolean

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 or io2 volume.

kmsKeyId string

KMS key used to encrypt the container image.

snapshotId string

Identifier of the EC2 Volume Snapshot.

volumeSize number

Size of the volume, in GiB.

volumeType string

Type of the volume. For example, gp2 or io2.

delete_on_termination bool

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 or io2 volume.

kms_key_id str

KMS key used to encrypt the container image.

snapshot_id str

Identifier of the EC2 Volume Snapshot.

volume_size int

Size of the volume, in GiB.

volume_type str

Type of the volume. For example, gp2 or io2.

deleteOnTermination Boolean

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 or io2 volume.

kmsKeyId String

KMS key used to encrypt the container image.

snapshotId String

Identifier of the EC2 Volume Snapshot.

volumeSize Number

Size of the volume, in GiB.

volumeType String

Type of the volume. For example, gp2 or io2.

GetContainerRecipeTargetRepository

RepositoryName string

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

Service string

Service in which this image is registered.

RepositoryName string

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

Service string

Service in which this image is registered.

repositoryName String

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

service String

Service in which this image is registered.

repositoryName string

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

service string

Service in which this image is registered.

repository_name str

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

service str

Service in which this image is registered.

repositoryName String

Name of the container repository where the output container image is stored. The name is prefixed by the repository location.

service String

Service in which this image is registered.

Package Details

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

This Pulumi package is based on the aws Terraform Provider.