pulumi-aws-kotlin/com.pulumi.aws.imagebuilder.kotlin/ImageRecipeArgs

ImageRecipeArgs

data class ImageRecipeArgs(val blockDeviceMappings: Output<List<ImageRecipeBlockDeviceMappingArgs>>? = null, val components: Output<List<ImageRecipeComponentArgs>>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val parentImage: Output<String>? = null, val systemsManagerAgent: Output<ImageRecipeSystemsManagerAgentArgs>? = null, val tags: Output<Map<String, String>>? = null, val userDataBase64: Output<String>? = null, val version: Output<String>? = null, val workingDirectory: Output<String>? = null) : ConvertibleToJava<ImageRecipeArgs>

Manages an Image Builder Image Recipe.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.ImageRecipe;
import com.pulumi.aws.imagebuilder.ImageRecipeArgs;
import com.pulumi.aws.imagebuilder.inputs.ImageRecipeBlockDeviceMappingArgs;
import com.pulumi.aws.imagebuilder.inputs.ImageRecipeBlockDeviceMappingEbsArgs;
import com.pulumi.aws.imagebuilder.inputs.ImageRecipeComponentArgs;
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 ImageRecipe("example", ImageRecipeArgs.builder()
            .blockDeviceMappings(ImageRecipeBlockDeviceMappingArgs.builder()
                .deviceName("/dev/xvdb")
                .ebs(ImageRecipeBlockDeviceMappingEbsArgs.builder()
                    .deleteOnTermination(true)
                    .volumeSize(100)
                    .volumeType("gp2")
                    .build())
                .build())
            .components(ImageRecipeComponentArgs.builder()
                .componentArn(aws_imagebuilder_component.example().arn())
                .parameters(
                    ImageRecipeComponentParameterArgs.builder()
                        .name("Parameter1")
                        .value("Value1")
                        .build(),
                    ImageRecipeComponentParameterArgs.builder()
                        .name("Parameter2")
                        .value("Value2")
                        .build())
                .build())
            .parentImage(String.format("arn:%s:imagebuilder:%s:aws:image/amazon-linux-2-x86/x.x.x", data.aws_partition().current().partition(),data.aws_region().current().name()))
            .version("1.0.0")
            .build());
    }
}
Content copied to clipboard

Import

aws_imagebuilder_image_recipe resources can be imported by using the Amazon Resource Name (ARN), e.g.,

$ pulumi import aws:imagebuilder/imageRecipe:ImageRecipe example arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/example/1.0.0
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(blockDeviceMappings: Output<List<ImageRecipeBlockDeviceMappingArgs>>? = null, components: Output<List<ImageRecipeComponentArgs>>? = null, description: Output<String>? = null, name: Output<String>? = null, parentImage: Output<String>? = null, systemsManagerAgent: Output<ImageRecipeSystemsManagerAgentArgs>? = null, tags: Output<Map<String, String>>? = null, userDataBase64: Output<String>? = null, version: Output<String>? = null, workingDirectory: Output<String>? = null)

Properties

Link copied to clipboard
val blockDeviceMappings: Output<List<ImageRecipeBlockDeviceMappingArgs>>? = null

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

Link copied to clipboard
val components: Output<List<ImageRecipeComponentArgs>>? = null

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

Link copied to clipboard
val description: Output<String>? = null

Description of the image recipe.

Link copied to clipboard
val name: Output<String>? = null

Name of the image recipe.

Link copied to clipboard
val parentImage: Output<String>? = null

The image recipe uses this image as a base from which to build your customized image. The value can be the base image ARN or an AMI ID.

Link copied to clipboard
val systemsManagerAgent: Output<ImageRecipeSystemsManagerAgentArgs>? = null

Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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

Link copied to clipboard
val userDataBase64: Output<String>? = null

Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance.

Link copied to clipboard
val version: Output<String>? = null

The semantic version of the image recipe, which specifies the version in the following format, with numeric values in each position to indicate a specific version: major.minor.patch. For example: 1.0.0. The following attributes are optional:

Link copied to clipboard
val workingDirectory: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): ImageRecipeArgs