gcp.netapp.Volume
Explore with Pulumi AI
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")
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
})
}
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 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
Create Volume Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
@overload
def Volume(resource_name: str,
args: VolumeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Volume(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
capacity_gib: Optional[str] = None,
storage_pool: Optional[str] = None,
share_name: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
name: Optional[str] = None,
restricted_actions: Optional[Sequence[str]] = None,
large_capacity: Optional[bool] = None,
kerberos_enabled: Optional[bool] = None,
multiple_endpoints: Optional[bool] = None,
backup_config: Optional[VolumeBackupConfigArgs] = None,
project: Optional[str] = None,
export_policy: Optional[VolumeExportPolicyArgs] = None,
restore_parameters: Optional[VolumeRestoreParametersArgs] = None,
labels: Optional[Mapping[str, str]] = None,
security_style: Optional[str] = None,
description: Optional[str] = None,
smb_settings: Optional[Sequence[str]] = None,
snapshot_directory: Optional[bool] = None,
snapshot_policy: Optional[VolumeSnapshotPolicyArgs] = None,
deletion_policy: Optional[str] = None,
tiering_policy: Optional[VolumeTieringPolicyArgs] = None,
unix_permissions: Optional[str] = None)
func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)
type: gcp:netapp:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var volumeResource = new Gcp.Netapp.Volume("volumeResource", new()
{
Location = "string",
CapacityGib = "string",
StoragePool = "string",
ShareName = "string",
Protocols = new[]
{
"string",
},
Name = "string",
RestrictedActions = new[]
{
"string",
},
LargeCapacity = false,
KerberosEnabled = false,
MultipleEndpoints = false,
BackupConfig = new Gcp.Netapp.Inputs.VolumeBackupConfigArgs
{
BackupPolicies = new[]
{
"string",
},
BackupVault = "string",
ScheduledBackupEnabled = false,
},
Project = "string",
ExportPolicy = new Gcp.Netapp.Inputs.VolumeExportPolicyArgs
{
Rules = new[]
{
new Gcp.Netapp.Inputs.VolumeExportPolicyRuleArgs
{
AccessType = "string",
AllowedClients = "string",
HasRootAccess = "string",
Kerberos5ReadOnly = false,
Kerberos5ReadWrite = false,
Kerberos5iReadOnly = false,
Kerberos5iReadWrite = false,
Kerberos5pReadOnly = false,
Kerberos5pReadWrite = false,
Nfsv3 = false,
Nfsv4 = false,
},
},
},
RestoreParameters = new Gcp.Netapp.Inputs.VolumeRestoreParametersArgs
{
SourceBackup = "string",
SourceSnapshot = "string",
},
Labels =
{
{ "string", "string" },
},
SecurityStyle = "string",
Description = "string",
SmbSettings = new[]
{
"string",
},
SnapshotDirectory = false,
SnapshotPolicy = new Gcp.Netapp.Inputs.VolumeSnapshotPolicyArgs
{
DailySchedule = new Gcp.Netapp.Inputs.VolumeSnapshotPolicyDailyScheduleArgs
{
SnapshotsToKeep = 0,
Hour = 0,
Minute = 0,
},
Enabled = false,
HourlySchedule = new Gcp.Netapp.Inputs.VolumeSnapshotPolicyHourlyScheduleArgs
{
SnapshotsToKeep = 0,
Minute = 0,
},
MonthlySchedule = new Gcp.Netapp.Inputs.VolumeSnapshotPolicyMonthlyScheduleArgs
{
SnapshotsToKeep = 0,
DaysOfMonth = "string",
Hour = 0,
Minute = 0,
},
WeeklySchedule = new Gcp.Netapp.Inputs.VolumeSnapshotPolicyWeeklyScheduleArgs
{
SnapshotsToKeep = 0,
Day = "string",
Hour = 0,
Minute = 0,
},
},
DeletionPolicy = "string",
TieringPolicy = new Gcp.Netapp.Inputs.VolumeTieringPolicyArgs
{
CoolingThresholdDays = 0,
TierAction = "string",
},
UnixPermissions = "string",
});
example, err := netapp.NewVolume(ctx, "volumeResource", &netapp.VolumeArgs{
Location: pulumi.String("string"),
CapacityGib: pulumi.String("string"),
StoragePool: pulumi.String("string"),
ShareName: pulumi.String("string"),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
RestrictedActions: pulumi.StringArray{
pulumi.String("string"),
},
LargeCapacity: pulumi.Bool(false),
KerberosEnabled: pulumi.Bool(false),
MultipleEndpoints: pulumi.Bool(false),
BackupConfig: &netapp.VolumeBackupConfigArgs{
BackupPolicies: pulumi.StringArray{
pulumi.String("string"),
},
BackupVault: pulumi.String("string"),
ScheduledBackupEnabled: pulumi.Bool(false),
},
Project: pulumi.String("string"),
ExportPolicy: &netapp.VolumeExportPolicyArgs{
Rules: netapp.VolumeExportPolicyRuleArray{
&netapp.VolumeExportPolicyRuleArgs{
AccessType: pulumi.String("string"),
AllowedClients: pulumi.String("string"),
HasRootAccess: pulumi.String("string"),
Kerberos5ReadOnly: pulumi.Bool(false),
Kerberos5ReadWrite: pulumi.Bool(false),
Kerberos5iReadOnly: pulumi.Bool(false),
Kerberos5iReadWrite: pulumi.Bool(false),
Kerberos5pReadOnly: pulumi.Bool(false),
Kerberos5pReadWrite: pulumi.Bool(false),
Nfsv3: pulumi.Bool(false),
Nfsv4: pulumi.Bool(false),
},
},
},
RestoreParameters: &netapp.VolumeRestoreParametersArgs{
SourceBackup: pulumi.String("string"),
SourceSnapshot: pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
SecurityStyle: pulumi.String("string"),
Description: pulumi.String("string"),
SmbSettings: pulumi.StringArray{
pulumi.String("string"),
},
SnapshotDirectory: pulumi.Bool(false),
SnapshotPolicy: &netapp.VolumeSnapshotPolicyArgs{
DailySchedule: &netapp.VolumeSnapshotPolicyDailyScheduleArgs{
SnapshotsToKeep: pulumi.Int(0),
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
Enabled: pulumi.Bool(false),
HourlySchedule: &netapp.VolumeSnapshotPolicyHourlyScheduleArgs{
SnapshotsToKeep: pulumi.Int(0),
Minute: pulumi.Int(0),
},
MonthlySchedule: &netapp.VolumeSnapshotPolicyMonthlyScheduleArgs{
SnapshotsToKeep: pulumi.Int(0),
DaysOfMonth: pulumi.String("string"),
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
WeeklySchedule: &netapp.VolumeSnapshotPolicyWeeklyScheduleArgs{
SnapshotsToKeep: pulumi.Int(0),
Day: pulumi.String("string"),
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
},
DeletionPolicy: pulumi.String("string"),
TieringPolicy: &netapp.VolumeTieringPolicyArgs{
CoolingThresholdDays: pulumi.Int(0),
TierAction: pulumi.String("string"),
},
UnixPermissions: pulumi.String("string"),
})
var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
.location("string")
.capacityGib("string")
.storagePool("string")
.shareName("string")
.protocols("string")
.name("string")
.restrictedActions("string")
.largeCapacity(false)
.kerberosEnabled(false)
.multipleEndpoints(false)
.backupConfig(VolumeBackupConfigArgs.builder()
.backupPolicies("string")
.backupVault("string")
.scheduledBackupEnabled(false)
.build())
.project("string")
.exportPolicy(VolumeExportPolicyArgs.builder()
.rules(VolumeExportPolicyRuleArgs.builder()
.accessType("string")
.allowedClients("string")
.hasRootAccess("string")
.kerberos5ReadOnly(false)
.kerberos5ReadWrite(false)
.kerberos5iReadOnly(false)
.kerberos5iReadWrite(false)
.kerberos5pReadOnly(false)
.kerberos5pReadWrite(false)
.nfsv3(false)
.nfsv4(false)
.build())
.build())
.restoreParameters(VolumeRestoreParametersArgs.builder()
.sourceBackup("string")
.sourceSnapshot("string")
.build())
.labels(Map.of("string", "string"))
.securityStyle("string")
.description("string")
.smbSettings("string")
.snapshotDirectory(false)
.snapshotPolicy(VolumeSnapshotPolicyArgs.builder()
.dailySchedule(VolumeSnapshotPolicyDailyScheduleArgs.builder()
.snapshotsToKeep(0)
.hour(0)
.minute(0)
.build())
.enabled(false)
.hourlySchedule(VolumeSnapshotPolicyHourlyScheduleArgs.builder()
.snapshotsToKeep(0)
.minute(0)
.build())
.monthlySchedule(VolumeSnapshotPolicyMonthlyScheduleArgs.builder()
.snapshotsToKeep(0)
.daysOfMonth("string")
.hour(0)
.minute(0)
.build())
.weeklySchedule(VolumeSnapshotPolicyWeeklyScheduleArgs.builder()
.snapshotsToKeep(0)
.day("string")
.hour(0)
.minute(0)
.build())
.build())
.deletionPolicy("string")
.tieringPolicy(VolumeTieringPolicyArgs.builder()
.coolingThresholdDays(0)
.tierAction("string")
.build())
.unixPermissions("string")
.build());
volume_resource = gcp.netapp.Volume("volumeResource",
location="string",
capacity_gib="string",
storage_pool="string",
share_name="string",
protocols=["string"],
name="string",
restricted_actions=["string"],
large_capacity=False,
kerberos_enabled=False,
multiple_endpoints=False,
backup_config={
"backup_policies": ["string"],
"backup_vault": "string",
"scheduled_backup_enabled": False,
},
project="string",
export_policy={
"rules": [{
"access_type": "string",
"allowed_clients": "string",
"has_root_access": "string",
"kerberos5_read_only": False,
"kerberos5_read_write": False,
"kerberos5i_read_only": False,
"kerberos5i_read_write": False,
"kerberos5p_read_only": False,
"kerberos5p_read_write": False,
"nfsv3": False,
"nfsv4": False,
}],
},
restore_parameters={
"source_backup": "string",
"source_snapshot": "string",
},
labels={
"string": "string",
},
security_style="string",
description="string",
smb_settings=["string"],
snapshot_directory=False,
snapshot_policy={
"daily_schedule": {
"snapshots_to_keep": 0,
"hour": 0,
"minute": 0,
},
"enabled": False,
"hourly_schedule": {
"snapshots_to_keep": 0,
"minute": 0,
},
"monthly_schedule": {
"snapshots_to_keep": 0,
"days_of_month": "string",
"hour": 0,
"minute": 0,
},
"weekly_schedule": {
"snapshots_to_keep": 0,
"day": "string",
"hour": 0,
"minute": 0,
},
},
deletion_policy="string",
tiering_policy={
"cooling_threshold_days": 0,
"tier_action": "string",
},
unix_permissions="string")
const volumeResource = new gcp.netapp.Volume("volumeResource", {
location: "string",
capacityGib: "string",
storagePool: "string",
shareName: "string",
protocols: ["string"],
name: "string",
restrictedActions: ["string"],
largeCapacity: false,
kerberosEnabled: false,
multipleEndpoints: false,
backupConfig: {
backupPolicies: ["string"],
backupVault: "string",
scheduledBackupEnabled: false,
},
project: "string",
exportPolicy: {
rules: [{
accessType: "string",
allowedClients: "string",
hasRootAccess: "string",
kerberos5ReadOnly: false,
kerberos5ReadWrite: false,
kerberos5iReadOnly: false,
kerberos5iReadWrite: false,
kerberos5pReadOnly: false,
kerberos5pReadWrite: false,
nfsv3: false,
nfsv4: false,
}],
},
restoreParameters: {
sourceBackup: "string",
sourceSnapshot: "string",
},
labels: {
string: "string",
},
securityStyle: "string",
description: "string",
smbSettings: ["string"],
snapshotDirectory: false,
snapshotPolicy: {
dailySchedule: {
snapshotsToKeep: 0,
hour: 0,
minute: 0,
},
enabled: false,
hourlySchedule: {
snapshotsToKeep: 0,
minute: 0,
},
monthlySchedule: {
snapshotsToKeep: 0,
daysOfMonth: "string",
hour: 0,
minute: 0,
},
weeklySchedule: {
snapshotsToKeep: 0,
day: "string",
hour: 0,
minute: 0,
},
},
deletionPolicy: "string",
tieringPolicy: {
coolingThresholdDays: 0,
tierAction: "string",
},
unixPermissions: "string",
});
type: gcp:netapp:Volume
properties:
backupConfig:
backupPolicies:
- string
backupVault: string
scheduledBackupEnabled: false
capacityGib: string
deletionPolicy: string
description: string
exportPolicy:
rules:
- accessType: string
allowedClients: string
hasRootAccess: string
kerberos5ReadOnly: false
kerberos5ReadWrite: false
kerberos5iReadOnly: false
kerberos5iReadWrite: false
kerberos5pReadOnly: false
kerberos5pReadWrite: false
nfsv3: false
nfsv4: false
kerberosEnabled: false
labels:
string: string
largeCapacity: false
location: string
multipleEndpoints: false
name: string
project: string
protocols:
- string
restoreParameters:
sourceBackup: string
sourceSnapshot: string
restrictedActions:
- string
securityStyle: string
shareName: string
smbSettings:
- string
snapshotDirectory: false
snapshotPolicy:
dailySchedule:
hour: 0
minute: 0
snapshotsToKeep: 0
enabled: false
hourlySchedule:
minute: 0
snapshotsToKeep: 0
monthlySchedule:
daysOfMonth: string
hour: 0
minute: 0
snapshotsToKeep: 0
weeklySchedule:
day: string
hour: 0
minute: 0
snapshotsToKeep: 0
storagePool: string
tieringPolicy:
coolingThresholdDays: 0
tierAction: string
unixPermissions: string
Volume Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Volume resource accepts the following input properties:
- Capacity
Gib string - Capacity of the volume (in GiB).
- Location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- Protocols 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
. - string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- Storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- Backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- Deletion
Policy 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.
- Description string
- An optional description of this resource.
- Export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- Kerberos
Enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- Labels Dictionary<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.- Large
Capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- Multiple
Endpoints bool - 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.
- Name string
- The name of the volume. Needs to be unique per location.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- Restricted
Actions List<string> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - Security
Style 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
. - Smb
Settings 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
. - Snapshot
Directory bool - 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.
- Snapshot
Policy VolumeSnapshot Policy - 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.
- Tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- Unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- Capacity
Gib string - Capacity of the volume (in GiB).
- Location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- Protocols []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
. - string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- Storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- Backup
Config VolumeBackup Config Args - Backup configuration for the volume. Structure is documented below.
- Deletion
Policy 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.
- Description string
- An optional description of this resource.
- Export
Policy VolumeExport Policy Args - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- Kerberos
Enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- Labels 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.- Large
Capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- Multiple
Endpoints bool - 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.
- Name string
- The name of the volume. Needs to be unique per location.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Parameters VolumeRestore Parameters Args - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- Restricted
Actions []string - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - Security
Style 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
. - Smb
Settings []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
. - Snapshot
Directory bool - 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.
- Snapshot
Policy VolumeSnapshot Policy Args - 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.
- Tiering
Policy VolumeTiering Policy Args - Tiering policy for the volume. Structure is documented below.
- Unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- capacity
Gib String - Capacity of the volume (in GiB).
- location String
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- protocols 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
. - String
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- storage
Pool String - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- deletion
Policy 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.
- description String
- An optional description of this resource.
- export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- kerberos
Enabled Boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- labels 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.- large
Capacity Boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- multiple
Endpoints Boolean - 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.
- name String
- The name of the volume. Needs to be unique per location.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions List<String> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - smb
Settings 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
. - snapshot
Directory Boolean - 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.
- snapshot
Policy VolumeSnapshot Policy - 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.
- tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- unix
Permissions String - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- capacity
Gib string - Capacity of the volume (in GiB).
- location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- protocols 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
. - string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- deletion
Policy 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.
- description string
- An optional description of this resource.
- export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- kerberos
Enabled boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- labels {[key: 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.- large
Capacity boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- multiple
Endpoints boolean - 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.
- name string
- The name of the volume. Needs to be unique per location.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions string[] - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - smb
Settings 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
. - snapshot
Directory boolean - 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.
- snapshot
Policy VolumeSnapshot Policy - 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.
- tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- capacity_
gib str - Capacity of the volume (in GiB).
- location str
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- protocols Sequence[str]
- 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
. - str
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- storage_
pool str - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- backup_
config VolumeBackup Config Args - Backup configuration for the volume. Structure is documented below.
- deletion_
policy str - 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.
- description str
- An optional description of this resource.
- export_
policy VolumeExport Policy Args - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- kerberos_
enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- labels Mapping[str, str]
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.- large_
capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- multiple_
endpoints bool - 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.
- name str
- The name of the volume. Needs to be unique per location.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore_
parameters VolumeRestore Parameters Args - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted_
actions Sequence[str] - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security_
style str - 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
. - smb_
settings Sequence[str] - 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
. - snapshot_
directory bool - 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.
- snapshot_
policy VolumeSnapshot Policy Args - 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.
- tiering_
policy VolumeTiering Policy Args - Tiering policy for the volume. Structure is documented below.
- unix_
permissions str - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- capacity
Gib String - Capacity of the volume (in GiB).
- location String
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- protocols 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
. - String
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- storage
Pool String - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- backup
Config Property Map - Backup configuration for the volume. Structure is documented below.
- deletion
Policy 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.
- description String
- An optional description of this resource.
- export
Policy Property Map - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- kerberos
Enabled Boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- labels Map<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.- large
Capacity Boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- multiple
Endpoints Boolean - 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.
- name String
- The name of the volume. Needs to be unique per location.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Parameters Property Map - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions List<String> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - smb
Settings 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
. - snapshot
Directory Boolean - 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.
- snapshot
Policy Property Map - 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.
- tiering
Policy Property Map - Tiering policy for the volume. Structure is documented below.
- unix
Permissions String - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
Outputs
All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:
- Active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- Cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- Create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- Has
Replication bool - Indicates whether the volume is part of a volume replication relationship.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- Ldap
Enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- Mount
Options List<VolumeMount Option> - Reports mount instructions for this volume. Structure is documented below.
- Network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - Psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Replica
Zone string - Specifies the replica zone for regional volume.
- Service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- State string
- State of the volume.
- State
Details string - State details of the volume.
- Used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- Zone string
- Specifies the active zone for regional volume.
- Active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- Cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- Create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- Has
Replication bool - Indicates whether the volume is part of a volume replication relationship.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- Ldap
Enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- Mount
Options []VolumeMount Option - Reports mount instructions for this volume. Structure is documented below.
- Network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - Psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Replica
Zone string - Specifies the replica zone for regional volume.
- Service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- State string
- State of the volume.
- State
Details string - State details of the volume.
- Used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- Zone string
- Specifies the active zone for regional volume.
- active
Directory String - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- cold
Tier StringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time String - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type String - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- has
Replication Boolean - Indicates whether the volume is part of a volume replication relationship.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Config String - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- ldap
Enabled Boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- mount
Options List<VolumeMount Option> - Reports mount instructions for this volume. Structure is documented below.
- network String
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - psa
Range String - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone String - Specifies the replica zone for regional volume.
- service
Level String - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- state String
- State of the volume.
- state
Details String - State details of the volume.
- used
Gib String - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone String
- Specifies the active zone for regional volume.
- active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- has
Replication boolean - Indicates whether the volume is part of a volume replication relationship.
- id string
- The provider-assigned unique ID for this managed resource.
- kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- ldap
Enabled boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- mount
Options VolumeMount Option[] - Reports mount instructions for this volume. Structure is documented below.
- network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone string - Specifies the replica zone for regional volume.
- service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- state string
- State of the volume.
- state
Details string - State details of the volume.
- used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone string
- Specifies the active zone for regional volume.
- active_
directory str - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- cold_
tier_ strsize_ gib - Output only. Size of the volume cold tier data in GiB.
- create_
time str - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption_
type str - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- has_
replication bool - Indicates whether the volume is part of a volume replication relationship.
- id str
- The provider-assigned unique ID for this managed resource.
- kms_
config str - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- ldap_
enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- mount_
options Sequence[VolumeMount Option] - Reports mount instructions for this volume. Structure is documented below.
- network str
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - psa_
range str - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica_
zone str - Specifies the replica zone for regional volume.
- service_
level str - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- state str
- State of the volume.
- state_
details str - State details of the volume.
- used_
gib str - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone str
- Specifies the active zone for regional volume.
- active
Directory String - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- cold
Tier StringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time String - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type String - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- has
Replication Boolean - Indicates whether the volume is part of a volume replication relationship.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Config String - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- ldap
Enabled Boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- mount
Options List<Property Map> - Reports mount instructions for this volume. Structure is documented below.
- network String
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - psa
Range String - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone String - Specifies the replica zone for regional volume.
- service
Level String - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- state String
- State of the volume.
- state
Details String - State details of the volume.
- used
Gib String - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone String
- Specifies the active zone for regional volume.
Look up Existing Volume Resource
Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_directory: Optional[str] = None,
backup_config: Optional[VolumeBackupConfigArgs] = None,
capacity_gib: Optional[str] = None,
cold_tier_size_gib: Optional[str] = None,
create_time: Optional[str] = None,
deletion_policy: Optional[str] = None,
description: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
encryption_type: Optional[str] = None,
export_policy: Optional[VolumeExportPolicyArgs] = None,
has_replication: Optional[bool] = None,
kerberos_enabled: Optional[bool] = None,
kms_config: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
large_capacity: Optional[bool] = None,
ldap_enabled: Optional[bool] = None,
location: Optional[str] = None,
mount_options: Optional[Sequence[VolumeMountOptionArgs]] = None,
multiple_endpoints: Optional[bool] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
psa_range: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
replica_zone: Optional[str] = None,
restore_parameters: Optional[VolumeRestoreParametersArgs] = None,
restricted_actions: Optional[Sequence[str]] = None,
security_style: Optional[str] = None,
service_level: Optional[str] = None,
share_name: Optional[str] = None,
smb_settings: Optional[Sequence[str]] = None,
snapshot_directory: Optional[bool] = None,
snapshot_policy: Optional[VolumeSnapshotPolicyArgs] = None,
state: Optional[str] = None,
state_details: Optional[str] = None,
storage_pool: Optional[str] = None,
tiering_policy: Optional[VolumeTieringPolicyArgs] = None,
unix_permissions: Optional[str] = None,
used_gib: Optional[str] = None,
zone: Optional[str] = None) -> Volume
func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- Backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- Capacity
Gib string - Capacity of the volume (in GiB).
- Cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- Create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- Deletion
Policy 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.
- Description string
- An optional description of this resource.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- Export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- Has
Replication bool - Indicates whether the volume is part of a volume replication relationship.
- Kerberos
Enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- Kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- Labels Dictionary<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.- Large
Capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- Ldap
Enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- Location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- Mount
Options List<VolumeMount Option> - Reports mount instructions for this volume. Structure is documented below.
- Multiple
Endpoints bool - 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.
- Name string
- The name of the volume. Needs to be unique per location.
- Network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocols 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
. - Psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Replica
Zone string - Specifies the replica zone for regional volume.
- Restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- Restricted
Actions List<string> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - Security
Style 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
. - Service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- Smb
Settings 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
. - Snapshot
Directory bool - 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.
- Snapshot
Policy VolumeSnapshot Policy - 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.
- State string
- State of the volume.
- State
Details string - State details of the volume.
- Storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- Tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- Unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- Used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- Zone string
- Specifies the active zone for regional volume.
- Active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- Backup
Config VolumeBackup Config Args - Backup configuration for the volume. Structure is documented below.
- Capacity
Gib string - Capacity of the volume (in GiB).
- Cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- Create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- Deletion
Policy 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.
- Description string
- An optional description of this resource.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- Export
Policy VolumeExport Policy Args - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- Has
Replication bool - Indicates whether the volume is part of a volume replication relationship.
- Kerberos
Enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- Kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- Labels 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.- Large
Capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- Ldap
Enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- Location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- Mount
Options []VolumeMount Option Args - Reports mount instructions for this volume. Structure is documented below.
- Multiple
Endpoints bool - 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.
- Name string
- The name of the volume. Needs to be unique per location.
- Network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocols []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
. - Psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Replica
Zone string - Specifies the replica zone for regional volume.
- Restore
Parameters VolumeRestore Parameters Args - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- Restricted
Actions []string - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - Security
Style 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
. - Service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- Smb
Settings []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
. - Snapshot
Directory bool - 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.
- Snapshot
Policy VolumeSnapshot Policy Args - 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.
- State string
- State of the volume.
- State
Details string - State details of the volume.
- Storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- Tiering
Policy VolumeTiering Policy Args - Tiering policy for the volume. Structure is documented below.
- Unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- Used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- Zone string
- Specifies the active zone for regional volume.
- active
Directory String - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- capacity
Gib String - Capacity of the volume (in GiB).
- cold
Tier StringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time String - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- deletion
Policy 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.
- description String
- An optional description of this resource.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type String - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- has
Replication Boolean - Indicates whether the volume is part of a volume replication relationship.
- kerberos
Enabled Boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- kms
Config String - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- labels 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.- large
Capacity Boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- ldap
Enabled Boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- location String
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- mount
Options List<VolumeMount Option> - Reports mount instructions for this volume. Structure is documented below.
- multiple
Endpoints Boolean - 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.
- name String
- The name of the volume. Needs to be unique per location.
- network String
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocols 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
. - psa
Range String - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone String - Specifies the replica zone for regional volume.
- restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions List<String> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - service
Level String - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- String
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- smb
Settings 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
. - snapshot
Directory Boolean - 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.
- snapshot
Policy VolumeSnapshot Policy - 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.
- state String
- State of the volume.
- state
Details String - State details of the volume.
- storage
Pool String - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- unix
Permissions String - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- used
Gib String - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone String
- Specifies the active zone for regional volume.
- active
Directory string - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- backup
Config VolumeBackup Config - Backup configuration for the volume. Structure is documented below.
- capacity
Gib string - Capacity of the volume (in GiB).
- cold
Tier stringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time string - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- deletion
Policy 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.
- description string
- An optional description of this resource.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type string - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- export
Policy VolumeExport Policy - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- has
Replication boolean - Indicates whether the volume is part of a volume replication relationship.
- kerberos
Enabled boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- kms
Config string - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- labels {[key: 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.- large
Capacity boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- ldap
Enabled boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- location string
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- mount
Options VolumeMount Option[] - Reports mount instructions for this volume. Structure is documented below.
- multiple
Endpoints boolean - 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.
- name string
- The name of the volume. Needs to be unique per location.
- network string
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocols 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
. - psa
Range string - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone string - Specifies the replica zone for regional volume.
- restore
Parameters VolumeRestore Parameters - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions string[] - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - service
Level string - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- string
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- smb
Settings 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
. - snapshot
Directory boolean - 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.
- snapshot
Policy VolumeSnapshot Policy - 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.
- state string
- State of the volume.
- state
Details string - State details of the volume.
- storage
Pool string - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- tiering
Policy VolumeTiering Policy - Tiering policy for the volume. Structure is documented below.
- unix
Permissions string - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- used
Gib string - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone string
- Specifies the active zone for regional volume.
- active_
directory str - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- backup_
config VolumeBackup Config Args - Backup configuration for the volume. Structure is documented below.
- capacity_
gib str - Capacity of the volume (in GiB).
- cold_
tier_ strsize_ gib - Output only. Size of the volume cold tier data in GiB.
- create_
time str - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- deletion_
policy str - 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.
- description str
- An optional description of this resource.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption_
type str - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- export_
policy VolumeExport Policy Args - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- has_
replication bool - Indicates whether the volume is part of a volume replication relationship.
- kerberos_
enabled bool - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- kms_
config str - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- labels Mapping[str, str]
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.- large_
capacity bool - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- ldap_
enabled bool - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- location str
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- mount_
options Sequence[VolumeMount Option Args] - Reports mount instructions for this volume. Structure is documented below.
- multiple_
endpoints bool - 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.
- name str
- The name of the volume. Needs to be unique per location.
- network str
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocols Sequence[str]
- 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
. - psa_
range str - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica_
zone str - Specifies the replica zone for regional volume.
- restore_
parameters VolumeRestore Parameters Args - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted_
actions Sequence[str] - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security_
style str - 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
. - service_
level str - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- str
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- smb_
settings Sequence[str] - 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
. - snapshot_
directory bool - 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.
- snapshot_
policy VolumeSnapshot Policy Args - 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.
- state str
- State of the volume.
- state_
details str - State details of the volume.
- storage_
pool str - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- tiering_
policy VolumeTiering Policy Args - Tiering policy for the volume. Structure is documented below.
- unix_
permissions str - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- used_
gib str - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone str
- Specifies the active zone for regional volume.
- active
Directory String - Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
- backup
Config Property Map - Backup configuration for the volume. Structure is documented below.
- capacity
Gib String - Capacity of the volume (in GiB).
- cold
Tier StringSize Gib - Output only. Size of the volume cold tier data in GiB.
- create
Time String - Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
- deletion
Policy 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.
- description String
- An optional description of this resource.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Type String - Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
- export
Policy Property Map - Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
- has
Replication Boolean - Indicates whether the volume is part of a volume replication relationship.
- kerberos
Enabled Boolean - Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
- kms
Config String - Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
- labels Map<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.- large
Capacity Boolean - Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
- ldap
Enabled Boolean - Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
- location String
- Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
- mount
Options List<Property Map> - Reports mount instructions for this volume. Structure is documented below.
- multiple
Endpoints Boolean - 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.
- name String
- The name of the volume. Needs to be unique per location.
- network String
- VPC network name with format:
projects/{{project}}/global/networks/{{network}}
. Inherited from storage pool. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocols 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
. - psa
Range String - Name of the Private Service Access allocated range. Inherited from storage pool.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- replica
Zone String - Specifies the replica zone for regional volume.
- restore
Parameters Property Map - Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
- restricted
Actions List<String> - List of actions that are restricted on this volume.
Each value may be one of:
DELETE
. - security
Style 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
. - service
Level String - Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
- String
- Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
- smb
Settings 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
. - snapshot
Directory Boolean - 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.
- snapshot
Policy Property Map - 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.
- state String
- State of the volume.
- state
Details String - State details of the volume.
- storage
Pool String - Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
- tiering
Policy Property Map - Tiering policy for the volume. Structure is documented below.
- unix
Permissions String - Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
- used
Gib String - Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
- zone String
- Specifies the active zone for regional volume.
Supporting Types
VolumeBackupConfig, VolumeBackupConfigArgs
- Backup
Policies List<string> - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- Backup
Vault string - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- Scheduled
Backup boolEnabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
- Backup
Policies []string - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- Backup
Vault string - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- Scheduled
Backup boolEnabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
- backup
Policies List<String> - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- backup
Vault String - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- scheduled
Backup BooleanEnabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
- backup
Policies string[] - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- backup
Vault string - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- scheduled
Backup booleanEnabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
- backup_
policies Sequence[str] - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- backup_
vault str - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- scheduled_
backup_ boolenabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
- backup
Policies List<String> - Specify a single backup policy ID for scheduled backups. Format:
projects/{{projectId}}/locations/{{location}}/backupPolicies/{{backupPolicyName}}
- backup
Vault String - ID of the backup vault to use. A backup vault is reqired to create manual or scheduled backups.
Format:
projects/{{projectId}}/locations/{{location}}/backupVaults/{{backupVaultName}}
- scheduled
Backup BooleanEnabled - When set to true, scheduled backup is enabled on the volume. Omit if no backup_policy is specified.
VolumeExportPolicy, VolumeExportPolicyArgs
- Rules
List<Volume
Export Policy Rule> - Export rules (up to 5) control NFS volume access. Structure is documented below.
- Rules
[]Volume
Export Policy Rule - Export rules (up to 5) control NFS volume access. Structure is documented below.
- rules
List<Volume
Export Policy Rule> - Export rules (up to 5) control NFS volume access. Structure is documented below.
- rules
Volume
Export Policy Rule[] - Export rules (up to 5) control NFS volume access. Structure is documented below.
- rules
Sequence[Volume
Export Policy Rule] - Export rules (up to 5) control NFS volume access. Structure is documented below.
- rules List<Property Map>
- Export rules (up to 5) control NFS volume access. Structure is documented below.
VolumeExportPolicyRule, VolumeExportPolicyRuleArgs
- Access
Type string - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - Allowed
Clients string - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- Has
Root stringAccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- Kerberos5Read
Only bool - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- Kerberos5Read
Write bool - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- Kerberos5i
Read boolOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- Kerberos5i
Read boolWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- Kerberos5p
Read boolOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- Kerberos5p
Read boolWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- Nfsv3 bool
- Enable to apply the export rule to NFSV3 clients.
- Nfsv4 bool
- Enable to apply the export rule to NFSV4.1 clients.
- Access
Type string - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - Allowed
Clients string - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- Has
Root stringAccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- Kerberos5Read
Only bool - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- Kerberos5Read
Write bool - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- Kerberos5i
Read boolOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- Kerberos5i
Read boolWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- Kerberos5p
Read boolOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- Kerberos5p
Read boolWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- Nfsv3 bool
- Enable to apply the export rule to NFSV3 clients.
- Nfsv4 bool
- Enable to apply the export rule to NFSV4.1 clients.
- access
Type String - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - allowed
Clients String - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- has
Root StringAccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- kerberos5Read
Only Boolean - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- kerberos5Read
Write Boolean - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- kerberos5i
Read BooleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- kerberos5i
Read BooleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- kerberos5p
Read BooleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- kerberos5p
Read BooleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- nfsv3 Boolean
- Enable to apply the export rule to NFSV3 clients.
- nfsv4 Boolean
- Enable to apply the export rule to NFSV4.1 clients.
- access
Type string - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - allowed
Clients string - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- has
Root stringAccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- kerberos5Read
Only boolean - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- kerberos5Read
Write boolean - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- kerberos5i
Read booleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- kerberos5i
Read booleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- kerberos5p
Read booleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- kerberos5p
Read booleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- nfsv3 boolean
- Enable to apply the export rule to NFSV3 clients.
- nfsv4 boolean
- Enable to apply the export rule to NFSV4.1 clients.
- access_
type str - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - allowed_
clients str - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- has_
root_ straccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- kerberos5_
read_ boolonly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- kerberos5_
read_ boolwrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- kerberos5i_
read_ boolonly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- kerberos5i_
read_ boolwrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- kerberos5p_
read_ boolonly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- kerberos5p_
read_ boolwrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- nfsv3 bool
- Enable to apply the export rule to NFSV3 clients.
- nfsv4 bool
- Enable to apply the export rule to NFSV4.1 clients.
- access
Type String - Defines the access type for clients matching the
allowedClients
specification. Possible values are:READ_ONLY
,READ_WRITE
,READ_NONE
. - allowed
Clients String - Defines the client ingress specification (allowed clients) as a comma seperated list with IPv4 CIDRs or IPv4 host addresses.
- has
Root StringAccess - If enabled, the root user (UID = 0) of the specified clients doesn't get mapped to nobody (UID = 65534). This is also known as no_root_squash.
- kerberos5Read
Only Boolean - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
- kerberos5Read
Write Boolean - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value is ignored if this is enabled.
- kerberos5i
Read BooleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
- kerberos5i
Read BooleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value is ignored if this is enabled.
- kerberos5p
Read BooleanOnly - If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
- kerberos5p
Read BooleanWrite - If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value is ignored if this is enabled.
- nfsv3 Boolean
- Enable to apply the export rule to NFSV3 clients.
- nfsv4 Boolean
- Enable to apply the export rule to NFSV4.1 clients.
VolumeMountOption, VolumeMountOptionArgs
- Export string
- (Output) Export path of the volume.
- Export
Full string - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- Instructions string
- (Output) Human-readable mount instructions.
- Protocol string
- (Output) Protocol to mount with.
- Export string
- (Output) Export path of the volume.
- Export
Full string - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- Instructions string
- (Output) Human-readable mount instructions.
- Protocol string
- (Output) Protocol to mount with.
- export String
- (Output) Export path of the volume.
- export
Full String - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- instructions String
- (Output) Human-readable mount instructions.
- protocol String
- (Output) Protocol to mount with.
- export string
- (Output) Export path of the volume.
- export
Full string - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- instructions string
- (Output) Human-readable mount instructions.
- protocol string
- (Output) Protocol to mount with.
- export str
- (Output) Export path of the volume.
- export_
full str - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- instructions str
- (Output) Human-readable mount instructions.
- protocol str
- (Output) Protocol to mount with.
- export String
- (Output) Export path of the volume.
- export
Full String - (Output)
Full export path of the volume.
Format for NFS volumes:
<export_ip>:/<shareName>
Format for SMB volumes:\\\\netbios_prefix-four_random_hex_letters.domain_name\\shareName
- instructions String
- (Output) Human-readable mount instructions.
- protocol String
- (Output) Protocol to mount with.
VolumeRestoreParameters, VolumeRestoreParametersArgs
- Source
Backup string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - Source
Snapshot string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
- Source
Backup string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - Source
Snapshot string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
- source
Backup String - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - source
Snapshot String - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
- source
Backup string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - source
Snapshot string - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
- source_
backup str - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - source_
snapshot str - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
- source
Backup String - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/backupVaults/{{backupVaultId}}/backups/{{backup}}
. - source
Snapshot String - Full name of the snapshot to use for creating this volume.
source_snapshot
andsource_backup
cannot be used simultaneously. Format:projects/{{project}}/locations/{{location}}/volumes/{{volume}}/snapshots/{{snapshot}}
.
VolumeSnapshotPolicy, VolumeSnapshotPolicyArgs
- Daily
Schedule VolumeSnapshot Policy Daily Schedule - Daily schedule policy. Structure is documented below.
- Enabled bool
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- Hourly
Schedule VolumeSnapshot Policy Hourly Schedule - Hourly schedule policy. Structure is documented below.
- Monthly
Schedule VolumeSnapshot Policy Monthly Schedule - Monthly schedule policy. Structure is documented below.
- Weekly
Schedule VolumeSnapshot Policy Weekly Schedule - Weekly schedule policy. Structure is documented below.
- Daily
Schedule VolumeSnapshot Policy Daily Schedule - Daily schedule policy. Structure is documented below.
- Enabled bool
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- Hourly
Schedule VolumeSnapshot Policy Hourly Schedule - Hourly schedule policy. Structure is documented below.
- Monthly
Schedule VolumeSnapshot Policy Monthly Schedule - Monthly schedule policy. Structure is documented below.
- Weekly
Schedule VolumeSnapshot Policy Weekly Schedule - Weekly schedule policy. Structure is documented below.
- daily
Schedule VolumeSnapshot Policy Daily Schedule - Daily schedule policy. Structure is documented below.
- enabled Boolean
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- hourly
Schedule VolumeSnapshot Policy Hourly Schedule - Hourly schedule policy. Structure is documented below.
- monthly
Schedule VolumeSnapshot Policy Monthly Schedule - Monthly schedule policy. Structure is documented below.
- weekly
Schedule VolumeSnapshot Policy Weekly Schedule - Weekly schedule policy. Structure is documented below.
- daily
Schedule VolumeSnapshot Policy Daily Schedule - Daily schedule policy. Structure is documented below.
- enabled boolean
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- hourly
Schedule VolumeSnapshot Policy Hourly Schedule - Hourly schedule policy. Structure is documented below.
- monthly
Schedule VolumeSnapshot Policy Monthly Schedule - Monthly schedule policy. Structure is documented below.
- weekly
Schedule VolumeSnapshot Policy Weekly Schedule - Weekly schedule policy. Structure is documented below.
- daily_
schedule VolumeSnapshot Policy Daily Schedule - Daily schedule policy. Structure is documented below.
- enabled bool
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- hourly_
schedule VolumeSnapshot Policy Hourly Schedule - Hourly schedule policy. Structure is documented below.
- monthly_
schedule VolumeSnapshot Policy Monthly Schedule - Monthly schedule policy. Structure is documented below.
- weekly_
schedule VolumeSnapshot Policy Weekly Schedule - Weekly schedule policy. Structure is documented below.
- daily
Schedule Property Map - Daily schedule policy. Structure is documented below.
- enabled Boolean
- Enables automated snapshot creation according to defined schedule. Default is false. To disable automatic snapshot creation you have to remove the whole snapshot_policy block.
- hourly
Schedule Property Map - Hourly schedule policy. Structure is documented below.
- monthly
Schedule Property Map - Monthly schedule policy. Structure is documented below.
- weekly
Schedule Property Map - Weekly schedule policy. Structure is documented below.
VolumeSnapshotPolicyDailySchedule, VolumeSnapshotPolicyDailyScheduleArgs
- Snapshots
To intKeep - The maximum number of snapshots to keep for the daily schedule.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- Snapshots
To intKeep - The maximum number of snapshots to keep for the daily schedule.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To IntegerKeep - The maximum number of snapshots to keep for the daily schedule.
- hour Integer
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Integer
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To numberKeep - The maximum number of snapshots to keep for the daily schedule.
- hour number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots_
to_ intkeep - The maximum number of snapshots to keep for the daily schedule.
- hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To NumberKeep - The maximum number of snapshots to keep for the daily schedule.
- hour Number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
VolumeSnapshotPolicyHourlySchedule, VolumeSnapshotPolicyHourlyScheduleArgs
- Snapshots
To intKeep - The maximum number of snapshots to keep for the hourly schedule.
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- Snapshots
To intKeep - The maximum number of snapshots to keep for the hourly schedule.
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To IntegerKeep - The maximum number of snapshots to keep for the hourly schedule.
- minute Integer
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To numberKeep - The maximum number of snapshots to keep for the hourly schedule.
- minute number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots_
to_ intkeep - The maximum number of snapshots to keep for the hourly schedule.
- minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To NumberKeep - The maximum number of snapshots to keep for the hourly schedule.
- minute Number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
VolumeSnapshotPolicyMonthlySchedule, VolumeSnapshotPolicyMonthlyScheduleArgs
- Snapshots
To intKeep - The maximum number of snapshots to keep for the monthly schedule
- Days
Of stringMonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- Snapshots
To intKeep - The maximum number of snapshots to keep for the monthly schedule
- Days
Of stringMonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To IntegerKeep - The maximum number of snapshots to keep for the monthly schedule
- days
Of StringMonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- hour Integer
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Integer
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To numberKeep - The maximum number of snapshots to keep for the monthly schedule
- days
Of stringMonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- hour number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots_
to_ intkeep - The maximum number of snapshots to keep for the monthly schedule
- days_
of_ strmonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To NumberKeep - The maximum number of snapshots to keep for the monthly schedule
- days
Of StringMonth - Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
- hour Number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
VolumeSnapshotPolicyWeeklySchedule, VolumeSnapshotPolicyWeeklyScheduleArgs
- Snapshots
To intKeep - The maximum number of snapshots to keep for the weekly schedule.
- Day string
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- Snapshots
To intKeep - The maximum number of snapshots to keep for the weekly schedule.
- Day string
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- Hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- Minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To IntegerKeep - The maximum number of snapshots to keep for the weekly schedule.
- day String
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- hour Integer
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Integer
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To numberKeep - The maximum number of snapshots to keep for the weekly schedule.
- day string
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- hour number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots_
to_ intkeep - The maximum number of snapshots to keep for the weekly schedule.
- day str
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- hour int
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute int
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
- snapshots
To NumberKeep - The maximum number of snapshots to keep for the weekly schedule.
- day String
- Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
- hour Number
- Set the hour to create the snapshot (0-23), defaults to midnight (0).
- minute Number
- Set the minute of the hour to create the snapshot (0-59), defaults to the top of the hour (0).
VolumeTieringPolicy, VolumeTieringPolicyArgs
- Cooling
Threshold intDays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- Tier
Action string - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
- Cooling
Threshold intDays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- Tier
Action string - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
- cooling
Threshold IntegerDays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- tier
Action String - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
- cooling
Threshold numberDays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- tier
Action string - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
- cooling_
threshold_ intdays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- tier_
action str - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
- cooling
Threshold NumberDays - Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
- tier
Action String - Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
Default value is
PAUSED
. Possible values are:ENABLED
,PAUSED
.
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}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.