Volume

class Volume : KotlinCustomResource

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:

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/v8/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v8/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}}

Properties

Link copied to clipboard
val activeDirectory: Output<String>

Reports the resource name of the Active Directory policy being used. Inherited from storage pool.

Link copied to clipboard

Backup configuration for the volume. Structure is documented below.

Link copied to clipboard
val capacityGib: Output<String>

Capacity of the volume (in GiB).

Link copied to clipboard
val coldTierSizeGib: Output<String>

Output only. Size of the volume cold tier data in GiB.

Link copied to clipboard
val createTime: Output<String>

Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".

Link copied to clipboard
val deletionPolicy: Output<String>?

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. Possible values: DEFAULT, FORCE.

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

An optional description of this resource.

Link copied to clipboard

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Link copied to clipboard
val encryptionType: Output<String>

Reports the data-at-rest encryption type of the volume. Inherited from storage pool.

Link copied to clipboard

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

Link copied to clipboard
val hasReplication: Output<Boolean>

Indicates whether the volume is part of a volume replication relationship.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kerberosEnabled: Output<Boolean>?

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

Link copied to clipboard
val kmsConfig: Output<String>

Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.

Link copied to clipboard
val labels: Output<Map<String, String>>?

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.

Link copied to clipboard
val largeCapacity: Output<Boolean>?

Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.

Link copied to clipboard
val ldapEnabled: Output<Boolean>

Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.

Link copied to clipboard
val location: Output<String>

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

Link copied to clipboard

Reports mount instructions for this volume. Structure is documented below.

Link copied to clipboard

Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with largeCapacity will be allowed to have multiple endpoints.

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard
val network: Output<String>

VPC network name with format: projects/{{project}}/global/networks/{{network}}. Inherited from storage pool.

Link copied to clipboard
val project: Output<String>

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

Link copied to clipboard
val protocols: Output<List<String>>

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.

Link copied to clipboard
val psaRange: Output<String>

Name of the Private Service Access allocated range. Inherited from storage pool.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val replicaZone: Output<String>

Specifies the replica zone for regional volume.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val securityStyle: Output<String>

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.

Link copied to clipboard
val serviceLevel: Output<String>

Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTREME, STANDARD, FLEX.

Link copied to clipboard
val shareName: Output<String>

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

Link copied to clipboard
val smbSettings: Output<List<String>>

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val state: Output<String>

State of the volume.

Link copied to clipboard
val stateDetails: Output<String>

State details of the volume.

Link copied to clipboard
val storagePool: Output<String>

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

Link copied to clipboard

Tiering policy for the volume. Structure is documented below.

Link copied to clipboard
val unixPermissions: Output<String>

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

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val usedGib: Output<String>

Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.

Link copied to clipboard
val zone: Output<String>

Specifies the active zone for regional volume.