pulumi-gcp-kotlin/com.pulumi.gcp.netapp.kotlin/VolumeArgs

VolumeArgs

data class VolumeArgs(val backupConfig: Output<VolumeBackupConfigArgs>? = null, val capacityGib: Output<String>? = null, val deletionPolicy: Output<String>? = null, val description: Output<String>? = null, val exportPolicy: Output<VolumeExportPolicyArgs>? = null, val kerberosEnabled: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val protocols: Output<List<String>>? = null, val restoreParameters: Output<VolumeRestoreParametersArgs>? = null, val restrictedActions: Output<List<String>>? = null, val securityStyle: Output<String>? = null, val shareName: Output<String>? = null, val smbSettings: Output<List<String>>? = null, val snapshotDirectory: Output<Boolean>? = null, val snapshotPolicy: Output<VolumeSnapshotPolicyArgs>? = null, val storagePool: Output<String>? = null, val unixPermissions: Output<String>? = null) : ConvertibleToJava<VolumeArgs>

A volume is a file system container in a storage pool that stores application, database, and user data. You can create a volume's capacity using the available capacity in the storage pool and you can define and resize the capacity without disruption to any processes. Storage pool settings apply to the volumes contained within them automatically. To get more information about Volume, see:

API documentation
How-to Guides

Example Usage

Netapp Volume Basic

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 testVolume = new gcp.netapp.Volume("test_volume", {
    location: "us-west2",
    name: "test-volume",
    capacityGib: "100",
    shareName: "test-volume",
    storagePool: defaultStoragePool.name,
    protocols: ["NFSV3"],
    deletionPolicy: "DEFAULT",
});

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)
test_volume = gcp.netapp.Volume("test_volume",
    location="us-west2",
    name="test-volume",
    capacity_gib="100",
    share_name="test-volume",
    storage_pool=default_storage_pool.name,
    protocols=["NFSV3"],
    deletion_policy="DEFAULT")

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 testVolume = new Gcp.Netapp.Volume("test_volume", new()
    {
        Location = "us-west2",
        Name = "test-volume",
        CapacityGib = "100",
        ShareName = "test-volume",
        StoragePool = defaultStoragePool.Name,
        Protocols = new[]
        {
            "NFSV3",
        },
        DeletionPolicy = "DEFAULT",
    });
});

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
		}
		_, err = netapp.NewVolume(ctx, "test_volume", &netapp.VolumeArgs{
			Location:    pulumi.String("us-west2"),
			Name:        pulumi.String("test-volume"),
			CapacityGib: pulumi.String("100"),
			ShareName:   pulumi.String("test-volume"),
			StoragePool: defaultStoragePool.Name,
			Protocols: pulumi.StringArray{
				pulumi.String("NFSV3"),
			},
			DeletionPolicy: pulumi.String("DEFAULT"),
		})
		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.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 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 testVolume = new Volume("testVolume", VolumeArgs.builder()
            .location("us-west2")
            .name("test-volume")
            .capacityGib("100")
            .shareName("test-volume")
            .storagePool(defaultStoragePool.name())
            .protocols("NFSV3")
            .deletionPolicy("DEFAULT")
            .build());
    }
}

resources:
  defaultStoragePool:
    type: gcp:netapp:StoragePool
    name: default
    properties:
      name: test-pool
      location: us-west2
      serviceLevel: PREMIUM
      capacityGib: '2048'
      network: ${default.id}
  testVolume:
    type: gcp:netapp:Volume
    name: test_volume
    properties:
      location: us-west2
      name: test-volume
      capacityGib: '100'
      shareName: test-volume
      storagePool: ${defaultStoragePool.name}
      protocols:
        - NFSV3
      deletionPolicy: DEFAULT
variables:
  default:
    fn::invoke:
      Function: gcp:compute:getNetwork
      Arguments:
        name: test-network

Import

Volume can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/volumes/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}} When using the pulumi import command, Volume can be imported using one of the formats above. For example:

