published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud
Creates a snapshot of a file storage share (NFS) in a public cloud project. The region is inherited from the parent share.
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",
});
const snapshot = new ovh.CloudStorageFileShareSnapshot("snapshot", {
serviceName: share.serviceName,
shareId: share.id,
name: "my-snapshot",
description: "Daily snapshot of my-share",
});
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")
snapshot = ovh.CloudStorageFileShareSnapshot("snapshot",
service_name=share.service_name,
share_id=share.id,
name="my-snapshot",
description="Daily snapshot of my-share")
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 {
share, 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"),
})
if err != nil {
return err
}
_, err = ovh.NewCloudStorageFileShareSnapshot(ctx, "snapshot", &ovh.CloudStorageFileShareSnapshotArgs{
ServiceName: share.ServiceName,
ShareId: share.ID(),
Name: pulumi.String("my-snapshot"),
Description: pulumi.String("Daily snapshot of my-share"),
})
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",
});
var snapshot = new Ovh.CloudStorageFileShareSnapshot("snapshot", new()
{
ServiceName = share.ServiceName,
ShareId = share.Id,
Name = "my-snapshot",
Description = "Daily snapshot of my-share",
});
});
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.ovhcloud.pulumi.ovh.CloudStorageFileShareSnapshot;
import com.ovhcloud.pulumi.ovh.CloudStorageFileShareSnapshotArgs;
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")
.build());
var snapshot = new CloudStorageFileShareSnapshot("snapshot", CloudStorageFileShareSnapshotArgs.builder()
.serviceName(share.serviceName())
.shareId(share.id())
.name("my-snapshot")
.description("Daily snapshot of my-share")
.build());
}
}
resources:
share:
type: ovh:CloudStorageFileShare
properties:
serviceName: <public cloud project ID>
name: my-share
size: 150
region: GRA1
protocol: NFS
shareType: STANDARD_1AZ
snapshot:
type: ovh:CloudStorageFileShareSnapshot
properties:
serviceName: ${share.serviceName}
shareId: ${share.id}
name: my-snapshot
description: Daily snapshot of my-share
Example coming soon!
Create CloudStorageFileShareSnapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CloudStorageFileShareSnapshot(name: string, args: CloudStorageFileShareSnapshotArgs, opts?: CustomResourceOptions);@overload
def CloudStorageFileShareSnapshot(resource_name: str,
args: CloudStorageFileShareSnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CloudStorageFileShareSnapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
service_name: Optional[str] = None,
share_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewCloudStorageFileShareSnapshot(ctx *Context, name string, args CloudStorageFileShareSnapshotArgs, opts ...ResourceOption) (*CloudStorageFileShareSnapshot, error)public CloudStorageFileShareSnapshot(string name, CloudStorageFileShareSnapshotArgs args, CustomResourceOptions? opts = null)
public CloudStorageFileShareSnapshot(String name, CloudStorageFileShareSnapshotArgs args)
public CloudStorageFileShareSnapshot(String name, CloudStorageFileShareSnapshotArgs args, CustomResourceOptions options)
type: ovh:CloudStorageFileShareSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "ovh_cloud_storage_file_share_snapshot" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CloudStorageFileShareSnapshotArgs
- 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 CloudStorageFileShareSnapshotArgs
- 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 CloudStorageFileShareSnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudStorageFileShareSnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudStorageFileShareSnapshotArgs
- 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 cloudStorageFileShareSnapshotResource = new Ovh.CloudStorageFileShareSnapshot("cloudStorageFileShareSnapshotResource", new()
{
ServiceName = "string",
ShareId = "string",
Description = "string",
Name = "string",
});
example, err := ovh.NewCloudStorageFileShareSnapshot(ctx, "cloudStorageFileShareSnapshotResource", &ovh.CloudStorageFileShareSnapshotArgs{
ServiceName: pulumi.String("string"),
ShareId: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "ovh_cloud_storage_file_share_snapshot" "cloudStorageFileShareSnapshotResource" {
lifecycle {
create_before_destroy = true
}
service_name = "string"
share_id = "string"
description = "string"
name = "string"
}
var cloudStorageFileShareSnapshotResource = new CloudStorageFileShareSnapshot("cloudStorageFileShareSnapshotResource", CloudStorageFileShareSnapshotArgs.builder()
.serviceName("string")
.shareId("string")
.description("string")
.name("string")
.build());
cloud_storage_file_share_snapshot_resource = ovh.CloudStorageFileShareSnapshot("cloudStorageFileShareSnapshotResource",
service_name="string",
share_id="string",
description="string",
name="string")
const cloudStorageFileShareSnapshotResource = new ovh.CloudStorageFileShareSnapshot("cloudStorageFileShareSnapshotResource", {
serviceName: "string",
shareId: "string",
description: "string",
name: "string",
});
type: ovh:CloudStorageFileShareSnapshot
properties:
description: string
name: string
serviceName: string
shareId: string
CloudStorageFileShareSnapshot 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 CloudStorageFileShareSnapshot resource accepts the following input properties:
- Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- Description string
- Snapshot description.
- Name string
- Snapshot name.
- Service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- Description string
- Snapshot description.
- Name string
- Snapshot name.
- service_
name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- description string
- Snapshot description.
- name string
- Snapshot name.
- service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- String
- ID of the file share to snapshot. Changing this value recreates the resource.
- description String
- Snapshot description.
- name String
- Snapshot name.
- service
Name string - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- description string
- Snapshot description.
- name string
- Snapshot name.
- service_
name str - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- str
- ID of the file share to snapshot. Changing this value recreates the resource.
- description str
- Snapshot description.
- name str
- Snapshot name.
- service
Name String - Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
- String
- ID of the file share to snapshot. Changing this value recreates the resource.
- description String
- Snapshot description.
- name String
- Snapshot name.
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudStorageFileShareSnapshot resource produces the following output properties:
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the snapshot.
- Current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Status string - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the snapshot.
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the snapshot.
- Current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Status string - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the snapshot.
- checksum string
- Computed hash representing the current target specification value.
- created_
at string - Creation date of the snapshot.
- current_
state object - Current state of the file storage snapshot:
- id string
- The provider-assigned unique ID for this managed resource.
- resource_
status string - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at string - Last update date of the snapshot.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the snapshot.
- current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Status String - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the snapshot.
- checksum string
- Computed hash representing the current target specification value.
- created
At string - Creation date of the snapshot.
- current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Status string - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At string - Last update date of the snapshot.
- checksum str
- Computed hash representing the current target specification value.
- created_
at str - Creation date of the snapshot.
- current_
state CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
status str - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at str - Last update date of the snapshot.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the snapshot.
- current
State Property Map - Current state of the file storage snapshot:
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Status String - Snapshot readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the snapshot.
Look up Existing CloudStorageFileShareSnapshot Resource
Get an existing CloudStorageFileShareSnapshot 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?: CloudStorageFileShareSnapshotState, opts?: CustomResourceOptions): CloudStorageFileShareSnapshot@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
checksum: Optional[str] = None,
created_at: Optional[str] = None,
current_state: Optional[CloudStorageFileShareSnapshotCurrentStateArgs] = None,
description: Optional[str] = None,
name: Optional[str] = None,
resource_status: Optional[str] = None,
service_name: Optional[str] = None,
share_id: Optional[str] = None,
updated_at: Optional[str] = None) -> CloudStorageFileShareSnapshotfunc GetCloudStorageFileShareSnapshot(ctx *Context, name string, id IDInput, state *CloudStorageFileShareSnapshotState, opts ...ResourceOption) (*CloudStorageFileShareSnapshot, error)public static CloudStorageFileShareSnapshot Get(string name, Input<string> id, CloudStorageFileShareSnapshotState? state, CustomResourceOptions? opts = null)public static CloudStorageFileShareSnapshot get(String name, Output<String> id, CloudStorageFileShareSnapshotState state, CustomResourceOptions options)resources: _: type: ovh:CloudStorageFileShareSnapshot get: id: ${id}import {
to = ovh_cloud_storage_file_share_snapshot.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.
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the snapshot.
- Current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- Description string
- Snapshot description.
- Name string
- Snapshot name.
- Resource
Status string - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- Updated
At string - Last update date of the snapshot.
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the snapshot.
- Current
State CloudStorage File Share Snapshot Current State Args - Current state of the file storage snapshot:
- Description string
- Snapshot description.
- Name string
- Snapshot name.
- Resource
Status string - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- Updated
At string - Last update date of the snapshot.
- checksum string
- Computed hash representing the current target specification value.
- created_
at string - Creation date of the snapshot.
- current_
state object - Current state of the file storage snapshot:
- description string
- Snapshot description.
- name string
- Snapshot name.
- resource_
status string - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- updated_
at string - Last update date of the snapshot.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the snapshot.
- current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- description String
- Snapshot description.
- name String
- Snapshot name.
- resource
Status String - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- updated
At String - Last update date of the snapshot.
- checksum string
- Computed hash representing the current target specification value.
- created
At string - Creation date of the snapshot.
- current
State CloudStorage File Share Snapshot Current State - Current state of the file storage snapshot:
- description string
- Snapshot description.
- name string
- Snapshot name.
- resource
Status string - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- updated
At string - Last update date of the snapshot.
- checksum str
- Computed hash representing the current target specification value.
- created_
at str - Creation date of the snapshot.
- current_
state CloudStorage File Share Snapshot Current State Args - Current state of the file storage snapshot:
- description str
- Snapshot description.
- name str
- Snapshot name.
- resource_
status str - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- updated_
at str - Last update date of the snapshot.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the snapshot.
- current
State Property Map - Current state of the file storage snapshot:
- description String
- Snapshot description.
- name String
- Snapshot name.
- resource
Status String - Snapshot 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 the file share to snapshot. Changing this value recreates the resource.
- updated
At String - Last update date of the snapshot.
Supporting Types
CloudStorageFileShareSnapshotCurrentState, CloudStorageFileShareSnapshotCurrentStateArgs
- Description string
- Snapshot description.
- Location
Cloud
Storage File Share Snapshot Current State Location - Current location:
- Name string
- Snapshot name.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- Size int
- Size of the snapshot in GB.
- Description string
- Snapshot description.
- Location
Cloud
Storage File Share Snapshot Current State Location - Current location:
- Name string
- Snapshot name.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- Size int
- Size of the snapshot in GB.
- description string
- Snapshot description.
- location object
- Current location:
- name string
- Snapshot name.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- size number
- Size of the snapshot in GB.
- description String
- Snapshot description.
- location
Cloud
Storage File Share Snapshot Current State Location - Current location:
- name String
- Snapshot name.
- String
- ID of the file share to snapshot. Changing this value recreates the resource.
- size Integer
- Size of the snapshot in GB.
- description string
- Snapshot description.
- location
Cloud
Storage File Share Snapshot Current State Location - Current location:
- name string
- Snapshot name.
- string
- ID of the file share to snapshot. Changing this value recreates the resource.
- size number
- Size of the snapshot in GB.
- description str
- Snapshot description.
- location
Cloud
Storage File Share Snapshot Current State Location - Current location:
- name str
- Snapshot name.
- str
- ID of the file share to snapshot. Changing this value recreates the resource.
- size int
- Size of the snapshot in GB.
- description String
- Snapshot description.
- location Property Map
- Current location:
- name String
- Snapshot name.
- String
- ID of the file share to snapshot. Changing this value recreates the resource.
- size Number
- Size of the snapshot in GB.
CloudStorageFileShareSnapshotCurrentStateLocation, CloudStorageFileShareSnapshotCurrentStateLocationArgs
- Availability
Zone string - Availability zone.
- Region string
- Region.
- Availability
Zone string - Availability zone.
- Region string
- Region.
- availability_
zone string - Availability zone.
- region string
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
- availability
Zone string - Availability zone.
- region string
- Region.
- availability_
zone str - Availability zone.
- region str
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
Import
A cloud storage file share snapshot can be imported using the service_name and snapshot_id, separated by /:
terraform
import {
to = ovh_cloud_storage_file_share_snapshot.snapshot
id = “<service_name>/<snapshot_id>”
}
bash
$ pulumi import ovh:index/cloudStorageFileShareSnapshot:CloudStorageFileShareSnapshot snapshot service_name/snapshot_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 Friday, Jul 17, 2026 by OVHcloud