Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. imagebuilder
  5. ContainerRecipe

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.imagebuilder.ContainerRecipe

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    Manages an Image Builder Container Recipe.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ImageBuilder.ContainerRecipe("example", new()
    {
        Version = "1.0.0",
        ContainerType = "DOCKER",
        ParentImage = "arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x",
        TargetRepository = new Aws.ImageBuilder.Inputs.ContainerRecipeTargetRepositoryArgs
        {
            RepositoryName = aws_ecr_repository.Example.Name,
            Service = "ECR",
        },
        Components = new[]
        {
            new Aws.ImageBuilder.Inputs.ContainerRecipeComponentArgs
            {
                ComponentArn = aws_imagebuilder_component.Example.Arn,
                Parameters = new[]
                {
                    new Aws.ImageBuilder.Inputs.ContainerRecipeComponentParameterArgs
                    {
                        Name = "Parameter1",
                        Value = "Value1",
                    },
                    new Aws.ImageBuilder.Inputs.ContainerRecipeComponentParameterArgs
                    {
                        Name = "Parameter2",
                        Value = "Value2",
                    },
                },
            },
        },
        DockerfileTemplateData = @"FROM {{{ imagebuilder:parentImage }}}
{{{ imagebuilder:environments }}}
{{{ imagebuilder:components }}}
",
    });

});

    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.NewContainerRecipe(ctx, "example", &imagebuilder.ContainerRecipeArgs{
			Version:       pulumi.String("1.0.0"),
			ContainerType: pulumi.String("DOCKER"),
			ParentImage:   pulumi.String("arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x"),
			TargetRepository: &imagebuilder.ContainerRecipeTargetRepositoryArgs{
				RepositoryName: pulumi.Any(aws_ecr_repository.Example.Name),
				Service:        pulumi.String("ECR"),
			},
			Components: imagebuilder.ContainerRecipeComponentArray{
				&imagebuilder.ContainerRecipeComponentArgs{
					ComponentArn: pulumi.Any(aws_imagebuilder_component.Example.Arn),
					Parameters: imagebuilder.ContainerRecipeComponentParameterArray{
						&imagebuilder.ContainerRecipeComponentParameterArgs{
							Name:  pulumi.String("Parameter1"),
							Value: pulumi.String("Value1"),
						},
						&imagebuilder.ContainerRecipeComponentParameterArgs{
							Name:  pulumi.String("Parameter2"),
							Value: pulumi.String("Value2"),
						},
					},
				},
			},
			DockerfileTemplateData: pulumi.String("FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n"),
		})
		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.ContainerRecipe;
import com.pulumi.aws.imagebuilder.ContainerRecipeArgs;
import com.pulumi.aws.imagebuilder.inputs.ContainerRecipeTargetRepositoryArgs;
import com.pulumi.aws.imagebuilder.inputs.ContainerRecipeComponentArgs;
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) {
        var example = new ContainerRecipe("example", ContainerRecipeArgs.builder()        
            .version("1.0.0")
            .containerType("DOCKER")
            .parentImage("arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x")
            .targetRepository(ContainerRecipeTargetRepositoryArgs.builder()
                .repositoryName(aws_ecr_repository.example().name())
                .service("ECR")
                .build())
            .components(ContainerRecipeComponentArgs.builder()
                .componentArn(aws_imagebuilder_component.example().arn())
                .parameters(                
                    ContainerRecipeComponentParameterArgs.builder()
                        .name("Parameter1")
                        .value("Value1")
                        .build(),
                    ContainerRecipeComponentParameterArgs.builder()
                        .name("Parameter2")
                        .value("Value2")
                        .build())
                .build())
            .dockerfileTemplateData("""
FROM {{{ imagebuilder:parentImage }}}
{{{ imagebuilder:environments }}}
{{{ imagebuilder:components }}}
            """)
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.ContainerRecipe("example",
    version="1.0.0",
    container_type="DOCKER",
    parent_image="arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x",
    target_repository=aws.imagebuilder.ContainerRecipeTargetRepositoryArgs(
        repository_name=aws_ecr_repository["example"]["name"],
        service="ECR",
    ),
    components=[aws.imagebuilder.ContainerRecipeComponentArgs(
        component_arn=aws_imagebuilder_component["example"]["arn"],
        parameters=[
            aws.imagebuilder.ContainerRecipeComponentParameterArgs(
                name="Parameter1",
                value="Value1",
            ),
            aws.imagebuilder.ContainerRecipeComponentParameterArgs(
                name="Parameter2",
                value="Value2",
            ),
        ],
    )],
    dockerfile_template_data="""FROM {{{ imagebuilder:parentImage }}}
{{{ imagebuilder:environments }}}
{{{ imagebuilder:components }}}
""")

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

const example = new aws.imagebuilder.ContainerRecipe("example", {
    version: "1.0.0",
    containerType: "DOCKER",
    parentImage: "arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x",
    targetRepository: {
        repositoryName: aws_ecr_repository.example.name,
        service: "ECR",
    },
    components: [{
        componentArn: aws_imagebuilder_component.example.arn,
        parameters: [
            {
                name: "Parameter1",
                value: "Value1",
            },
            {
                name: "Parameter2",
                value: "Value2",
            },
        ],
    }],
    dockerfileTemplateData: `FROM {{{ imagebuilder:parentImage }}}
{{{ imagebuilder:environments }}}
{{{ imagebuilder:components }}}
`,
});

    resources:
  example:
    type: aws:imagebuilder:ContainerRecipe
    properties:
      version: 1.0.0
      containerType: DOCKER
      parentImage: arn:aws:imagebuilder:eu-central-1:aws:image/amazon-linux-x86-latest/x.x.x
      targetRepository:
        repositoryName: ${aws_ecr_repository.example.name}
        service: ECR
      components:
        - componentArn: ${aws_imagebuilder_component.example.arn}
          parameters:
            - name: Parameter1
              value: Value1
            - name: Parameter2
              value: Value2
      dockerfileTemplateData: |
        FROM {{{ imagebuilder:parentImage }}}
        {{{ imagebuilder:environments }}}
        {{{ imagebuilder:components }}}

    Create ContainerRecipe Resource

    new ContainerRecipe(name: string, args: ContainerRecipeArgs, opts?: CustomResourceOptions);
    @overload
def ContainerRecipe(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    components: Optional[Sequence[ContainerRecipeComponentArgs]] = None,
                    container_type: Optional[str] = None,
                    description: Optional[str] = None,
                    dockerfile_template_data: Optional[str] = None,
                    dockerfile_template_uri: Optional[str] = None,
                    instance_configuration: Optional[ContainerRecipeInstanceConfigurationArgs] = None,
                    kms_key_id: Optional[str] = None,
                    name: Optional[str] = None,
                    parent_image: Optional[str] = None,
                    platform_override: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    target_repository: Optional[ContainerRecipeTargetRepositoryArgs] = None,
                    version: Optional[str] = None,
                    working_directory: Optional[str] = None)
@overload
def ContainerRecipe(resource_name: str,
                    args: ContainerRecipeArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewContainerRecipe(ctx *Context, name string, args ContainerRecipeArgs, opts ...ResourceOption) (*ContainerRecipe, error)
    public ContainerRecipe(string name, ContainerRecipeArgs args, CustomResourceOptions? opts = null)
    public ContainerRecipe(String name, ContainerRecipeArgs args)
public ContainerRecipe(String name, ContainerRecipeArgs args, CustomResourceOptions options)

    type: aws:imagebuilder:ContainerRecipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerRecipeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ContainerRecipeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ContainerRecipeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerRecipeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContainerRecipeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ContainerRecipe Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ContainerRecipe resource accepts the following input properties:

    Components List<ContainerRecipeComponent>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    ContainerType string

    The type of the container to create. Valid values: DOCKER.

    ParentImage string

    The base image for the container recipe.

    TargetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    Version string

    Version of the container recipe.

    The following attributes are optional:

    Description string

    The description of the container recipe.

    DockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    DockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    InstanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    KmsKeyId string

    The KMS key used to encrypt the container image.

    Name string

    The name of the container recipe.

    PlatformOverride string

    Specifies the operating system platform when you use a custom base image.

    Tags Dictionary<string, string>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    WorkingDirectory string

    The working directory to be used during build and test workflows.

    Components []ContainerRecipeComponentArgs

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    ContainerType string

    The type of the container to create. Valid values: DOCKER.

    ParentImage string

    The base image for the container recipe.

    TargetRepository ContainerRecipeTargetRepositoryArgs

    The destination repository for the container image. Detailed below.

    Version string

    Version of the container recipe.

    The following attributes are optional:

    Description string

    The description of the container recipe.

    DockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    DockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    InstanceConfiguration ContainerRecipeInstanceConfigurationArgs

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    KmsKeyId string

    The KMS key used to encrypt the container image.

    Name string

    The name of the container recipe.

    PlatformOverride string

    Specifies the operating system platform when you use a custom base image.

    Tags map[string]string

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    WorkingDirectory string

    The working directory to be used during build and test workflows.

    components List<ContainerRecipeComponent>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType String

    The type of the container to create. Valid values: DOCKER.

    parentImage String

    The base image for the container recipe.

    targetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    version String

    Version of the container recipe.

    The following attributes are optional:

    description String

    The description of the container recipe.

    dockerfileTemplateData String

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri String

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    instanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId String

    The KMS key used to encrypt the container image.

    name String

    The name of the container recipe.

    platformOverride String

    Specifies the operating system platform when you use a custom base image.

    tags Map<String,String>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    workingDirectory String

    The working directory to be used during build and test workflows.

    components ContainerRecipeComponent[]

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType string

    The type of the container to create. Valid values: DOCKER.

    parentImage string

    The base image for the container recipe.

    targetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    version string

    Version of the container recipe.

    The following attributes are optional:

    description string

    The description of the container recipe.

    dockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    instanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId string

    The KMS key used to encrypt the container image.

    name string

    The name of the container recipe.

    platformOverride string

    Specifies the operating system platform when you use a custom base image.

    tags {[key: string]: string}

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    workingDirectory string

    The working directory to be used during build and test workflows.

    components Sequence[ContainerRecipeComponentArgs]

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    container_type str

    The type of the container to create. Valid values: DOCKER.

    parent_image str

    The base image for the container recipe.

    target_repository ContainerRecipeTargetRepositoryArgs

    The destination repository for the container image. Detailed below.

    version str

    Version of the container recipe.

    The following attributes are optional:

    description str

    The description of the container recipe.

    dockerfile_template_data str

    The Dockerfile template used to build the image as an inline data blob.

    dockerfile_template_uri str

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    instance_configuration ContainerRecipeInstanceConfigurationArgs

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kms_key_id str

    The KMS key used to encrypt the container image.

    name str

    The name of the container recipe.

    platform_override str

    Specifies the operating system platform when you use a custom base image.

    tags Mapping[str, str]

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    working_directory str

    The working directory to be used during build and test workflows.

    components List<Property Map>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType String

    The type of the container to create. Valid values: DOCKER.

    parentImage String

    The base image for the container recipe.

    targetRepository Property Map

    The destination repository for the container image. Detailed below.

    version String

    Version of the container recipe.

    The following attributes are optional:

    description String

    The description of the container recipe.

    dockerfileTemplateData String

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri String

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    instanceConfiguration Property Map

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId String

    The KMS key used to encrypt the container image.

    name String

    The name of the container recipe.

    platformOverride String

    Specifies the operating system platform when you use a custom base image.

    tags Map<String>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    workingDirectory String

    The working directory to be used during build and test workflows.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ContainerRecipe resource produces the following output properties:

    Arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    DateCreated string

    Date the container recipe was created.

    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.

    Owner string

    Owner of the container recipe.

    Platform string

    Platform of the container recipe.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    DateCreated string

    Date the container recipe was created.

    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.

    Owner string

    Owner of the container recipe.

    Platform string

    Platform of the container recipe.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    (Required) Amazon Resource Name (ARN) of the container recipe.

    dateCreated String

    Date the container recipe was created.

    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.

    owner String

    Owner of the container recipe.

    platform String

    Platform of the container recipe.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    dateCreated string

    Date the container recipe was created.

    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.

    owner string

    Owner of the container recipe.

    platform string

    Platform of the container recipe.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    (Required) Amazon Resource Name (ARN) of the container recipe.

    date_created str

    Date the container recipe was created.

    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.

    owner str

    Owner of the container recipe.

    platform str

    Platform of the container recipe.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    (Required) Amazon Resource Name (ARN) of the container recipe.

    dateCreated String

    Date the container recipe was created.

    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.

    owner String

    Owner of the container recipe.

    platform String

    Platform of the container recipe.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing ContainerRecipe Resource

    Get an existing ContainerRecipe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ContainerRecipeState, opts?: CustomResourceOptions): ContainerRecipe
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        components: Optional[Sequence[ContainerRecipeComponentArgs]] = None,
        container_type: Optional[str] = None,
        date_created: Optional[str] = None,
        description: Optional[str] = None,
        dockerfile_template_data: Optional[str] = None,
        dockerfile_template_uri: Optional[str] = None,
        encrypted: Optional[bool] = None,
        instance_configuration: Optional[ContainerRecipeInstanceConfigurationArgs] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        parent_image: Optional[str] = None,
        platform: Optional[str] = None,
        platform_override: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_repository: Optional[ContainerRecipeTargetRepositoryArgs] = None,
        version: Optional[str] = None,
        working_directory: Optional[str] = None) -> ContainerRecipe
    func GetContainerRecipe(ctx *Context, name string, id IDInput, state *ContainerRecipeState, opts ...ResourceOption) (*ContainerRecipe, error)
    public static ContainerRecipe Get(string name, Input<string> id, ContainerRecipeState? state, CustomResourceOptions? opts = null)
    public static ContainerRecipe get(String name, Output<String> id, ContainerRecipeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    Components List<ContainerRecipeComponent>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    ContainerType string

    The type of the container to create. Valid values: DOCKER.

    DateCreated string

    Date the container recipe was created.

    Description string

    The description of the container recipe.

    DockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    DockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    Encrypted bool

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

    InstanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    KmsKeyId string

    The KMS key used to encrypt the container image.

    Name string

    The name of the container recipe.

    Owner string

    Owner of the container recipe.

    ParentImage string

    The base image for the container recipe.

    Platform string

    Platform of the container recipe.

    PlatformOverride string

    Specifies the operating system platform when you use a custom base image.

    Tags Dictionary<string, string>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    TargetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    Version string

    Version of the container recipe.

    The following attributes are optional:

    WorkingDirectory string

    The working directory to be used during build and test workflows.

    Arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    Components []ContainerRecipeComponentArgs

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    ContainerType string

    The type of the container to create. Valid values: DOCKER.

    DateCreated string

    Date the container recipe was created.

    Description string

    The description of the container recipe.

    DockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    DockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    Encrypted bool

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

    InstanceConfiguration ContainerRecipeInstanceConfigurationArgs

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    KmsKeyId string

    The KMS key used to encrypt the container image.

    Name string

    The name of the container recipe.

    Owner string

    Owner of the container recipe.

    ParentImage string

    The base image for the container recipe.

    Platform string

    Platform of the container recipe.

    PlatformOverride string

    Specifies the operating system platform when you use a custom base image.

    Tags map[string]string

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    TargetRepository ContainerRecipeTargetRepositoryArgs

    The destination repository for the container image. Detailed below.

    Version string

    Version of the container recipe.

    The following attributes are optional:

    WorkingDirectory string

    The working directory to be used during build and test workflows.

    arn String

    (Required) Amazon Resource Name (ARN) of the container recipe.

    components List<ContainerRecipeComponent>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType String

    The type of the container to create. Valid values: DOCKER.

    dateCreated String

    Date the container recipe was created.

    description String

    The description of the container recipe.

    dockerfileTemplateData String

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri String

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    encrypted Boolean

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

    instanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId String

    The KMS key used to encrypt the container image.

    name String

    The name of the container recipe.

    owner String

    Owner of the container recipe.

    parentImage String

    The base image for the container recipe.

    platform String

    Platform of the container recipe.

    platformOverride String

    Specifies the operating system platform when you use a custom base image.

    tags Map<String,String>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    targetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    version String

    Version of the container recipe.

    The following attributes are optional:

    workingDirectory String

    The working directory to be used during build and test workflows.

    arn string

    (Required) Amazon Resource Name (ARN) of the container recipe.

    components ContainerRecipeComponent[]

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType string

    The type of the container to create. Valid values: DOCKER.

    dateCreated string

    Date the container recipe was created.

    description string

    The description of the container recipe.

    dockerfileTemplateData string

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri string

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    encrypted boolean

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

    instanceConfiguration ContainerRecipeInstanceConfiguration

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId string

    The KMS key used to encrypt the container image.

    name string

    The name of the container recipe.

    owner string

    Owner of the container recipe.

    parentImage string

    The base image for the container recipe.

    platform string

    Platform of the container recipe.

    platformOverride string

    Specifies the operating system platform when you use a custom base image.

    tags {[key: string]: string}

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    targetRepository ContainerRecipeTargetRepository

    The destination repository for the container image. Detailed below.

    version string

    Version of the container recipe.

    The following attributes are optional:

    workingDirectory string

    The working directory to be used during build and test workflows.

    arn str

    (Required) Amazon Resource Name (ARN) of the container recipe.

    components Sequence[ContainerRecipeComponentArgs]

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    container_type str

    The type of the container to create. Valid values: DOCKER.

    date_created str

    Date the container recipe was created.

    description str

    The description of the container recipe.

    dockerfile_template_data str

    The Dockerfile template used to build the image as an inline data blob.

    dockerfile_template_uri str

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    encrypted bool

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

    instance_configuration ContainerRecipeInstanceConfigurationArgs

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kms_key_id str

    The KMS key used to encrypt the container image.

    name str

    The name of the container recipe.

    owner str

    Owner of the container recipe.

    parent_image str

    The base image for the container recipe.

    platform str

    Platform of the container recipe.

    platform_override str

    Specifies the operating system platform when you use a custom base image.

    tags Mapping[str, str]

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    target_repository ContainerRecipeTargetRepositoryArgs

    The destination repository for the container image. Detailed below.

    version str

    Version of the container recipe.

    The following attributes are optional:

    working_directory str

    The working directory to be used during build and test workflows.

    arn String

    (Required) Amazon Resource Name (ARN) of the container recipe.

    components List<Property Map>

    Ordered configuration block(s) with components for the container recipe. Detailed below.

    containerType String

    The type of the container to create. Valid values: DOCKER.

    dateCreated String

    Date the container recipe was created.

    description String

    The description of the container recipe.

    dockerfileTemplateData String

    The Dockerfile template used to build the image as an inline data blob.

    dockerfileTemplateUri String

    The Amazon S3 URI for the Dockerfile that will be used to build the container image.

    encrypted Boolean

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

    instanceConfiguration Property Map

    Configuration block used to configure an instance for building and testing container images. Detailed below.

    kmsKeyId String

    The KMS key used to encrypt the container image.

    name String

    The name of the container recipe.

    owner String

    Owner of the container recipe.

    parentImage String

    The base image for the container recipe.

    platform String

    Platform of the container recipe.

    platformOverride String

    Specifies the operating system platform when you use a custom base image.

    tags Map<String>

    Key-value map of resource tags for the container recipe. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    targetRepository Property Map

    The destination repository for the container image. Detailed below.

    version String

    Version of the container recipe.

    The following attributes are optional:

    workingDirectory String

    The working directory to be used during build and test workflows.

    Supporting Types

    ContainerRecipeComponent, ContainerRecipeComponentArgs

    ComponentArn string

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

    Parameters List<ContainerRecipeComponentParameter>

    Configuration block(s) for parameters to configure the component. Detailed below.

    ComponentArn string

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

    Parameters []ContainerRecipeComponentParameter

    Configuration block(s) for parameters to configure the component. Detailed below.

    componentArn String

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

    parameters List<ContainerRecipeComponentParameter>

    Configuration block(s) for parameters to configure the component. Detailed below.

    componentArn string

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

    parameters ContainerRecipeComponentParameter[]

    Configuration block(s) for parameters to configure the component. Detailed below.

    component_arn str

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

    parameters Sequence[ContainerRecipeComponentParameter]

    Configuration block(s) for parameters to configure the component. Detailed below.

    componentArn String

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

    parameters List<Property Map>

    Configuration block(s) for parameters to configure the component. Detailed below.

    ContainerRecipeComponentParameter, ContainerRecipeComponentParameterArgs

    Name string

    The name of the component parameter.

    Value string

    The value for the named component parameter.

    Name string

    The name of the component parameter.

    Value string

    The value for the named component parameter.

    name String

    The name of the component parameter.

    value String

    The value for the named component parameter.

    name string

    The name of the component parameter.

    value string

    The value for the named component parameter.

    name str

    The name of the component parameter.

    value str

    The value for the named component parameter.

    name String

    The name of the component parameter.

    value String

    The value for the named component parameter.

    ContainerRecipeInstanceConfiguration, ContainerRecipeInstanceConfigurationArgs

    BlockDeviceMappings List<ContainerRecipeInstanceConfigurationBlockDeviceMapping>

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    Image string

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    BlockDeviceMappings []ContainerRecipeInstanceConfigurationBlockDeviceMapping

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    Image string

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    blockDeviceMappings List<ContainerRecipeInstanceConfigurationBlockDeviceMapping>

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    image String

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    blockDeviceMappings ContainerRecipeInstanceConfigurationBlockDeviceMapping[]

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    image string

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    block_device_mappings Sequence[ContainerRecipeInstanceConfigurationBlockDeviceMapping]

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    image str

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    blockDeviceMappings List<Property Map>

    Configuration block(s) with block device mappings for the container recipe. Detailed below.

    image String

    The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

    ContainerRecipeInstanceConfigurationBlockDeviceMapping, ContainerRecipeInstanceConfigurationBlockDeviceMappingArgs

    DeviceName string

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

    Ebs ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    NoDevice bool

    Set to true 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 ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    NoDevice bool

    Set to true 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 ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    noDevice Boolean

    Set to true 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 ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    noDevice boolean

    Set to true 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 ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    no_device bool

    Set to true 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 Property Map

    Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below.

    noDevice Boolean

    Set to true to remove a mapping from the parent image.

    virtualName String

    Virtual device name. For example, ephemeral0. Instance store volumes are numbered starting from 0.

    ContainerRecipeInstanceConfigurationBlockDeviceMappingEbs, ContainerRecipeInstanceConfigurationBlockDeviceMappingEbsArgs

    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

    Amazon Resource Name (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

    Amazon Resource Name (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

    Amazon Resource Name (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

    Amazon Resource Name (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

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

    Amazon Resource Name (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.

    ContainerRecipeTargetRepository, ContainerRecipeTargetRepositoryArgs

    RepositoryName string

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

    Service string

    The service in which this image is registered. Valid values: ECR.

    RepositoryName string

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

    Service string

    The service in which this image is registered. Valid values: ECR.

    repositoryName String

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

    service String

    The service in which this image is registered. Valid values: ECR.

    repositoryName string

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

    service string

    The service in which this image is registered. Valid values: ECR.

    repository_name str

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

    service str

    The service in which this image is registered. Valid values: ECR.

    repositoryName String

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

    service String

    The service in which this image is registered. Valid values: ECR.

    Import

    Using pulumi import, import aws_imagebuilder_container_recipe resources using the Amazon Resource Name (ARN). For example:

     $ pulumi import aws:imagebuilder/containerRecipe:ContainerRecipe example arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/example/1.0.0

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws