published on Monday, Oct 5, 2026 by OVHcloud
published on Monday, Oct 5, 2026 by OVHcloud
Creates a file storage share (NFS) in a public cloud project.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";
const share = new ovh.CloudStorageFileShare("share", {
serviceName: "<Public cloud project id>",
name: "my-share",
size: 150,
region: "GRA1",
protocol: "NFS",
shareType: "STANDARD_1AZ",
shareNetworkId: "<share network id>",
description: "My NFS share",
encryption: {
enabled: true,
},
});
import pulumi
import pulumi_ovh as ovh
share = ovh.CloudStorageFileShare("share",
service_name="<Public cloud project id>",
name="my-share",
size=150,
region="GRA1",
protocol="NFS",
share_type="STANDARD_1AZ",
share_network_id="<share network id>",
description="My NFS share",
encryption={
"enabled": True,
})
package main
import (
"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ovh.NewCloudStorageFileShare(ctx, "share", &ovh.CloudStorageFileShareArgs{
ServiceName: pulumi.String("<Public cloud project id>"),
Name: pulumi.String("my-share"),
Size: pulumi.Int(150),
Region: pulumi.String("GRA1"),
Protocol: pulumi.String("NFS"),
ShareType: pulumi.String("STANDARD_1AZ"),
ShareNetworkId: pulumi.String("<share network id>"),
Description: pulumi.String("My NFS share"),
Encryption: &ovh.CloudStorageFileShareEncryptionArgs{
Enabled: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var share = new Ovh.CloudStorageFileShare("share", new()
{
ServiceName = "<Public cloud project id>",
Name = "my-share",
Size = 150,
Region = "GRA1",
Protocol = "NFS",
ShareType = "STANDARD_1AZ",
ShareNetworkId = "<share network id>",
Description = "My NFS share",
Encryption = new Ovh.Inputs.CloudStorageFileShareEncryptionArgs
{
Enabled = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudStorageFileShare;
import com.ovhcloud.pulumi.ovh.CloudStorageFileShareArgs;
import com.pulumi.ovh.inputs.CloudStorageFileShareEncryptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var share = new CloudStorageFileShare("share", CloudStorageFileShareArgs.builder()
.serviceName("<Public cloud project id>")
.name("my-share")
.size(150)
.region("GRA1")
.protocol("NFS")
.shareType("STANDARD_1AZ")
.shareNetworkId("<share network id>")
.description("My NFS share")
.encryption(CloudStorageFileShareEncryptionArgs.builder()
.enabled(true)
.build())
.build());
}
}
resources:
share:
type: ovh:CloudStorageFileShare
properties:
serviceName: <Public cloud project id>
name: my-share
size: 150
region: GRA1
protocol: NFS
shareType: STANDARD_1AZ
shareNetworkId: <share network id>
description: My NFS share
encryption:
enabled: true
Example coming soon!
Create from a snapshot
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
snapshot:
type: ovh:CloudStorageFileShareSnapshot
properties:
serviceName: ${share.serviceName}
shareId: ${share.id}
name: my-snapshot
shareFromSnapshot:
type: ovh:CloudStorageFileShare
name: share_from_snapshot
properties:
serviceName: ${share.serviceName}
name: my-share-from-snapshot
region: GRA1
protocol: NFS
createFrom:
snapshot_id: ${snapshot.id}
Example coming soon!
When create_from is set, the new file share takes its share_type, encryption and, if omitted, share_network_id from the snapshot’s source file share, and its size from the snapshot if omitted. The snapshot must be available and in the same region.
Create CloudStorageFileShare Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CloudStorageFileShare(name: string, args: CloudStorageFileShareArgs, opts?: CustomResourceOptions);@overload
def CloudStorageFileShare(resource_name: str,
args: CloudStorageFileShareArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CloudStorageFileShare(resource_name: str,
opts: Optional[ResourceOptions] = None,
protocol: Optional[str] = None,
region: Optional[str] = None,
service_name: Optional[str] = None,
availability_zone: Optional[str] = None,
create_from: Optional[CloudStorageFileShareCreateFromArgs] = None,
description: Optional[str] = None,
encryption: Optional[CloudStorageFileShareEncryptionArgs] = None,
name: Optional[str] = None,
share_network_id: Optional[str] = None,
share_type: Optional[str] = None,
size: Optional[int] = None)func NewCloudStorageFileShare(ctx *Context, name string, args CloudStorageFileShareArgs, opts ...ResourceOption) (*CloudStorageFileShare, error)public CloudStorageFileShare(string name, CloudStorageFileShareArgs args, CustomResourceOptions? opts = null)
public CloudStorageFileShare(String name, CloudStorageFileShareArgs args)
public CloudStorageFileShare(String name, CloudStorageFileShareArgs args, CustomResourceOptions options)
type: ovh:CloudStorageFileShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "ovh_cloud_storage_file_share" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CloudStorageFileShareArgs
- 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 CloudStorageFileShareArgs
- 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 CloudStorageFileShareArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudStorageFileShareArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudStorageFileShareArgs
- 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 cloudStorageFileShareResource = new Ovh.CloudStorageFileShare("cloudStorageFileShareResource", new()
{
Protocol = "string",
Region = "string",
ServiceName = "string",
AvailabilityZone = "string",
CreateFrom = new Ovh.Inputs.CloudStorageFileShareCreateFromArgs
{
SnapshotId = "string",
},
Description = "string",
Encryption = new Ovh.Inputs.CloudStorageFileShareEncryptionArgs
{
Enabled = false,
},
Name = "string",
ShareNetworkId = "string",
ShareType = "string",
Size = 0,
});
example, err := ovh.NewCloudStorageFileShare(ctx, "cloudStorageFileShareResource", &ovh.CloudStorageFileShareArgs{
Protocol: pulumi.String("string"),
Region: pulumi.String("string"),
ServiceName: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
CreateFrom: &ovh.CloudStorageFileShareCreateFromArgs{
SnapshotId: pulumi.String("string"),
},
Description: pulumi.String("string"),
Encryption: &ovh.CloudStorageFileShareEncryptionArgs{
Enabled: pulumi.Bool(false),
},
Name: pulumi.String("string"),
ShareNetworkId: pulumi.String("string"),
ShareType: pulumi.String("string"),
Size: pulumi.Int(0),
})
resource "ovh_cloud_storage_file_share" "cloudStorageFileShareResource" {
lifecycle {
create_before_destroy = true
}
protocol = "string"
region = "string"
service_name = "string"
availability_zone = "string"
create_from = {
snapshot_id = "string"
}
description = "string"
encryption = {
enabled = false
}
name = "string"
share_network_id = "string"
share_type = "string"
size = 0
}
var cloudStorageFileShareResource = new CloudStorageFileShare("cloudStorageFileShareResource", CloudStorageFileShareArgs.builder()
.protocol("string")
.region("string")
.serviceName("string")
.availabilityZone("string")
.createFrom(CloudStorageFileShareCreateFromArgs.builder()
.snapshotId("string")
.build())
.description("string")
.encryption(CloudStorageFileShareEncryptionArgs.builder()
.enabled(false)
.build())
.name("string")
.shareNetworkId("string")
.shareType("string")
.size(0)
.build());
cloud_storage_file_share_resource = ovh.CloudStorageFileShare("cloudStorageFileShareResource",
protocol="string",
region="string",
service_name="string",
availability_zone="string",
create_from={
"snapshot_id": "string",
},
description="string",
encryption={
"enabled": False,
},
name="string",
share_network_id="string",
share_type="string",
size=0)
const cloudStorageFileShareResource = new ovh.CloudStorageFileShare("cloudStorageFileShareResource", {
protocol: "string",
region: "string",
serviceName: "string",
availabilityZone: "string",
createFrom: {
snapshotId: "string",
},
description: "string",
encryption: {
enabled: false,
},
name: "string",
shareNetworkId: "string",
shareType: "string",
size: 0,
});
type: ovh:CloudStorageFileShare
properties:
availabilityZone: string
createFrom:
snapshotId: string
description: string
encryption:
enabled: false
name: string
protocol: string
region: string
serviceName: string
shareNetworkId: string
shareType: string
size: 0
CloudStorageFileShare 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 CloudStorageFileShare resource accepts the following input properties:
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - Region string
- Region where the file share will be created. Changing this value recreates the resource.
- Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Name string
- File share name.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - Region string
- Region where the file share will be created. Changing this value recreates the resource.
- Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Create
From CloudStorage File Share Create From Args - Source to create the file share from. Changing this value recreates the resource.
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Encryption Args - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Name string
- File share name.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - region string
- Region where the file share will be created. Changing this value recreates the resource.
- service_
name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- availability_
zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- create_
from object - Source to create the file share from. Changing this value recreates the resource.
- description string
- File share description.
- encryption object
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name string
- File share name.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - region String
- Region where the file share will be created. Changing this value recreates the resource.
- service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- description String
- File share description.
- encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name String
- File share name.
- String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Integer
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - region string
- Region where the file share will be created. Changing this value recreates the resource.
- service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- description string
- File share description.
- encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name string
- File share name.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- protocol str
- File share protocol (
NFS). Changing this value recreates the resource. - region str
- Region where the file share will be created. Changing this value recreates the resource.
- service_
name str - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- availability_
zone str - Availability zone where the file share will be created. Changing this value recreates the resource.
- create_
from CloudStorage File Share Create From Args - Source to create the file share from. Changing this value recreates the resource.
- description str
- File share description.
- encryption
Cloud
Storage File Share Encryption Args - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name str
- File share name.
- str
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - str
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - region String
- Region where the file share will be created. Changing this value recreates the resource.
- service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- create
From Property Map - Source to create the file share from. Changing this value recreates the resource.
- description String
- File share description.
- encryption Property Map
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name String
- File share name.
- String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudStorageFileShare resource produces the following output properties:
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the file share.
- Current
State CloudStorage File Share Current State - Current state of the file storage share:
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the file share.
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the file share.
- Current
State CloudStorage File Share Current State - Current state of the file storage share:
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the file share.
- checksum string
- Computed hash representing the current target specification value.
- created_
at string - Creation date of the file share.
- current_
state object - Current state of the file storage share:
- id string
- The provider-assigned unique ID for this managed resource.
- resource_
status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at string - Last update date of the file share.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the file share.
- current
State CloudStorage File Share Current State - Current state of the file storage share:
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Status String - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the file share.
- checksum string
- Computed hash representing the current target specification value.
- created
At string - Creation date of the file share.
- current
State CloudStorage File Share Current State - Current state of the file storage share:
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At string - Last update date of the file share.
- checksum str
- Computed hash representing the current target specification value.
- created_
at str - Creation date of the file share.
- current_
state CloudStorage File Share Current State - Current state of the file storage share:
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
status str - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at str - Last update date of the file share.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the file share.
- current
State Property Map - Current state of the file storage share:
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Status String - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the file share.
Look up Existing CloudStorageFileShare Resource
Get an existing CloudStorageFileShare 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?: CloudStorageFileShareState, opts?: CustomResourceOptions): CloudStorageFileShare@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
availability_zone: Optional[str] = None,
checksum: Optional[str] = None,
create_from: Optional[CloudStorageFileShareCreateFromArgs] = None,
created_at: Optional[str] = None,
current_state: Optional[CloudStorageFileShareCurrentStateArgs] = None,
description: Optional[str] = None,
encryption: Optional[CloudStorageFileShareEncryptionArgs] = None,
name: Optional[str] = None,
protocol: Optional[str] = None,
region: Optional[str] = None,
resource_status: Optional[str] = None,
service_name: Optional[str] = None,
share_network_id: Optional[str] = None,
share_type: Optional[str] = None,
size: Optional[int] = None,
updated_at: Optional[str] = None) -> CloudStorageFileSharefunc GetCloudStorageFileShare(ctx *Context, name string, id IDInput, state *CloudStorageFileShareState, opts ...ResourceOption) (*CloudStorageFileShare, error)public static CloudStorageFileShare Get(string name, Input<string> id, CloudStorageFileShareState? state, CustomResourceOptions? opts = null)public static CloudStorageFileShare get(String name, Output<String> id, CloudStorageFileShareState state, CustomResourceOptions options)resources: _: type: ovh:CloudStorageFileShare get: id: ${id}import {
to = ovh_cloud_storage_file_share.example
id = "${id}"
}
- 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.
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Checksum string
- Computed hash representing the current target specification value.
- Create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- Created
At string - Creation date of the file share.
- Current
State CloudStorage File Share Current State - Current state of the file storage share:
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Name string
- File share name.
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - Region string
- Region where the file share will be created. Changing this value recreates the resource.
- Resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - Updated
At string - Last update date of the file share.
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Checksum string
- Computed hash representing the current target specification value.
- Create
From CloudStorage File Share Create From Args - Source to create the file share from. Changing this value recreates the resource.
- Created
At string - Creation date of the file share.
- Current
State CloudStorage File Share Current State Args - Current state of the file storage share:
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Encryption Args - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Name string
- File share name.
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - Region string
- Region where the file share will be created. Changing this value recreates the resource.
- Resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - Updated
At string - Last update date of the file share.
- availability_
zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- checksum string
- Computed hash representing the current target specification value.
- create_
from object - Source to create the file share from. Changing this value recreates the resource.
- created_
at string - Creation date of the file share.
- current_
state object - Current state of the file storage share:
- description string
- File share description.
- encryption object
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name string
- File share name.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - region string
- Region where the file share will be created. Changing this value recreates the resource.
- resource_
status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - service_
name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - updated_
at string - Last update date of the file share.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- checksum String
- Computed hash representing the current target specification value.
- create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- created
At String - Creation date of the file share.
- current
State CloudStorage File Share Current State - Current state of the file storage share:
- description String
- File share description.
- encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name String
- File share name.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - region String
- Region where the file share will be created. Changing this value recreates the resource.
- resource
Status String - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Integer
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - updated
At String - Last update date of the file share.
- availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- checksum string
- Computed hash representing the current target specification value.
- create
From CloudStorage File Share Create From - Source to create the file share from. Changing this value recreates the resource.
- created
At string - Creation date of the file share.
- current
State CloudStorage File Share Current State - Current state of the file storage share:
- description string
- File share description.
- encryption
Cloud
Storage File Share Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name string
- File share name.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - region string
- Region where the file share will be created. Changing this value recreates the resource.
- resource
Status string - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - updated
At string - Last update date of the file share.
- availability_
zone str - Availability zone where the file share will be created. Changing this value recreates the resource.
- checksum str
- Computed hash representing the current target specification value.
- create_
from CloudStorage File Share Create From Args - Source to create the file share from. Changing this value recreates the resource.
- created_
at str - Creation date of the file share.
- current_
state CloudStorage File Share Current State Args - Current state of the file storage share:
- description str
- File share description.
- encryption
Cloud
Storage File Share Encryption Args - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name str
- File share name.
- protocol str
- File share protocol (
NFS). Changing this value recreates the resource. - region str
- Region where the file share will be created. Changing this value recreates the resource.
- resource_
status str - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - service_
name str - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- str
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - str
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - updated_
at str - Last update date of the file share.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- checksum String
- Computed hash representing the current target specification value.
- create
From Property Map - Source to create the file share from. Changing this value recreates the resource.
- created
At String - Creation date of the file share.
- current
State Property Map - Current state of the file storage share:
- description String
- File share description.
- encryption Property Map
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - name String
- File share name.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - region String
- Region where the file share will be created. Changing this value recreates the resource.
- resource
Status String - File share readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it. - updated
At String - Last update date of the file share.
Supporting Types
CloudStorageFileShareCreateFrom, CloudStorageFileShareCreateFromArgs
- Snapshot
Id string - Identifier of an
availablefile share snapshot of the same project and region.
- Snapshot
Id string - Identifier of an
availablefile share snapshot of the same project and region.
- snapshot_
id string - Identifier of an
availablefile share snapshot of the same project and region.
- snapshot
Id String - Identifier of an
availablefile share snapshot of the same project and region.
- snapshot
Id string - Identifier of an
availablefile share snapshot of the same project and region.
- snapshot_
id str - Identifier of an
availablefile share snapshot of the same project and region.
- snapshot
Id String - Identifier of an
availablefile share snapshot of the same project and region.
CloudStorageFileShareCurrentState, CloudStorageFileShareCurrentStateArgs
- Capabilities
List<Cloud
Storage File Share Current State Capability> - Action-availability flags derived from the file share status:
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Current State Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Export
Locations List<CloudStorage File Share Current State Export Location> - Export locations for the file share:
- Location
Cloud
Storage File Share Current State Location - Current location:
- Name string
- File share name.
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- Capabilities
[]Cloud
Storage File Share Current State Capability - Action-availability flags derived from the file share status:
- Description string
- File share description.
- Encryption
Cloud
Storage File Share Current State Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - Export
Locations []CloudStorage File Share Current State Export Location - Export locations for the file share:
- Location
Cloud
Storage File Share Current State Location - Current location:
- Name string
- File share name.
- Protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - Size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- capabilities list(object)
- Action-availability flags derived from the file share status:
- description string
- File share description.
- encryption object
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - export_
locations list(object) - Export locations for the file share:
- location object
- Current location:
- name string
- File share name.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- capabilities
List<Cloud
Storage File Share Current State Capability> - Action-availability flags derived from the file share status:
- description String
- File share description.
- encryption
Cloud
Storage File Share Current State Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - export
Locations List<CloudStorage File Share Current State Export Location> - Export locations for the file share:
- location
Cloud
Storage File Share Current State Location - Current location:
- name String
- File share name.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Integer
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- capabilities
Cloud
Storage File Share Current State Capability[] - Action-availability flags derived from the file share status:
- description string
- File share description.
- encryption
Cloud
Storage File Share Current State Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - export
Locations CloudStorage File Share Current State Export Location[] - Export locations for the file share:
- location
Cloud
Storage File Share Current State Location - Current location:
- name string
- File share name.
- protocol string
- File share protocol (
NFS). Changing this value recreates the resource. - string
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - string
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- capabilities
Sequence[Cloud
Storage File Share Current State Capability] - Action-availability flags derived from the file share status:
- description str
- File share description.
- encryption
Cloud
Storage File Share Current State Encryption - Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - export_
locations Sequence[CloudStorage File Share Current State Export Location] - Export locations for the file share:
- location
Cloud
Storage File Share Current State Location - Current location:
- name str
- File share name.
- protocol str
- File share protocol (
NFS). Changing this value recreates the resource. - str
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - str
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size int
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
- capabilities List<Property Map>
- Action-availability flags derived from the file share status:
- description String
- File share description.
- encryption Property Map
- Encryption configuration for the file share. Set at creation only. With
create_from, the encryption of the snapshot's source file share is used: leave it unset or set it to that value;enabled = trueon a snapshot of an unencrypted file share is rejected. Changing this value recreates the resource. - export
Locations List<Property Map> - Export locations for the file share:
- location Property Map
- Current location:
- name String
- File share name.
- protocol String
- File share protocol (
NFS). Changing this value recreates the resource. - String
- ID of a pre-existing share network to attach the file share to. Required unless
create_fromis set. Withcreate_from, defaults to the share network of the snapshot's source file share and must be that same share network when set. Changing this value recreates the resource. - String
- File share type (e.g.
STANDARD_1AZ). Required unlesscreate_fromis set. Withcreate_from, the type of the snapshot's source file share is used: leave it unset or set it to that value. Changing this value recreates the resource. - size Number
- Size of the file share in GB. Required unless
create_fromis set. Withcreate_from, defaults to the snapshot size and must not be smaller than it.
CloudStorageFileShareCurrentStateCapability, CloudStorageFileShareCurrentStateCapabilityArgs
CloudStorageFileShareCurrentStateEncryption, CloudStorageFileShareCurrentStateEncryptionArgs
- Enabled bool
- Whether the file share is encrypted at rest with LUKS.
- Enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled Boolean
- Whether the file share is encrypted at rest with LUKS.
- enabled boolean
- Whether the file share is encrypted at rest with LUKS.
- enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled Boolean
- Whether the file share is encrypted at rest with LUKS.
CloudStorageFileShareCurrentStateExportLocation, CloudStorageFileShareCurrentStateExportLocationArgs
CloudStorageFileShareCurrentStateLocation, CloudStorageFileShareCurrentStateLocationArgs
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Region string
- Region where the file share will be created. Changing this value recreates the resource.
- Availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- Region string
- Region where the file share will be created. Changing this value recreates the resource.
- availability_
zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- region string
- Region where the file share will be created. Changing this value recreates the resource.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- region String
- Region where the file share will be created. Changing this value recreates the resource.
- availability
Zone string - Availability zone where the file share will be created. Changing this value recreates the resource.
- region string
- Region where the file share will be created. Changing this value recreates the resource.
- availability_
zone str - Availability zone where the file share will be created. Changing this value recreates the resource.
- region str
- Region where the file share will be created. Changing this value recreates the resource.
- availability
Zone String - Availability zone where the file share will be created. Changing this value recreates the resource.
- region String
- Region where the file share will be created. Changing this value recreates the resource.
CloudStorageFileShareEncryption, CloudStorageFileShareEncryptionArgs
- Enabled bool
- Whether the file share is encrypted at rest with LUKS.
- Enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled Boolean
- Whether the file share is encrypted at rest with LUKS.
- enabled boolean
- Whether the file share is encrypted at rest with LUKS.
- enabled bool
- Whether the file share is encrypted at rest with LUKS.
- enabled Boolean
- Whether the file share is encrypted at rest with LUKS.
Import
A cloud storage file share can be imported using the service_name and file_share_id, separated by /:
terraform
import {
to = ovh_cloud_storage_file_share.share
id = “<service_name>/<file_share_id>”
}
bash
$ pulumi import ovh:index/cloudStorageFileShare:CloudStorageFileShare share service_name/file_share_id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ovh ovh/pulumi-ovh
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ovhTerraform Provider.
published on Monday, Oct 5, 2026 by OVHcloud