$ pulumi import gcp:netapp/volume:Volume default projects/{{project}}/locations/{{location}}/volumes/{{name}}

$ pulumi import gcp:netapp/volume:Volume default {{project}}/{{location}}/{{name}}

$ pulumi import gcp:netapp/volume:Volume default {{location}}/{{name}}

Constructors

VolumeArgs

constructor(backupConfig: Output<VolumeBackupConfigArgs>? = null, capacityGib: Output<String>? = null, deletionPolicy: Output<String>? = null, description: Output<String>? = null, exportPolicy: Output<VolumeExportPolicyArgs>? = null, kerberosEnabled: Output<Boolean>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, protocols: Output<List<String>>? = null, restoreParameters: Output<VolumeRestoreParametersArgs>? = null, restrictedActions: Output<List<String>>? = null, securityStyle: Output<String>? = null, shareName: Output<String>? = null, smbSettings: Output<List<String>>? = null, snapshotDirectory: Output<Boolean>? = null, snapshotPolicy: Output<VolumeSnapshotPolicyArgs>? = null, storagePool: Output<String>? = null, unixPermissions: Output<String>? = null)

Properties

backupConfig

val backupConfig: Output<VolumeBackupConfigArgs>? = null

Backup configuration for the volume. Structure is documented below.

capacityGib

val capacityGib: Output<String>? = null

Capacity of the volume (in GiB).

deletionPolicy

val deletionPolicy: Output<String>? = null

Policy to determine if the volume should be deleted forcefully. Volumes may have nested snapshot resources. Deleting such a volume will fail. Setting this parameter to FORCE will delete volumes including nested snapshots.

description

val description: Output<String>? = null

An optional description of this resource.

exportPolicy

val exportPolicy: Output<VolumeExportPolicyArgs>? = null

Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.

kerberosEnabled

val kerberosEnabled: Output<Boolean>? = null

Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).

labels

val labels: Output<Map<String, String>>? = null

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.

location

val location: Output<String>? = null

Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.

name

val name: Output<String>? = null

The name of the volume. Needs to be unique per location.

project

val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

protocols

val protocols: Output<List<String>>? = null

The protocol of the volume. Allowed combinations are ['NFSV3'], ['NFSV4'], ['SMB'], ['NFSV3', 'NFSV4'], ['SMB', 'NFSV3'] and ['SMB', 'NFSV4']. Each value may be one of: NFSV3, NFSV4, SMB.

restoreParameters

val restoreParameters: Output<VolumeRestoreParametersArgs>? = null

Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.

restrictedActions

val restrictedActions: Output<List<String>>? = null

List of actions that are restricted on this volume. Each value may be one of: DELETE.

securityStyle

val securityStyle: Output<String>? = null

Security Style of the Volume. Use UNIX to use UNIX or NFSV4 ACLs for file permissions. Use NTFS to use NTFS ACLs for file permissions. Can only be set for volumes which use SMB together with NFS as protocol. Possible values are: NTFS, UNIX.

shareName

val shareName: Output<String>? = null

Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.

smbSettings

val smbSettings: Output<List<String>>? = null

Settings for volumes with SMB access. Each value may be one of: ENCRYPT_DATA, BROWSABLE, CHANGE_NOTIFY, NON_BROWSABLE, OPLOCKS, SHOW_SNAPSHOT, SHOW_PREVIOUS_VERSIONS, ACCESS_BASED_ENUMERATION, CONTINUOUSLY_AVAILABLE.

snapshotDirectory

val snapshotDirectory: Output<Boolean>? = null

If enabled, a NFS volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots. Will enable "Previous Versions" support for SMB.

snapshotPolicy

val snapshotPolicy: Output<VolumeSnapshotPolicyArgs>? = null

Snapshot policy defines the schedule for automatic snapshot creation. To disable automatic snapshot creation you have to remove the whole snapshot_policy block. Structure is documented below.

storagePool

val storagePool: Output<String>? = null

Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.

unixPermissions

val unixPermissions: Output<String>? = null

Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.

Functions

toJava

open override fun toJava(): VolumeArgs