com.pulumi.digitalocean.kotlin.VolumeSnapshotArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-digitalocean-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.
There is a newer version: 4.38.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.digitalocean.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.digitalocean.VolumeSnapshotArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * Provides a DigitalOcean Volume Snapshot which can be used to create a snapshot from an existing volume.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 * const foobar = new digitalocean.Volume("foobar", {
 *     region: digitalocean.Region.NYC1,
 *     name: "baz",
 *     size: 100,
 *     description: "an example volume",
 * });
 * const foobarVolumeSnapshot = new digitalocean.VolumeSnapshot("foobar", {
 *     name: "foo",
 *     volumeId: foobar.id,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_digitalocean as digitalocean
 * foobar = digitalocean.Volume("foobar",
 *     region=digitalocean.Region.NYC1,
 *     name="baz",
 *     size=100,
 *     description="an example volume")
 * foobar_volume_snapshot = digitalocean.VolumeSnapshot("foobar",
 *     name="foo",
 *     volume_id=foobar.id)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using DigitalOcean = Pulumi.DigitalOcean;
 * return await Deployment.RunAsync(() =>
 * {
 *     var foobar = new DigitalOcean.Volume("foobar", new()
 *     {
 *         Region = DigitalOcean.Region.NYC1,
 *         Name = "baz",
 *         Size = 100,
 *         Description = "an example volume",
 *     });
 *     var foobarVolumeSnapshot = new DigitalOcean.VolumeSnapshot("foobar", new()
 *     {
 *         Name = "foo",
 *         VolumeId = foobar.Id,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		foobar, err := digitalocean.NewVolume(ctx, "foobar", &digitalocean.VolumeArgs{
 * 			Region:      pulumi.String(digitalocean.RegionNYC1),
 * 			Name:        pulumi.String("baz"),
 * 			Size:        pulumi.Int(100),
 * 			Description: pulumi.String("an example volume"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = digitalocean.NewVolumeSnapshot(ctx, "foobar", &digitalocean.VolumeSnapshotArgs{
 * 			Name:     pulumi.String("foo"),
 * 			VolumeId: foobar.ID(),
 * 		})
 * 		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.digitalocean.Volume;
 * import com.pulumi.digitalocean.VolumeArgs;
 * import com.pulumi.digitalocean.VolumeSnapshot;
 * import com.pulumi.digitalocean.VolumeSnapshotArgs;
 * 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 foobar = new Volume("foobar", VolumeArgs.builder()
 *             .region("nyc1")
 *             .name("baz")
 *             .size(100)
 *             .description("an example volume")
 *             .build());
 *         var foobarVolumeSnapshot = new VolumeSnapshot("foobarVolumeSnapshot", VolumeSnapshotArgs.builder()
 *             .name("foo")
 *             .volumeId(foobar.id())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   foobar:
 *     type: digitalocean:Volume
 *     properties:
 *       region: nyc1
 *       name: baz
 *       size: 100
 *       description: an example volume
 *   foobarVolumeSnapshot:
 *     type: digitalocean:VolumeSnapshot
 *     name: foobar
 *     properties:
 *       name: foo
 *       volumeId: ${foobar.id}
 * ```
 * 
 * ## Import
 * Volume Snapshots can be imported using the `snapshot id`, e.g.
 * ```sh
 * $ pulumi import digitalocean:index/volumeSnapshot:VolumeSnapshot snapshot 506f78a4-e098-11e5-ad9f-000f53306ae1
 * ```
 * @property name A name for the volume snapshot.
 * @property tags A list of the tags to be applied to this volume snapshot.
 * @property volumeId The ID of the volume from which the volume snapshot originated.
 */
public data class VolumeSnapshotArgs(
    public val name: Output? = null,
    public val tags: Output>? = null,
    public val volumeId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.digitalocean.VolumeSnapshotArgs =
        com.pulumi.digitalocean.VolumeSnapshotArgs.builder()
            .name(name?.applyValue({ args0 -> args0 }))
            .tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .volumeId(volumeId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [VolumeSnapshotArgs].
 */
@PulumiTagMarker
public class VolumeSnapshotArgsBuilder internal constructor() {
    private var name: Output? = null

    private var tags: Output>? = null

    private var volumeId: Output? = null

    /**
     * @param value A name for the volume snapshot.
     */
    @JvmName("aseerrytahhskyhx")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value A list of the tags to be applied to this volume snapshot.
     */
    @JvmName("qgscqoshhhggnsww")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

    @JvmName("dryebknxgnokrsah")
    public suspend fun tags(vararg values: Output) {
        this.tags = Output.all(values.asList())
    }

    /**
     * @param values A list of the tags to be applied to this volume snapshot.
     */
    @JvmName("islbjxtiocoofjpd")
    public suspend fun tags(values: List>) {
        this.tags = Output.all(values)
    }

    /**
     * @param value The ID of the volume from which the volume snapshot originated.
     */
    @JvmName("hskrkcmtgftjelyy")
    public suspend fun volumeId(`value`: Output) {
        this.volumeId = value
    }

    /**
     * @param value A name for the volume snapshot.
     */
    @JvmName("ayjapgxldbyjfflc")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value A list of the tags to be applied to this volume snapshot.
     */
    @JvmName("mjptjpjnsfbusojv")
    public suspend fun tags(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param values A list of the tags to be applied to this volume snapshot.
     */
    @JvmName("dmflqetrajfsnevn")
    public suspend fun tags(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param value The ID of the volume from which the volume snapshot originated.
     */
    @JvmName("bintjsgkgpwkxpxq")
    public suspend fun volumeId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.volumeId = mapped
    }

    internal fun build(): VolumeSnapshotArgs = VolumeSnapshotArgs(
        name = name,
        tags = tags,
        volumeId = volumeId,
    )
}