Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ucloud Provider
  3. API Docs
  4. UfsVolume
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

ucloud.UfsVolume

Explore with Pulumi AI

ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

Provides a UFS Volume resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ucloud from "@pulumi/ucloud";

const foo = new ucloud.UfsVolume("foo", {
    protocolType: "NFSv4",
    remark: "test",
    size: 500,
    storageType: "Basic",
    tag: "tf-acc",
});
Copy
import pulumi
import pulumi_ucloud as ucloud

foo = ucloud.UfsVolume("foo",
    protocol_type="NFSv4",
    remark="test",
    size=500,
    storage_type="Basic",
    tag="tf-acc")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ucloud/ucloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ucloud.NewUfsVolume(ctx, "foo", &ucloud.UfsVolumeArgs{
			ProtocolType: pulumi.String("NFSv4"),
			Remark:       pulumi.String("test"),
			Size:         pulumi.Float64(500),
			StorageType:  pulumi.String("Basic"),
			Tag:          pulumi.String("tf-acc"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ucloud = Pulumi.Ucloud;

return await Deployment.RunAsync(() => 
{
    var foo = new Ucloud.UfsVolume("foo", new()
    {
        ProtocolType = "NFSv4",
        Remark = "test",
        Size = 500,
        StorageType = "Basic",
        Tag = "tf-acc",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ucloud.UfsVolume;
import com.pulumi.ucloud.UfsVolumeArgs;
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 foo = new UfsVolume("foo", UfsVolumeArgs.builder()
            .protocolType("NFSv4")
            .remark("test")
            .size(500)
            .storageType("Basic")
            .tag("tf-acc")
            .build());

    }
}
Copy
resources:
  foo:
    type: ucloud:UfsVolume
    properties:
      protocolType: NFSv4
      remark: test
      size: 500
      storageType: Basic
      tag: tf-acc
Copy

Create UfsVolume Resource

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

Constructor syntax

new UfsVolume(name: string, args: UfsVolumeArgs, opts?: CustomResourceOptions);
@overload
def UfsVolume(resource_name: str,
              args: UfsVolumeArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def UfsVolume(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              protocol_type: Optional[str] = None,
              size: Optional[float] = None,
              storage_type: Optional[str] = None,
              charge_type: Optional[str] = None,
              duration: Optional[float] = None,
              name: Optional[str] = None,
              remark: Optional[str] = None,
              tag: Optional[str] = None,
              ufs_volume_id: Optional[str] = None)
func NewUfsVolume(ctx *Context, name string, args UfsVolumeArgs, opts ...ResourceOption) (*UfsVolume, error)
public UfsVolume(string name, UfsVolumeArgs args, CustomResourceOptions? opts = null)
public UfsVolume(String name, UfsVolumeArgs args)
public UfsVolume(String name, UfsVolumeArgs args, CustomResourceOptions options)

type: ucloud:UfsVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UfsVolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UfsVolumeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UfsVolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UfsVolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UfsVolumeArgs
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 ufsVolumeResource = new Ucloud.UfsVolume("ufsVolumeResource", new()
{
    ProtocolType = "string",
    Size = 0,
    StorageType = "string",
    ChargeType = "string",
    Duration = 0,
    Name = "string",
    Remark = "string",
    Tag = "string",
    UfsVolumeId = "string",
});
Copy
example, err := ucloud.NewUfsVolume(ctx, "ufsVolumeResource", &ucloud.UfsVolumeArgs{
	ProtocolType: pulumi.String("string"),
	Size:         pulumi.Float64(0),
	StorageType:  pulumi.String("string"),
	ChargeType:   pulumi.String("string"),
	Duration:     pulumi.Float64(0),
	Name:         pulumi.String("string"),
	Remark:       pulumi.String("string"),
	Tag:          pulumi.String("string"),
	UfsVolumeId:  pulumi.String("string"),
})
Copy
var ufsVolumeResource = new UfsVolume("ufsVolumeResource", UfsVolumeArgs.builder()
    .protocolType("string")
    .size(0)
    .storageType("string")
    .chargeType("string")
    .duration(0)
    .name("string")
    .remark("string")
    .tag("string")
    .ufsVolumeId("string")
    .build());
Copy
ufs_volume_resource = ucloud.UfsVolume("ufsVolumeResource",
    protocol_type="string",
    size=0,
    storage_type="string",
    charge_type="string",
    duration=0,
    name="string",
    remark="string",
    tag="string",
    ufs_volume_id="string")
Copy
const ufsVolumeResource = new ucloud.UfsVolume("ufsVolumeResource", {
    protocolType: "string",
    size: 0,
    storageType: "string",
    chargeType: "string",
    duration: 0,
    name: "string",
    remark: "string",
    tag: "string",
    ufsVolumeId: "string",
});
Copy
type: ucloud:UfsVolume
properties:
    chargeType: string
    duration: 0
    name: string
    protocolType: string
    remark: string
    size: 0
    storageType: string
    tag: string
    ufsVolumeId: string
Copy

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

ProtocolType This property is required. string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

Size This property is required. double
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
StorageType This property is required. string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
ChargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
Duration double
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
Name string
Remark string
The remarks of instance. (Default: "").
Tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
UfsVolumeId string
The ID of the resource UFS Volume.
ProtocolType This property is required. string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

Size This property is required. float64
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
StorageType This property is required. string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
ChargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
Duration float64
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
Name string
Remark string
The remarks of instance. (Default: "").
Tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
UfsVolumeId string
The ID of the resource UFS Volume.
protocolType This property is required. String
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

size This property is required. Double
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType This property is required. String
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
chargeType String
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
duration Double
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
name String
remark String
The remarks of instance. (Default: "").
tag String
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId String
The ID of the resource UFS Volume.
protocolType This property is required. string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

size This property is required. number
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType This property is required. string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
chargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
duration number
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
name string
remark string
The remarks of instance. (Default: "").
tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId string
The ID of the resource UFS Volume.
protocol_type This property is required. str
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

size This property is required. float
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storage_type This property is required. str
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
charge_type str
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
duration float
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
name str
remark str
The remarks of instance. (Default: "").
tag str
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufs_volume_id str
The ID of the resource UFS Volume.
protocolType This property is required. String
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

size This property is required. Number
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType This property is required. String
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
chargeType String
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
duration Number
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
name String
remark String
The remarks of instance. (Default: "").
tag String
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId String
The ID of the resource UFS Volume.

Outputs

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

CreateTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
ExpireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
Id string
The provider-assigned unique ID for this managed resource.
CreateTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
ExpireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
Id string
The provider-assigned unique ID for this managed resource.
createTime String
The time of creation of UFS Volume, formatted in RFC3339 time string.
expireTime String
The expiration time of UFS Volume, formatted in RFC3339 time string.
id String
The provider-assigned unique ID for this managed resource.
createTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
expireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
id string
The provider-assigned unique ID for this managed resource.
create_time str
The time of creation of UFS Volume, formatted in RFC3339 time string.
expire_time str
The expiration time of UFS Volume, formatted in RFC3339 time string.
id str
The provider-assigned unique ID for this managed resource.
createTime String
The time of creation of UFS Volume, formatted in RFC3339 time string.
expireTime String
The expiration time of UFS Volume, formatted in RFC3339 time string.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing UfsVolume Resource

Get an existing UfsVolume 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?: UfsVolumeState, opts?: CustomResourceOptions): UfsVolume
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        charge_type: Optional[str] = None,
        create_time: Optional[str] = None,
        duration: Optional[float] = None,
        expire_time: Optional[str] = None,
        name: Optional[str] = None,
        protocol_type: Optional[str] = None,
        remark: Optional[str] = None,
        size: Optional[float] = None,
        storage_type: Optional[str] = None,
        tag: Optional[str] = None,
        ufs_volume_id: Optional[str] = None) -> UfsVolume
func GetUfsVolume(ctx *Context, name string, id IDInput, state *UfsVolumeState, opts ...ResourceOption) (*UfsVolume, error)
public static UfsVolume Get(string name, Input<string> id, UfsVolumeState? state, CustomResourceOptions? opts = null)
public static UfsVolume get(String name, Output<String> id, UfsVolumeState state, CustomResourceOptions options)
resources:  _:    type: ucloud:UfsVolume    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ChargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
CreateTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
Duration double
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
ExpireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
Name string
ProtocolType string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

Remark string
The remarks of instance. (Default: "").
Size double
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
StorageType string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
Tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
UfsVolumeId string
The ID of the resource UFS Volume.
ChargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
CreateTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
Duration float64
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
ExpireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
Name string
ProtocolType string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

Remark string
The remarks of instance. (Default: "").
Size float64
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
StorageType string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
Tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
UfsVolumeId string
The ID of the resource UFS Volume.
chargeType String
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
createTime String
The time of creation of UFS Volume, formatted in RFC3339 time string.
duration Double
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
expireTime String
The expiration time of UFS Volume, formatted in RFC3339 time string.
name String
protocolType String
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

remark String
The remarks of instance. (Default: "").
size Double
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType String
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
tag String
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId String
The ID of the resource UFS Volume.
chargeType string
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
createTime string
The time of creation of UFS Volume, formatted in RFC3339 time string.
duration number
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
expireTime string
The expiration time of UFS Volume, formatted in RFC3339 time string.
name string
protocolType string
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

remark string
The remarks of instance. (Default: "").
size number
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType string
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
tag string
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId string
The ID of the resource UFS Volume.
charge_type str
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
create_time str
The time of creation of UFS Volume, formatted in RFC3339 time string.
duration float
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
expire_time str
The expiration time of UFS Volume, formatted in RFC3339 time string.
name str
protocol_type str
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

remark str
The remarks of instance. (Default: "").
size float
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storage_type str
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
tag str
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufs_volume_id str
The ID of the resource UFS Volume.
chargeType String
The charge type of instance, possible values are: year, month and dynamic as pay by hour (specific permission required). (Default: month).
createTime String
The time of creation of UFS Volume, formatted in RFC3339 time string.
duration Number
The duration that you will buy the instance (Default: 1). The value is 0 when pay by month and the instance will be valid till the last day of that month. It is not required when dynamic (pay by hour).
expireTime String
The expiration time of UFS Volume, formatted in RFC3339 time string.
name String
protocolType String
The protocol_type of the UFS Volume. Possible values are: NFSv3, NFSv4.

remark String
The remarks of instance. (Default: "").
size Number
The size of the UFS Volume, measured in GB (GigaByte), 500 - 100000 for Basic storage type, 100 - 20000 for Advanced storage type.
storageType String
The storage type of the UFS Volume. Possible values are: Basic, Advanced.
tag String
A tag assigned to UFS Volume, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
ufsVolumeId String
The ID of the resource UFS Volume.

Package Details

Repository
ucloud ucloud/terraform-provider-ucloud
License
Notes
This Pulumi package is based on the ucloud Terraform Provider.
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud