1. Packages
  2. OVH
  3. API Docs
  4. StorageEfs
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      efs:
        type: ovh:StorageEfs
        properties:
          name: MyEFS
          ovhSubsidiary: ${myAccount.ovhSubsidiary}
          plans:
            - plan_code: enterprise-file-storage-premium-1tb
              duration: P1M
              pricing_mode: default
              configuration:
                - label: region
                  value: eu-west-gra
                - label: network
                  value: vrack
    variables:
      myAccount:
        fn::invoke:
          function: ovh:Me:getMe
          arguments: {}
    

    Create StorageEfs Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StorageEfs(name: string, args?: StorageEfsArgs, opts?: CustomResourceOptions);
    @overload
    def StorageEfs(resource_name: str,
                   args: Optional[StorageEfsArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def StorageEfs(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   ovh_subsidiary: Optional[str] = None,
                   plan_options: Optional[Sequence[StorageEfsPlanOptionArgs]] = None,
                   plans: Optional[Sequence[StorageEfsPlanArgs]] = None)
    func NewStorageEfs(ctx *Context, name string, args *StorageEfsArgs, opts ...ResourceOption) (*StorageEfs, error)
    public StorageEfs(string name, StorageEfsArgs? args = null, CustomResourceOptions? opts = null)
    public StorageEfs(String name, StorageEfsArgs args)
    public StorageEfs(String name, StorageEfsArgs args, CustomResourceOptions options)
    
    type: ovh:StorageEfs
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StorageEfsArgs
    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 StorageEfsArgs
    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 StorageEfsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageEfsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageEfsArgs
    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 storageEfsResource = new Ovh.StorageEfs("storageEfsResource", new()
    {
        Name = "string",
        OvhSubsidiary = "string",
        PlanOptions = new[]
        {
            new Ovh.Inputs.StorageEfsPlanOptionArgs
            {
                Duration = "string",
                PlanCode = "string",
                PricingMode = "string",
                Quantity = 0,
                Configurations = new[]
                {
                    new Ovh.Inputs.StorageEfsPlanOptionConfigurationArgs
                    {
                        Label = "string",
                        Value = "string",
                    },
                },
            },
        },
        Plans = new[]
        {
            new Ovh.Inputs.StorageEfsPlanArgs
            {
                Duration = "string",
                PlanCode = "string",
                PricingMode = "string",
                Configurations = new[]
                {
                    new Ovh.Inputs.StorageEfsPlanConfigurationArgs
                    {
                        Label = "string",
                        Value = "string",
                    },
                },
                ItemId = 0,
                Quantity = 0,
            },
        },
    });
    
    example, err := ovh.NewStorageEfs(ctx, "storageEfsResource", &ovh.StorageEfsArgs{
    	Name:          pulumi.String("string"),
    	OvhSubsidiary: pulumi.String("string"),
    	PlanOptions: ovh.StorageEfsPlanOptionArray{
    		&ovh.StorageEfsPlanOptionArgs{
    			Duration:    pulumi.String("string"),
    			PlanCode:    pulumi.String("string"),
    			PricingMode: pulumi.String("string"),
    			Quantity:    pulumi.Float64(0),
    			Configurations: ovh.StorageEfsPlanOptionConfigurationArray{
    				&ovh.StorageEfsPlanOptionConfigurationArgs{
    					Label: pulumi.String("string"),
    					Value: pulumi.String("string"),
    				},
    			},
    		},
    	},
    	Plans: ovh.StorageEfsPlanArray{
    		&ovh.StorageEfsPlanArgs{
    			Duration:    pulumi.String("string"),
    			PlanCode:    pulumi.String("string"),
    			PricingMode: pulumi.String("string"),
    			Configurations: ovh.StorageEfsPlanConfigurationArray{
    				&ovh.StorageEfsPlanConfigurationArgs{
    					Label: pulumi.String("string"),
    					Value: pulumi.String("string"),
    				},
    			},
    			ItemId:   pulumi.Float64(0),
    			Quantity: pulumi.Float64(0),
    		},
    	},
    })
    
    var storageEfsResource = new StorageEfs("storageEfsResource", StorageEfsArgs.builder()
        .name("string")
        .ovhSubsidiary("string")
        .planOptions(StorageEfsPlanOptionArgs.builder()
            .duration("string")
            .planCode("string")
            .pricingMode("string")
            .quantity(0.0)
            .configurations(StorageEfsPlanOptionConfigurationArgs.builder()
                .label("string")
                .value("string")
                .build())
            .build())
        .plans(StorageEfsPlanArgs.builder()
            .duration("string")
            .planCode("string")
            .pricingMode("string")
            .configurations(StorageEfsPlanConfigurationArgs.builder()
                .label("string")
                .value("string")
                .build())
            .itemId(0.0)
            .quantity(0.0)
            .build())
        .build());
    
    storage_efs_resource = ovh.StorageEfs("storageEfsResource",
        name="string",
        ovh_subsidiary="string",
        plan_options=[{
            "duration": "string",
            "plan_code": "string",
            "pricing_mode": "string",
            "quantity": 0,
            "configurations": [{
                "label": "string",
                "value": "string",
            }],
        }],
        plans=[{
            "duration": "string",
            "plan_code": "string",
            "pricing_mode": "string",
            "configurations": [{
                "label": "string",
                "value": "string",
            }],
            "item_id": 0,
            "quantity": 0,
        }])
    
    const storageEfsResource = new ovh.StorageEfs("storageEfsResource", {
        name: "string",
        ovhSubsidiary: "string",
        planOptions: [{
            duration: "string",
            planCode: "string",
            pricingMode: "string",
            quantity: 0,
            configurations: [{
                label: "string",
                value: "string",
            }],
        }],
        plans: [{
            duration: "string",
            planCode: "string",
            pricingMode: "string",
            configurations: [{
                label: "string",
                value: "string",
            }],
            itemId: 0,
            quantity: 0,
        }],
    });
    
    type: ovh:StorageEfs
    properties:
        name: string
        ovhSubsidiary: string
        planOptions:
            - configurations:
                - label: string
                  value: string
              duration: string
              planCode: string
              pricingMode: string
              quantity: 0
        plans:
            - configurations:
                - label: string
                  value: string
              duration: string
              itemId: 0
              planCode: string
              pricingMode: string
              quantity: 0
    

    StorageEfs 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 StorageEfs resource accepts the following input properties:

    Name string
    Custom service display name
    OvhSubsidiary string
    OVH subsidiaries
    PlanOptions List<StorageEfsPlanOption>
    Plans List<StorageEfsPlan>
    Name string
    Custom service display name
    OvhSubsidiary string
    OVH subsidiaries
    PlanOptions []StorageEfsPlanOptionArgs
    Plans []StorageEfsPlanArgs
    name String
    Custom service display name
    ovhSubsidiary String
    OVH subsidiaries
    planOptions List<StorageEfsPlanOption>
    plans List<StorageEfsPlan>
    name string
    Custom service display name
    ovhSubsidiary string
    OVH subsidiaries
    planOptions StorageEfsPlanOption[]
    plans StorageEfsPlan[]
    name String
    Custom service display name
    ovhSubsidiary String
    OVH subsidiaries
    planOptions List<Property Map>
    plans List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StorageEfs resource produces the following output properties:

    CreatedAt string
    Service creation date
    Iam StorageEfsIam
    IAM resource metadata
    Id string
    The provider-assigned unique ID for this managed resource.
    Order StorageEfsOrder
    Details about an Order
    PerformanceLevel string
    Service performance level
    Product string
    Product name
    Quota double
    Service quota
    Region string
    Service region
    ServiceName string
    Service name (same as id)
    Status string
    Service status
    CreatedAt string
    Service creation date
    Iam StorageEfsIam
    IAM resource metadata
    Id string
    The provider-assigned unique ID for this managed resource.
    Order StorageEfsOrder
    Details about an Order
    PerformanceLevel string
    Service performance level
    Product string
    Product name
    Quota float64
    Service quota
    Region string
    Service region
    ServiceName string
    Service name (same as id)
    Status string
    Service status
    createdAt String
    Service creation date
    iam StorageEfsIam
    IAM resource metadata
    id String
    The provider-assigned unique ID for this managed resource.
    order StorageEfsOrder
    Details about an Order
    performanceLevel String
    Service performance level
    product String
    Product name
    quota Double
    Service quota
    region String
    Service region
    serviceName String
    Service name (same as id)
    status String
    Service status
    createdAt string
    Service creation date
    iam StorageEfsIam
    IAM resource metadata
    id string
    The provider-assigned unique ID for this managed resource.
    order StorageEfsOrder
    Details about an Order
    performanceLevel string
    Service performance level
    product string
    Product name
    quota number
    Service quota
    region string
    Service region
    serviceName string
    Service name (same as id)
    status string
    Service status
    created_at str
    Service creation date
    iam StorageEfsIam
    IAM resource metadata
    id str
    The provider-assigned unique ID for this managed resource.
    order StorageEfsOrder
    Details about an Order
    performance_level str
    Service performance level
    product str
    Product name
    quota float
    Service quota
    region str
    Service region
    service_name str
    Service name (same as id)
    status str
    Service status
    createdAt String
    Service creation date
    iam Property Map
    IAM resource metadata
    id String
    The provider-assigned unique ID for this managed resource.
    order Property Map
    Details about an Order
    performanceLevel String
    Service performance level
    product String
    Product name
    quota Number
    Service quota
    region String
    Service region
    serviceName String
    Service name (same as id)
    status String
    Service status

    Look up Existing StorageEfs Resource

    Get an existing StorageEfs 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?: StorageEfsState, opts?: CustomResourceOptions): StorageEfs
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            iam: Optional[StorageEfsIamArgs] = None,
            name: Optional[str] = None,
            order: Optional[StorageEfsOrderArgs] = None,
            ovh_subsidiary: Optional[str] = None,
            performance_level: Optional[str] = None,
            plan_options: Optional[Sequence[StorageEfsPlanOptionArgs]] = None,
            plans: Optional[Sequence[StorageEfsPlanArgs]] = None,
            product: Optional[str] = None,
            quota: Optional[float] = None,
            region: Optional[str] = None,
            service_name: Optional[str] = None,
            status: Optional[str] = None) -> StorageEfs
    func GetStorageEfs(ctx *Context, name string, id IDInput, state *StorageEfsState, opts ...ResourceOption) (*StorageEfs, error)
    public static StorageEfs Get(string name, Input<string> id, StorageEfsState? state, CustomResourceOptions? opts = null)
    public static StorageEfs get(String name, Output<String> id, StorageEfsState state, CustomResourceOptions options)
    resources:  _:    type: ovh:StorageEfs    get:      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:
    CreatedAt string
    Service creation date
    Iam StorageEfsIam
    IAM resource metadata
    Name string
    Custom service display name
    Order StorageEfsOrder
    Details about an Order
    OvhSubsidiary string
    OVH subsidiaries
    PerformanceLevel string
    Service performance level
    PlanOptions List<StorageEfsPlanOption>
    Plans List<StorageEfsPlan>
    Product string
    Product name
    Quota double
    Service quota
    Region string
    Service region
    ServiceName string
    Service name (same as id)
    Status string
    Service status
    CreatedAt string
    Service creation date
    Iam StorageEfsIamArgs
    IAM resource metadata
    Name string
    Custom service display name
    Order StorageEfsOrderArgs
    Details about an Order
    OvhSubsidiary string
    OVH subsidiaries
    PerformanceLevel string
    Service performance level
    PlanOptions []StorageEfsPlanOptionArgs
    Plans []StorageEfsPlanArgs
    Product string
    Product name
    Quota float64
    Service quota
    Region string
    Service region
    ServiceName string
    Service name (same as id)
    Status string
    Service status
    createdAt String
    Service creation date
    iam StorageEfsIam
    IAM resource metadata
    name String
    Custom service display name
    order StorageEfsOrder
    Details about an Order
    ovhSubsidiary String
    OVH subsidiaries
    performanceLevel String
    Service performance level
    planOptions List<StorageEfsPlanOption>
    plans List<StorageEfsPlan>
    product String
    Product name
    quota Double
    Service quota
    region String
    Service region
    serviceName String
    Service name (same as id)
    status String
    Service status
    createdAt string
    Service creation date
    iam StorageEfsIam
    IAM resource metadata
    name string
    Custom service display name
    order StorageEfsOrder
    Details about an Order
    ovhSubsidiary string
    OVH subsidiaries
    performanceLevel string
    Service performance level
    planOptions StorageEfsPlanOption[]
    plans StorageEfsPlan[]
    product string
    Product name
    quota number
    Service quota
    region string
    Service region
    serviceName string
    Service name (same as id)
    status string
    Service status
    created_at str
    Service creation date
    iam StorageEfsIamArgs
    IAM resource metadata
    name str
    Custom service display name
    order StorageEfsOrderArgs
    Details about an Order
    ovh_subsidiary str
    OVH subsidiaries
    performance_level str
    Service performance level
    plan_options Sequence[StorageEfsPlanOptionArgs]
    plans Sequence[StorageEfsPlanArgs]
    product str
    Product name
    quota float
    Service quota
    region str
    Service region
    service_name str
    Service name (same as id)
    status str
    Service status
    createdAt String
    Service creation date
    iam Property Map
    IAM resource metadata
    name String
    Custom service display name
    order Property Map
    Details about an Order
    ovhSubsidiary String
    OVH subsidiaries
    performanceLevel String
    Service performance level
    planOptions List<Property Map>
    plans List<Property Map>
    product String
    Product name
    quota Number
    Service quota
    region String
    Service region
    serviceName String
    Service name (same as id)
    status String
    Service status

    Supporting Types

    StorageEfsIam, StorageEfsIamArgs

    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags Dictionary<string, string>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags map[string]string
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String,String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies
    displayName string
    Resource display name
    id string
    Unique identifier of the resource
    tags {[key: string]: string}
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn string
    Unique resource name used in policies
    display_name str
    Resource display name
    id str
    Unique identifier of the resource
    tags Mapping[str, str]
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn str
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies

    StorageEfsOrder, StorageEfsOrderArgs

    StorageEfsOrderDetail, StorageEfsOrderDetailArgs

    Description string
    DetailType string
    Product type of item in order
    Domain string
    OrderDetailId double
    Quantity string
    Description string
    DetailType string
    Product type of item in order
    Domain string
    OrderDetailId float64
    Quantity string
    description String
    detailType String
    Product type of item in order
    domain String
    orderDetailId Double
    quantity String
    description string
    detailType string
    Product type of item in order
    domain string
    orderDetailId number
    quantity string
    description str
    detail_type str
    Product type of item in order
    domain str
    order_detail_id float
    quantity str
    description String
    detailType String
    Product type of item in order
    domain String
    orderDetailId Number
    quantity String

    StorageEfsPlan, StorageEfsPlanArgs

    Duration string
    Duration selected for the purchase of the product
    PlanCode string
    Identifier of the option offer
    PricingMode string
    Pricing mode selected for the purchase of the product
    Configurations List<StorageEfsPlanConfiguration>
    ItemId double
    Cart item to be linked
    Quantity double
    Quantity of product desired
    Duration string
    Duration selected for the purchase of the product
    PlanCode string
    Identifier of the option offer
    PricingMode string
    Pricing mode selected for the purchase of the product
    Configurations []StorageEfsPlanConfiguration
    ItemId float64
    Cart item to be linked
    Quantity float64
    Quantity of product desired
    duration String
    Duration selected for the purchase of the product
    planCode String
    Identifier of the option offer
    pricingMode String
    Pricing mode selected for the purchase of the product
    configurations List<StorageEfsPlanConfiguration>
    itemId Double
    Cart item to be linked
    quantity Double
    Quantity of product desired
    duration string
    Duration selected for the purchase of the product
    planCode string
    Identifier of the option offer
    pricingMode string
    Pricing mode selected for the purchase of the product
    configurations StorageEfsPlanConfiguration[]
    itemId number
    Cart item to be linked
    quantity number
    Quantity of product desired
    duration str
    Duration selected for the purchase of the product
    plan_code str
    Identifier of the option offer
    pricing_mode str
    Pricing mode selected for the purchase of the product
    configurations Sequence[StorageEfsPlanConfiguration]
    item_id float
    Cart item to be linked
    quantity float
    Quantity of product desired
    duration String
    Duration selected for the purchase of the product
    planCode String
    Identifier of the option offer
    pricingMode String
    Pricing mode selected for the purchase of the product
    configurations List<Property Map>
    itemId Number
    Cart item to be linked
    quantity Number
    Quantity of product desired

    StorageEfsPlanConfiguration, StorageEfsPlanConfigurationArgs

    Label string
    Label for your configuration item
    Value string
    Value or resource URL on API.OVH.COM of your configuration item
    Label string
    Label for your configuration item
    Value string
    Value or resource URL on API.OVH.COM of your configuration item
    label String
    Label for your configuration item
    value String
    Value or resource URL on API.OVH.COM of your configuration item
    label string
    Label for your configuration item
    value string
    Value or resource URL on API.OVH.COM of your configuration item
    label str
    Label for your configuration item
    value str
    Value or resource URL on API.OVH.COM of your configuration item
    label String
    Label for your configuration item
    value String
    Value or resource URL on API.OVH.COM of your configuration item

    StorageEfsPlanOption, StorageEfsPlanOptionArgs

    Duration string
    Duration selected for the purchase of the product
    PlanCode string
    Identifier of the option offer
    PricingMode string
    Pricing mode selected for the purchase of the product
    Quantity double
    Quantity of product desired
    Configurations List<StorageEfsPlanOptionConfiguration>
    Duration string
    Duration selected for the purchase of the product
    PlanCode string
    Identifier of the option offer
    PricingMode string
    Pricing mode selected for the purchase of the product
    Quantity float64
    Quantity of product desired
    Configurations []StorageEfsPlanOptionConfiguration
    duration String
    Duration selected for the purchase of the product
    planCode String
    Identifier of the option offer
    pricingMode String
    Pricing mode selected for the purchase of the product
    quantity Double
    Quantity of product desired
    configurations List<StorageEfsPlanOptionConfiguration>
    duration string
    Duration selected for the purchase of the product
    planCode string
    Identifier of the option offer
    pricingMode string
    Pricing mode selected for the purchase of the product
    quantity number
    Quantity of product desired
    configurations StorageEfsPlanOptionConfiguration[]
    duration str
    Duration selected for the purchase of the product
    plan_code str
    Identifier of the option offer
    pricing_mode str
    Pricing mode selected for the purchase of the product
    quantity float
    Quantity of product desired
    configurations Sequence[StorageEfsPlanOptionConfiguration]
    duration String
    Duration selected for the purchase of the product
    planCode String
    Identifier of the option offer
    pricingMode String
    Pricing mode selected for the purchase of the product
    quantity Number
    Quantity of product desired
    configurations List<Property Map>

    StorageEfsPlanOptionConfiguration, StorageEfsPlanOptionConfigurationArgs

    Label string
    Label for your configuration item
    Value string
    Value or resource URL on API.OVH.COM of your configuration item
    Label string
    Label for your configuration item
    Value string
    Value or resource URL on API.OVH.COM of your configuration item
    label String
    Label for your configuration item
    value String
    Value or resource URL on API.OVH.COM of your configuration item
    label string
    Label for your configuration item
    value string
    Value or resource URL on API.OVH.COM of your configuration item
    label str
    Label for your configuration item
    value str
    Value or resource URL on API.OVH.COM of your configuration item
    label String
    Label for your configuration item
    value String
    Value or resource URL on API.OVH.COM of your configuration item

    Import

    An Enterprise File Storage service can be imported using its id. Using the following configuration:

    terraform

    import {

    to = ovh_storage_efs.efs

    id = “xxx-xxx-xxx-xxx-xxx”

    }

    You can then run:

    bash

    $ pulumi preview -generate-config-out=efs.tf

    $ pulumi up

    The file efs.tf will then contain the imported resource’s configuration, that can be copied next to the import block above. See https://developer.hashicorp.com/terraform/language/import/generating-configuration for more details.

    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.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
      Try Pulumi Cloud free. Your team will thank you.