com.pulumi.gcp.netapp.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-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-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.gcp.netapp.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.netapp.VolumeSnapshotArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* NetApp Volumes helps you manage your data usage with snapshots that can quickly restore lost data.
* Snapshots are point-in-time versions of your volume's content. They are resources of volumes and are
* instant captures of your data that consume space only for modified data. Because data changes over
* time, snapshots usually consume more space as they get older.
* NetApp Volumes volumes use just-in-time copy-on-write so that unmodified files in snapshots don't
* consume any of the volume's capacity.
* To get more information about VolumeSnapshot, see:
* * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots)
* * How-to Guides
* * [Documentation](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volume-snapshots/overview)
* ## Example Usage
* ### Volume Snapshot Create
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const default = gcp.compute.getNetwork({
* name: "test-network",
* });
* const defaultStoragePool = new gcp.netapp.StoragePool("default", {
* name: "test-pool",
* location: "us-west2",
* serviceLevel: "PREMIUM",
* capacityGib: "2048",
* network: _default.then(_default => _default.id),
* });
* const defaultVolume = new gcp.netapp.Volume("default", {
* location: defaultStoragePool.location,
* name: "test-volume",
* capacityGib: "100",
* shareName: "test-volume",
* storagePool: defaultStoragePool.name,
* protocols: ["NFSV3"],
* });
* const testSnapshot = new gcp.netapp.VolumeSnapshot("test_snapshot", {
* location: defaultVolume.location,
* volumeName: defaultVolume.name,
* name: "testvolumesnap",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* default = gcp.compute.get_network(name="test-network")
* default_storage_pool = gcp.netapp.StoragePool("default",
* name="test-pool",
* location="us-west2",
* service_level="PREMIUM",
* capacity_gib="2048",
* network=default.id)
* default_volume = gcp.netapp.Volume("default",
* location=default_storage_pool.location,
* name="test-volume",
* capacity_gib="100",
* share_name="test-volume",
* storage_pool=default_storage_pool.name,
* protocols=["NFSV3"])
* test_snapshot = gcp.netapp.VolumeSnapshot("test_snapshot",
* location=default_volume.location,
* volume_name=default_volume.name,
* name="testvolumesnap")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var @default = Gcp.Compute.GetNetwork.Invoke(new()
* {
* Name = "test-network",
* });
* var defaultStoragePool = new Gcp.Netapp.StoragePool("default", new()
* {
* Name = "test-pool",
* Location = "us-west2",
* ServiceLevel = "PREMIUM",
* CapacityGib = "2048",
* Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
* });
* var defaultVolume = new Gcp.Netapp.Volume("default", new()
* {
* Location = defaultStoragePool.Location,
* Name = "test-volume",
* CapacityGib = "100",
* ShareName = "test-volume",
* StoragePool = defaultStoragePool.Name,
* Protocols = new[]
* {
* "NFSV3",
* },
* });
* var testSnapshot = new Gcp.Netapp.VolumeSnapshot("test_snapshot", new()
* {
* Location = defaultVolume.Location,
* VolumeName = defaultVolume.Name,
* Name = "testvolumesnap",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/netapp"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _default, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
* Name: "test-network",
* }, nil)
* if err != nil {
* return err
* }
* defaultStoragePool, err := netapp.NewStoragePool(ctx, "default", &netapp.StoragePoolArgs{
* Name: pulumi.String("test-pool"),
* Location: pulumi.String("us-west2"),
* ServiceLevel: pulumi.String("PREMIUM"),
* CapacityGib: pulumi.String("2048"),
* Network: pulumi.String(_default.Id),
* })
* if err != nil {
* return err
* }
* defaultVolume, err := netapp.NewVolume(ctx, "default", &netapp.VolumeArgs{
* Location: defaultStoragePool.Location,
* Name: pulumi.String("test-volume"),
* CapacityGib: pulumi.String("100"),
* ShareName: pulumi.String("test-volume"),
* StoragePool: defaultStoragePool.Name,
* Protocols: pulumi.StringArray{
* pulumi.String("NFSV3"),
* },
* })
* if err != nil {
* return err
* }
* _, err = netapp.NewVolumeSnapshot(ctx, "test_snapshot", &netapp.VolumeSnapshotArgs{
* Location: defaultVolume.Location,
* VolumeName: defaultVolume.Name,
* Name: pulumi.String("testvolumesnap"),
* })
* 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.gcp.compute.ComputeFunctions;
* import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
* import com.pulumi.gcp.netapp.StoragePool;
* import com.pulumi.gcp.netapp.StoragePoolArgs;
* import com.pulumi.gcp.netapp.Volume;
* import com.pulumi.gcp.netapp.VolumeArgs;
* import com.pulumi.gcp.netapp.VolumeSnapshot;
* import com.pulumi.gcp.netapp.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) {
* final var default = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
* .name("test-network")
* .build());
* var defaultStoragePool = new StoragePool("defaultStoragePool", StoragePoolArgs.builder()
* .name("test-pool")
* .location("us-west2")
* .serviceLevel("PREMIUM")
* .capacityGib(2048)
* .network(default_.id())
* .build());
* var defaultVolume = new Volume("defaultVolume", VolumeArgs.builder()
* .location(defaultStoragePool.location())
* .name("test-volume")
* .capacityGib(100)
* .shareName("test-volume")
* .storagePool(defaultStoragePool.name())
* .protocols("NFSV3")
* .build());
* var testSnapshot = new VolumeSnapshot("testSnapshot", VolumeSnapshotArgs.builder()
* .location(defaultVolume.location())
* .volumeName(defaultVolume.name())
* .name("testvolumesnap")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* defaultStoragePool:
* type: gcp:netapp:StoragePool
* name: default
* properties:
* name: test-pool
* location: us-west2
* serviceLevel: PREMIUM
* capacityGib: 2048
* network: ${default.id}
* defaultVolume:
* type: gcp:netapp:Volume
* name: default
* properties:
* location: ${defaultStoragePool.location}
* name: test-volume
* capacityGib: 100
* shareName: test-volume
* storagePool: ${defaultStoragePool.name}
* protocols:
* - NFSV3
* testSnapshot:
* type: gcp:netapp:VolumeSnapshot
* name: test_snapshot
* properties:
* location: ${defaultVolume.location}
* volumeName: ${defaultVolume.name}
* name: testvolumesnap
* variables:
* default:
* fn::invoke:
* Function: gcp:compute:getNetwork
* Arguments:
* name: test-network
* ```
*
* ## Import
* VolumeSnapshot can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/snapshots/{{name}}`
* * `{{project}}/{{location}}/{{volume_name}}/{{name}}`
* * `{{location}}/{{volume_name}}/{{name}}`
* When using the `pulumi import` command, VolumeSnapshot can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/snapshots/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default {{project}}/{{location}}/{{volume_name}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default {{location}}/{{volume_name}}/{{name}}
* ```
* @property description Description for the snapshot.
* @property labels Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
* @property location Name of the snapshot location. Snapshots are child resources of volumes and live in the same location.
* @property name The name of the snapshot.
* - - -
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property volumeName The name of the volume to create the snapshot in.
*/
public data class VolumeSnapshotArgs(
public val description: Output? = null,
public val labels: Output>? = null,
public val location: Output? = null,
public val name: Output? = null,
public val project: Output? = null,
public val volumeName: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.netapp.VolumeSnapshotArgs =
com.pulumi.gcp.netapp.VolumeSnapshotArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.location(location?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.volumeName(volumeName?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [VolumeSnapshotArgs].
*/
@PulumiTagMarker
public class VolumeSnapshotArgsBuilder internal constructor() {
private var description: Output? = null
private var labels: Output>? = null
private var location: Output? = null
private var name: Output? = null
private var project: Output? = null
private var volumeName: Output? = null
/**
* @param value Description for the snapshot.
*/
@JvmName("ccdrpgdtrwhvrnxn")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("bcqwxurbqevhnahn")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value Name of the snapshot location. Snapshots are child resources of volumes and live in the same location.
*/
@JvmName("dfnjnnqlkqonqogm")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value The name of the snapshot.
* - - -
*/
@JvmName("tmmyyqbobjpknvjo")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("smiifkluyycvcfhy")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The name of the volume to create the snapshot in.
*/
@JvmName("cjfblqctskwpqguf")
public suspend fun volumeName(`value`: Output) {
this.volumeName = value
}
/**
* @param value Description for the snapshot.
*/
@JvmName("uiyaojcyfwbxxjwy")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("twsuxtwgvivaflan")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
@JvmName("eiwibkcywsqadnju")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value Name of the snapshot location. Snapshots are child resources of volumes and live in the same location.
*/
@JvmName("xaydfgnmusunleht")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value The name of the snapshot.
* - - -
*/
@JvmName("dfbuspvnqgryfdwn")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("toxjlrggtqylkftm")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The name of the volume to create the snapshot in.
*/
@JvmName("maixjoueyblovctj")
public suspend fun volumeName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.volumeName = mapped
}
internal fun build(): VolumeSnapshotArgs = VolumeSnapshotArgs(
description = description,
labels = labels,
location = location,
name = name,
project = project,
volumeName = volumeName,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy