com.pulumi.aws.imagebuilder.kotlin.ImageRecipeArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.imagebuilder.kotlin
import com.pulumi.aws.imagebuilder.ImageRecipeArgs.builder
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeBlockDeviceMappingArgs
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeBlockDeviceMappingArgsBuilder
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeComponentArgs
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeComponentArgsBuilder
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeSystemsManagerAgentArgs
import com.pulumi.aws.imagebuilder.kotlin.inputs.ImageRecipeSystemsManagerAgentArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages an Image Builder Image Recipe.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.imagebuilder.ImageRecipe("example", {
* blockDeviceMappings: [{
* deviceName: "/dev/xvdb",
* ebs: {
* deleteOnTermination: "true",
* volumeSize: 100,
* volumeType: "gp2",
* },
* }],
* components: [{
* componentArn: exampleAwsImagebuilderComponent.arn,
* parameters: [
* {
* name: "Parameter1",
* value: "Value1",
* },
* {
* name: "Parameter2",
* value: "Value2",
* },
* ],
* }],
* name: "example",
* parentImage: `arn:${current.partition}:imagebuilder:${currentAwsRegion.name}:aws:image/amazon-linux-2-x86/x.x.x`,
* version: "1.0.0",
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.imagebuilder.ImageRecipe("example",
* block_device_mappings=[{
* "device_name": "/dev/xvdb",
* "ebs": {
* "delete_on_termination": "true",
* "volume_size": 100,
* "volume_type": "gp2",
* },
* }],
* components=[{
* "component_arn": example_aws_imagebuilder_component["arn"],
* "parameters": [
* {
* "name": "Parameter1",
* "value": "Value1",
* },
* {
* "name": "Parameter2",
* "value": "Value2",
* },
* ],
* }],
* name="example",
* parent_image=f"arn:{current['partition']}:imagebuilder:{current_aws_region['name']}:aws:image/amazon-linux-2-x86/x.x.x",
* version="1.0.0")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.ImageBuilder.ImageRecipe("example", new()
* {
* BlockDeviceMappings = new[]
* {
* new Aws.ImageBuilder.Inputs.ImageRecipeBlockDeviceMappingArgs
* {
* DeviceName = "/dev/xvdb",
* Ebs = new Aws.ImageBuilder.Inputs.ImageRecipeBlockDeviceMappingEbsArgs
* {
* DeleteOnTermination = "true",
* VolumeSize = 100,
* VolumeType = "gp2",
* },
* },
* },
* Components = new[]
* {
* new Aws.ImageBuilder.Inputs.ImageRecipeComponentArgs
* {
* ComponentArn = exampleAwsImagebuilderComponent.Arn,
* Parameters = new[]
* {
* new Aws.ImageBuilder.Inputs.ImageRecipeComponentParameterArgs
* {
* Name = "Parameter1",
* Value = "Value1",
* },
* new Aws.ImageBuilder.Inputs.ImageRecipeComponentParameterArgs
* {
* Name = "Parameter2",
* Value = "Value2",
* },
* },
* },
* },
* Name = "example",
* ParentImage = $"arn:{current.Partition}:imagebuilder:{currentAwsRegion.Name}:aws:image/amazon-linux-2-x86/x.x.x",
* Version = "1.0.0",
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "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.NewImageRecipe(ctx, "example", &imagebuilder.ImageRecipeArgs{
* BlockDeviceMappings: imagebuilder.ImageRecipeBlockDeviceMappingArray{
* &imagebuilder.ImageRecipeBlockDeviceMappingArgs{
* DeviceName: pulumi.String("/dev/xvdb"),
* Ebs: &imagebuilder.ImageRecipeBlockDeviceMappingEbsArgs{
* DeleteOnTermination: pulumi.String("true"),
* VolumeSize: pulumi.Int(100),
* VolumeType: pulumi.String("gp2"),
* },
* },
* },
* Components: imagebuilder.ImageRecipeComponentArray{
* &imagebuilder.ImageRecipeComponentArgs{
* ComponentArn: pulumi.Any(exampleAwsImagebuilderComponent.Arn),
* Parameters: imagebuilder.ImageRecipeComponentParameterArray{
* &imagebuilder.ImageRecipeComponentParameterArgs{
* Name: pulumi.String("Parameter1"),
* Value: pulumi.String("Value1"),
* },
* &imagebuilder.ImageRecipeComponentParameterArgs{
* Name: pulumi.String("Parameter2"),
* Value: pulumi.String("Value2"),
* },
* },
* },
* },
* Name: pulumi.String("example"),
* ParentImage: pulumi.Sprintf("arn:%v:imagebuilder:%v:aws:image/amazon-linux-2-x86/x.x.x", current.Partition, currentAwsRegion.Name),
* Version: pulumi.String("1.0.0"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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(exampleAwsImagebuilderComponent.arn())
* .parameters(
* ImageRecipeComponentParameterArgs.builder()
* .name("Parameter1")
* .value("Value1")
* .build(),
* ImageRecipeComponentParameterArgs.builder()
* .name("Parameter2")
* .value("Value2")
* .build())
* .build())
* .name("example")
* .parentImage(String.format("arn:%s:imagebuilder:%s:aws:image/amazon-linux-2-x86/x.x.x", current.partition(),currentAwsRegion.name()))
* .version("1.0.0")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:imagebuilder:ImageRecipe
* properties:
* blockDeviceMappings:
* - deviceName: /dev/xvdb
* ebs:
* deleteOnTermination: true
* volumeSize: 100
* volumeType: gp2
* components:
* - componentArn: ${exampleAwsImagebuilderComponent.arn}
* parameters:
* - name: Parameter1
* value: Value1
* - name: Parameter2
* value: Value2
* name: example
* parentImage: arn:${current.partition}:imagebuilder:${currentAwsRegion.name}:aws:image/amazon-linux-2-x86/x.x.x
* version: 1.0.0
* ```
*
* ## Import
* Using `pulumi import`, import `aws_imagebuilder_image_recipe` resources using the Amazon Resource Name (ARN). For example:
* ```sh
* $ pulumi import aws:imagebuilder/imageRecipe:ImageRecipe example arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/example/1.0.0
* ```
* @property blockDeviceMappings Configuration block(s) with block device mappings for the image recipe. Detailed below.
* @property components Ordered configuration block(s) with components for the image recipe. Detailed below.
* @property description Description of the image recipe.
* @property name Name of the image recipe.
* @property parentImage 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.
* @property systemsManagerAgent Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.
* @property tags 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.
* @property userDataBase64 Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance.
* @property version 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:
* @property workingDirectory The working directory to be used during build and test workflows.
*/
public data class ImageRecipeArgs(
public val blockDeviceMappings: Output>? = null,
public val components: Output>? = null,
public val description: Output? = null,
public val name: Output? = null,
public val parentImage: Output? = null,
public val systemsManagerAgent: Output? = null,
public val tags: Output>? = null,
public val userDataBase64: Output? = null,
public val version: Output? = null,
public val workingDirectory: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.imagebuilder.ImageRecipeArgs =
com.pulumi.aws.imagebuilder.ImageRecipeArgs.builder()
.blockDeviceMappings(
blockDeviceMappings?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.components(
components?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.description(description?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.parentImage(parentImage?.applyValue({ args0 -> args0 }))
.systemsManagerAgent(
systemsManagerAgent?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.userDataBase64(userDataBase64?.applyValue({ args0 -> args0 }))
.version(version?.applyValue({ args0 -> args0 }))
.workingDirectory(workingDirectory?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ImageRecipeArgs].
*/
@PulumiTagMarker
public class ImageRecipeArgsBuilder internal constructor() {
private var blockDeviceMappings: Output>? = null
private var components: Output>? = null
private var description: Output? = null
private var name: Output? = null
private var parentImage: Output? = null
private var systemsManagerAgent: Output? = null
private var tags: Output>? = null
private var userDataBase64: Output? = null
private var version: Output? = null
private var workingDirectory: Output? = null
/**
* @param value Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("ybwkjcjalxhnfjib")
public suspend fun blockDeviceMappings(`value`: Output>) {
this.blockDeviceMappings = value
}
@JvmName("qxcybiktvvmkginr")
public suspend fun blockDeviceMappings(vararg values: Output) {
this.blockDeviceMappings = Output.all(values.asList())
}
/**
* @param values Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("nbthnnustproxuip")
public suspend fun blockDeviceMappings(values: List>) {
this.blockDeviceMappings = Output.all(values)
}
/**
* @param value Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("yrrokygtfaxhwifr")
public suspend fun components(`value`: Output>) {
this.components = value
}
@JvmName("ybvjutirpfiuiqme")
public suspend fun components(vararg values: Output) {
this.components = Output.all(values.asList())
}
/**
* @param values Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("pkdcnomamfbujyqf")
public suspend fun components(values: List>) {
this.components = Output.all(values)
}
/**
* @param value Description of the image recipe.
*/
@JvmName("wfbhrhyhamwpfvwu")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Name of the image recipe.
*/
@JvmName("nisfnrmtdlmtkurn")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value 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.
*/
@JvmName("blsitqxdmelkmpfj")
public suspend fun parentImage(`value`: Output) {
this.parentImage = value
}
/**
* @param value Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.
*/
@JvmName("vhikrdgjgdlcfpyb")
public suspend fun systemsManagerAgent(`value`: Output) {
this.systemsManagerAgent = value
}
/**
* @param value 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.
*/
@JvmName("oaaeauvobcvciyim")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance.
*/
@JvmName("hgkgcowympaqrcxt")
public suspend fun userDataBase64(`value`: Output) {
this.userDataBase64 = value
}
/**
* @param value 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:
*/
@JvmName("nefulrufkpevcuui")
public suspend fun version(`value`: Output) {
this.version = value
}
/**
* @param value The working directory to be used during build and test workflows.
*/
@JvmName("jurydhudcamhgfem")
public suspend fun workingDirectory(`value`: Output) {
this.workingDirectory = value
}
/**
* @param value Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("vhqmxlkdvkcsdjsc")
public suspend fun blockDeviceMappings(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.blockDeviceMappings = mapped
}
/**
* @param argument Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("jqkivsxjgouajnpf")
public suspend fun blockDeviceMappings(argument: List Unit>) {
val toBeMapped = argument.toList().map {
ImageRecipeBlockDeviceMappingArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.blockDeviceMappings = mapped
}
/**
* @param argument Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("xugsilwygognmqsh")
public suspend fun blockDeviceMappings(vararg argument: suspend ImageRecipeBlockDeviceMappingArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
ImageRecipeBlockDeviceMappingArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.blockDeviceMappings = mapped
}
/**
* @param argument Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("bkfvbiyijjiwayrp")
public suspend fun blockDeviceMappings(argument: suspend ImageRecipeBlockDeviceMappingArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
ImageRecipeBlockDeviceMappingArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.blockDeviceMappings = mapped
}
/**
* @param values Configuration block(s) with block device mappings for the image recipe. Detailed below.
*/
@JvmName("gjcateokprxnjrrf")
public suspend fun blockDeviceMappings(vararg values: ImageRecipeBlockDeviceMappingArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.blockDeviceMappings = mapped
}
/**
* @param value Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("bvbrbbuswkkslpnw")
public suspend fun components(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.components = mapped
}
/**
* @param argument Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("ufssejacgiihmxqe")
public suspend fun components(argument: List Unit>) {
val toBeMapped = argument.toList().map {
ImageRecipeComponentArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.components = mapped
}
/**
* @param argument Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("ijhohbvxnpayhgbo")
public suspend fun components(vararg argument: suspend ImageRecipeComponentArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
ImageRecipeComponentArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.components = mapped
}
/**
* @param argument Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("nriyitwqpemkmhqw")
public suspend fun components(argument: suspend ImageRecipeComponentArgsBuilder.() -> Unit) {
val toBeMapped = listOf(ImageRecipeComponentArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.components = mapped
}
/**
* @param values Ordered configuration block(s) with components for the image recipe. Detailed below.
*/
@JvmName("btqcydvpgulxjifr")
public suspend fun components(vararg values: ImageRecipeComponentArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.components = mapped
}
/**
* @param value Description of the image recipe.
*/
@JvmName("bfvncsdgmmkxylrr")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Name of the image recipe.
*/
@JvmName("lsqyxpqjmxayarcj")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value 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.
*/
@JvmName("evweyencyjxmbbvp")
public suspend fun parentImage(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parentImage = mapped
}
/**
* @param value Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.
*/
@JvmName("kekosnwtiyhekswq")
public suspend fun systemsManagerAgent(`value`: ImageRecipeSystemsManagerAgentArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.systemsManagerAgent = mapped
}
/**
* @param argument Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.
*/
@JvmName("eqnafyuqfrvyauro")
public suspend fun systemsManagerAgent(argument: suspend ImageRecipeSystemsManagerAgentArgsBuilder.() -> Unit) {
val toBeMapped = ImageRecipeSystemsManagerAgentArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.systemsManagerAgent = mapped
}
/**
* @param value 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.
*/
@JvmName("aypmhlygxuqltlqj")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values 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.
*/
@JvmName("bpjkursjlivhpxcy")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance.
*/
@JvmName("pvgdmdasiuqfupnf")
public suspend fun userDataBase64(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userDataBase64 = mapped
}
/**
* @param value 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:
*/
@JvmName("umeckccukgfsykty")
public suspend fun version(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.version = mapped
}
/**
* @param value The working directory to be used during build and test workflows.
*/
@JvmName("guspooxcavahomyp")
public suspend fun workingDirectory(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.workingDirectory = mapped
}
internal fun build(): ImageRecipeArgs = ImageRecipeArgs(
blockDeviceMappings = blockDeviceMappings,
components = components,
description = description,
name = name,
parentImage = parentImage,
systemsManagerAgent = systemsManagerAgent,
tags = tags,
userDataBase64 = userDataBase64,
version = version,
workingDirectory = workingDirectory,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy