Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. CloudStorageFileShare
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudStorageFileShare

ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Creates a file storage share (NFS) in a public cloud project.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  share:
    type: ovh:CloudStorageFileShare
    properties:
      serviceName: <public cloud project ID>
      name: my-share
      size: 150
      region: GRA1
      protocol: NFS
      shareType: STANDARD_1AZ
      description: My NFS share
      accessRules:
        - access_to: 10.0.0.0/24
          access_level: READ_WRITE

    Example coming soon!

    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,
                          share_network_id: Optional[str] = None,
                          share_type: Optional[str] = None,
                          size: Optional[int] = None,
                          access_rules: Optional[Sequence[CloudStorageFileShareAccessRuleArgs]] = None,
                          availability_zone: Optional[str] = None,
                          description: Optional[str] = None,
                          name: Optional[str] = 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",
    ShareNetworkId = "string",
    ShareType = "string",
    Size = 0,
    AccessRules = new[]
    {
        new Ovh.Inputs.CloudStorageFileShareAccessRuleArgs
        {
            AccessLevel = "string",
            AccessTo = "string",
        },
    },
    AvailabilityZone = "string",
    Description = "string",
    Name = "string",
});

    example, err := ovh.NewCloudStorageFileShare(ctx, "cloudStorageFileShareResource", &ovh.CloudStorageFileShareArgs{
	Protocol:       pulumi.String("string"),
	Region:         pulumi.String("string"),
	ServiceName:    pulumi.String("string"),
	ShareNetworkId: pulumi.String("string"),
	ShareType:      pulumi.String("string"),
	Size:           pulumi.Int(0),
	AccessRules: ovh.CloudStorageFileShareAccessRuleArray{
		&ovh.CloudStorageFileShareAccessRuleArgs{
			AccessLevel: pulumi.String("string"),
			AccessTo:    pulumi.String("string"),
		},
	},
	AvailabilityZone: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    resource "ovh_cloud_storage_file_share" "cloudStorageFileShareResource" {
  lifecycle {
    create_before_destroy = true
  }
  protocol         = "string"
  region           = "string"
  service_name     = "string"
  share_network_id = "string"
  share_type       = "string"
  size             = 0
  access_rules {
    access_level = "string"
    access_to    = "string"
  }
  availability_zone = "string"
  description       = "string"
  name              = "string"
}

    var cloudStorageFileShareResource = new CloudStorageFileShare("cloudStorageFileShareResource", CloudStorageFileShareArgs.builder()
    .protocol("string")
    .region("string")
    .serviceName("string")
    .shareNetworkId("string")
    .shareType("string")
    .size(0)
    .accessRules(CloudStorageFileShareAccessRuleArgs.builder()
        .accessLevel("string")
        .accessTo("string")
        .build())
    .availabilityZone("string")
    .description("string")
    .name("string")
    .build());

    cloud_storage_file_share_resource = ovh.CloudStorageFileShare("cloudStorageFileShareResource",
    protocol="string",
    region="string",
    service_name="string",
    share_network_id="string",
    share_type="string",
    size=0,
    access_rules=[{
        "access_level": "string",
        "access_to": "string",
    }],
    availability_zone="string",
    description="string",
    name="string")

    const cloudStorageFileShareResource = new ovh.CloudStorageFileShare("cloudStorageFileShareResource", {
    protocol: "string",
    region: "string",
    serviceName: "string",
    shareNetworkId: "string",
    shareType: "string",
    size: 0,
    accessRules: [{
        accessLevel: "string",
        accessTo: "string",
    }],
    availabilityZone: "string",
    description: "string",
    name: "string",
});

    type: ovh:CloudStorageFileShare
properties:
    accessRules:
        - accessLevel: string
          accessTo: string
    availabilityZone: string
    description: string
    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.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    AccessRules List<CloudStorageFileShareAccessRule>
    Access rules for the file share. Each rule has:
    AvailabilityZone string
    Availability zone where the file share will be created. Changing this value recreates the resource.
    Description string
    File share description.
    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.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    AccessRules []CloudStorageFileShareAccessRuleArgs
    Access rules for the file share. Each rule has:
    AvailabilityZone string
    Availability zone where the file share will be created. Changing this value recreates the resource.
    Description string
    File share description.
    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.
    service_name string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    share_network_id string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    access_rules list(object)
    Access rules for the file share. Each rule has:
    availability_zone string
    Availability zone where the file share will be created. Changing this value recreates the resource.
    description string
    File share description.
    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.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Integer
    Size of the file share in GB.
    accessRules List<CloudStorageFileShareAccessRule>
    Access rules for the file share. Each rule has:
    availabilityZone String
    Availability zone where the file share will be created. Changing this value recreates the resource.
    description String
    File share description.
    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.
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    accessRules CloudStorageFileShareAccessRule[]
    Access rules for the file share. Each rule has:
    availabilityZone string
    Availability zone where the file share will be created. Changing this value recreates the resource.
    description string
    File share description.
    name string
    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.
    service_name str
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    share_network_id str
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type str
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size int
    Size of the file share in GB.
    access_rules Sequence[CloudStorageFileShareAccessRuleArgs]
    Access rules for the file share. Each rule has:
    availability_zone str
    Availability zone where the file share will be created. Changing this value recreates the resource.
    description str
    File share description.
    name str
    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.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Number
    Size of the file share in GB.
    accessRules List<Property Map>
    Access rules for the file share. Each rule has:
    availabilityZone String
    Availability zone where the file share will be created. Changing this value recreates the resource.
    description String
    File share description.
    name String
    File share name.

    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.
    CreatedAt string
    Access rule creation date.
    CurrentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the file share.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Access rule creation date.
    CurrentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the file share.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Access rule creation date.
    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.
    createdAt String
    Access rule creation date.
    currentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the file share.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Access rule creation date.
    currentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt string
    Last update date of the file share.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Access rule creation date.
    current_state CloudStorageFileShareCurrentState
    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.
    createdAt String
    Access rule creation date.
    currentState Property Map
    Current state of the file storage share:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt 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,
        access_rules: Optional[Sequence[CloudStorageFileShareAccessRuleArgs]] = None,
        availability_zone: Optional[str] = None,
        checksum: Optional[str] = None,
        created_at: Optional[str] = None,
        current_state: Optional[CloudStorageFileShareCurrentStateArgs] = None,
        description: Optional[str] = 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) -> CloudStorageFileShare
    func 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.
    The following state arguments are supported:
    AccessRules List<CloudStorageFileShareAccessRule>
    Access rules for the file share. Each rule has:
    AvailabilityZone 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.
    CreatedAt string
    Access rule creation date.
    CurrentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    Description string
    File share description.
    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.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    UpdatedAt string
    Last update date of the file share.
    AccessRules []CloudStorageFileShareAccessRuleArgs
    Access rules for the file share. Each rule has:
    AvailabilityZone 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.
    CreatedAt string
    Access rule creation date.
    CurrentState CloudStorageFileShareCurrentStateArgs
    Current state of the file storage share:
    Description string
    File share description.
    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.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    UpdatedAt string
    Last update date of the file share.
    access_rules list(object)
    Access rules for the file share. Each rule has:
    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.
    created_at string
    Access rule creation date.
    current_state object
    Current state of the file storage share:
    description string
    File share description.
    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.
    share_network_id string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    updated_at string
    Last update date of the file share.
    accessRules List<CloudStorageFileShareAccessRule>
    Access rules for the file share. Each rule has:
    availabilityZone 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.
    createdAt String
    Access rule creation date.
    currentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    description String
    File share description.
    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.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Integer
    Size of the file share in GB.
    updatedAt String
    Last update date of the file share.
    accessRules CloudStorageFileShareAccessRule[]
    Access rules for the file share. Each rule has:
    availabilityZone 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.
    createdAt string
    Access rule creation date.
    currentState CloudStorageFileShareCurrentState
    Current state of the file storage share:
    description string
    File share description.
    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.
    resourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    updatedAt string
    Last update date of the file share.
    access_rules Sequence[CloudStorageFileShareAccessRuleArgs]
    Access rules for the file share. Each rule has:
    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.
    created_at str
    Access rule creation date.
    current_state CloudStorageFileShareCurrentStateArgs
    Current state of the file storage share:
    description str
    File share description.
    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.
    share_network_id str
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type str
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size int
    Size of the file share in GB.
    updated_at str
    Last update date of the file share.
    accessRules List<Property Map>
    Access rules for the file share. Each rule has:
    availabilityZone 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.
    createdAt String
    Access rule creation date.
    currentState Property Map
    Current state of the file storage share:
    description String
    File share description.
    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.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Number
    Size of the file share in GB.
    updatedAt String
    Last update date of the file share.

    Supporting Types

    CloudStorageFileShareAccessRule, CloudStorageFileShareAccessRuleArgs

    AccessLevel string
    Access level (READ_WRITE, READ_ONLY).
    AccessTo string
    IP address or CIDR to grant access to.
    AccessLevel string
    Access level (READ_WRITE, READ_ONLY).
    AccessTo string
    IP address or CIDR to grant access to.
    access_level string
    Access level (READ_WRITE, READ_ONLY).
    access_to string
    IP address or CIDR to grant access to.
    accessLevel String
    Access level (READ_WRITE, READ_ONLY).
    accessTo String
    IP address or CIDR to grant access to.
    accessLevel string
    Access level (READ_WRITE, READ_ONLY).
    accessTo string
    IP address or CIDR to grant access to.
    access_level str
    Access level (READ_WRITE, READ_ONLY).
    access_to str
    IP address or CIDR to grant access to.
    accessLevel String
    Access level (READ_WRITE, READ_ONLY).
    accessTo String
    IP address or CIDR to grant access to.

    CloudStorageFileShareCurrentState, CloudStorageFileShareCurrentStateArgs

    AccessRules List<CloudStorageFileShareCurrentStateAccessRule>
    Access rules for the file share. Each rule has:
    Capabilities List<CloudStorageFileShareCurrentStateCapability>
    Action-availability flags derived from the file share status:
    Description string
    File share description.
    ExportLocations List<CloudStorageFileShareCurrentStateExportLocation>
    Export locations for the file share:
    Location CloudStorageFileShareCurrentStateLocation
    Current location:
    Name string
    File share name.
    Protocol string
    File share protocol (NFS). Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    AccessRules []CloudStorageFileShareCurrentStateAccessRule
    Access rules for the file share. Each rule has:
    Capabilities []CloudStorageFileShareCurrentStateCapability
    Action-availability flags derived from the file share status:
    Description string
    File share description.
    ExportLocations []CloudStorageFileShareCurrentStateExportLocation
    Export locations for the file share:
    Location CloudStorageFileShareCurrentStateLocation
    Current location:
    Name string
    File share name.
    Protocol string
    File share protocol (NFS). Changing this value recreates the resource.
    ShareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    ShareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    Size int
    Size of the file share in GB.
    access_rules list(object)
    Access rules for the file share. Each rule has:
    capabilities list(object)
    Action-availability flags derived from the file share status:
    description string
    File share description.
    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.
    share_network_id string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    accessRules List<CloudStorageFileShareCurrentStateAccessRule>
    Access rules for the file share. Each rule has:
    capabilities List<CloudStorageFileShareCurrentStateCapability>
    Action-availability flags derived from the file share status:
    description String
    File share description.
    exportLocations List<CloudStorageFileShareCurrentStateExportLocation>
    Export locations for the file share:
    location CloudStorageFileShareCurrentStateLocation
    Current location:
    name String
    File share name.
    protocol String
    File share protocol (NFS). Changing this value recreates the resource.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Integer
    Size of the file share in GB.
    accessRules CloudStorageFileShareCurrentStateAccessRule[]
    Access rules for the file share. Each rule has:
    capabilities CloudStorageFileShareCurrentStateCapability[]
    Action-availability flags derived from the file share status:
    description string
    File share description.
    exportLocations CloudStorageFileShareCurrentStateExportLocation[]
    Export locations for the file share:
    location CloudStorageFileShareCurrentStateLocation
    Current location:
    name string
    File share name.
    protocol string
    File share protocol (NFS). Changing this value recreates the resource.
    shareNetworkId string
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType string
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size number
    Size of the file share in GB.
    access_rules Sequence[CloudStorageFileShareCurrentStateAccessRule]
    Access rules for the file share. Each rule has:
    capabilities Sequence[CloudStorageFileShareCurrentStateCapability]
    Action-availability flags derived from the file share status:
    description str
    File share description.
    export_locations Sequence[CloudStorageFileShareCurrentStateExportLocation]
    Export locations for the file share:
    location CloudStorageFileShareCurrentStateLocation
    Current location:
    name str
    File share name.
    protocol str
    File share protocol (NFS). Changing this value recreates the resource.
    share_network_id str
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    share_type str
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size int
    Size of the file share in GB.
    accessRules List<Property Map>
    Access rules for the file share. Each rule has:
    capabilities List<Property Map>
    Action-availability flags derived from the file share status:
    description String
    File share description.
    exportLocations 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.
    shareNetworkId String
    ID of a pre-existing share network to attach the file share to. Changing this value recreates the resource.
    shareType String
    File share type (e.g. STANDARD_1AZ). Changing this value recreates the resource.
    size Number
    Size of the file share in GB.

    CloudStorageFileShareCurrentStateAccessRule, CloudStorageFileShareCurrentStateAccessRuleArgs

    AccessLevel string
    Access level (READ_WRITE, READ_ONLY).
    AccessTo string
    IP address or CIDR to grant access to.
    CreatedAt string
    Access rule creation date.
    Id string
    Access rule ID.
    State string
    Access rule state.
    AccessLevel string
    Access level (READ_WRITE, READ_ONLY).
    AccessTo string
    IP address or CIDR to grant access to.
    CreatedAt string
    Access rule creation date.
    Id string
    Access rule ID.
    State string
    Access rule state.
    access_level string
    Access level (READ_WRITE, READ_ONLY).
    access_to string
    IP address or CIDR to grant access to.
    created_at string
    Access rule creation date.
    id string
    Access rule ID.
    state string
    Access rule state.
    accessLevel String
    Access level (READ_WRITE, READ_ONLY).
    accessTo String
    IP address or CIDR to grant access to.
    createdAt String
    Access rule creation date.
    id String
    Access rule ID.
    state String
    Access rule state.
    accessLevel string
    Access level (READ_WRITE, READ_ONLY).
    accessTo string
    IP address or CIDR to grant access to.
    createdAt string
    Access rule creation date.
    id string
    Access rule ID.
    state string
    Access rule state.
    access_level str
    Access level (READ_WRITE, READ_ONLY).
    access_to str
    IP address or CIDR to grant access to.
    created_at str
    Access rule creation date.
    id str
    Access rule ID.
    state str
    Access rule state.
    accessLevel String
    Access level (READ_WRITE, READ_ONLY).
    accessTo String
    IP address or CIDR to grant access to.
    createdAt String
    Access rule creation date.
    id String
    Access rule ID.
    state String
    Access rule state.

    CloudStorageFileShareCurrentStateCapability, CloudStorageFileShareCurrentStateCapabilityArgs

    Enabled bool
    Whether the capability is enabled.
    Name string
    File share name.
    Reason string
    Reason why the capability is disabled, when applicable.
    Enabled bool
    Whether the capability is enabled.
    Name string
    File share name.
    Reason string
    Reason why the capability is disabled, when applicable.
    enabled bool
    Whether the capability is enabled.
    name string
    File share name.
    reason string
    Reason why the capability is disabled, when applicable.
    enabled Boolean
    Whether the capability is enabled.
    name String
    File share name.
    reason String
    Reason why the capability is disabled, when applicable.
    enabled boolean
    Whether the capability is enabled.
    name string
    File share name.
    reason string
    Reason why the capability is disabled, when applicable.
    enabled bool
    Whether the capability is enabled.
    name str
    File share name.
    reason str
    Reason why the capability is disabled, when applicable.
    enabled Boolean
    Whether the capability is enabled.
    name String
    File share name.
    reason String
    Reason why the capability is disabled, when applicable.

    CloudStorageFileShareCurrentStateExportLocation, CloudStorageFileShareCurrentStateExportLocationArgs

    Path string
    Export path.
    Preferred bool
    Whether this is the preferred export location.
    Path string
    Export path.
    Preferred bool
    Whether this is the preferred export location.
    path string
    Export path.
    preferred bool
    Whether this is the preferred export location.
    path String
    Export path.
    preferred Boolean
    Whether this is the preferred export location.
    path string
    Export path.
    preferred boolean
    Whether this is the preferred export location.
    path str
    Export path.
    preferred bool
    Whether this is the preferred export location.
    path String
    Export path.
    preferred Boolean
    Whether this is the preferred export location.

    CloudStorageFileShareCurrentStateLocation, CloudStorageFileShareCurrentStateLocationArgs

    AvailabilityZone 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.
    AvailabilityZone 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.
    availabilityZone 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.
    availabilityZone 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.
    availabilityZone 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.

    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 ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial