1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. nas
  5. FileSystem
Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi

alicloud.nas.FileSystem

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi

    Provides a Nas File System resource.

    After activating NAS, you can create a file system and purchase a storage package for it in the NAS console. The NAS console also enables you to view the file system details and remove unnecessary file systems.

    For information about NAS file system and how to use it, see Manage file systems

    NOTE: Available in v1.33.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = alicloud.nas.getZones({
        fileSystemType: "standard",
    });
    const foo = new alicloud.nas.FileSystem("foo", {
        protocolType: "NFS",
        storageType: "Performance",
        description: "terraform-example",
        encryptType: 1,
        zoneId: example.then(example => example.zones?.[0]?.zoneId),
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.nas.get_zones(file_system_type="standard")
    foo = alicloud.nas.FileSystem("foo",
        protocol_type="NFS",
        storage_type="Performance",
        description="terraform-example",
        encrypt_type=1,
        zone_id=example.zones[0].zone_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := nas.GetZones(ctx, &nas.GetZonesArgs{
    			FileSystemType: pulumi.StringRef("standard"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nas.NewFileSystem(ctx, "foo", &nas.FileSystemArgs{
    			ProtocolType: pulumi.String("NFS"),
    			StorageType:  pulumi.String("Performance"),
    			Description:  pulumi.String("terraform-example"),
    			EncryptType:  pulumi.Int(1),
    			ZoneId:       pulumi.String(example.Zones[0].ZoneId),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = AliCloud.Nas.GetZones.Invoke(new()
        {
            FileSystemType = "standard",
        });
    
        var foo = new AliCloud.Nas.FileSystem("foo", new()
        {
            ProtocolType = "NFS",
            StorageType = "Performance",
            Description = "terraform-example",
            EncryptType = 1,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.ZoneId),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.nas.NasFunctions;
    import com.pulumi.alicloud.nas.inputs.GetZonesArgs;
    import com.pulumi.alicloud.nas.FileSystem;
    import com.pulumi.alicloud.nas.FileSystemArgs;
    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) {
            final var example = NasFunctions.getZones(GetZonesArgs.builder()
                .fileSystemType("standard")
                .build());
    
            var foo = new FileSystem("foo", FileSystemArgs.builder()
                .protocolType("NFS")
                .storageType("Performance")
                .description("terraform-example")
                .encryptType("1")
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].zoneId()))
                .build());
    
        }
    }
    
    resources:
      foo:
        type: alicloud:nas:FileSystem
        properties:
          protocolType: NFS
          storageType: Performance
          description: terraform-example
          encryptType: '1'
          zoneId: ${example.zones[0].zoneId}
    variables:
      example:
        fn::invoke:
          Function: alicloud:nas:getZones
          Arguments:
            fileSystemType: standard
    
    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = alicloud.nas.getZones({
        fileSystemType: "extreme",
    });
    const foo = new alicloud.nas.FileSystem("foo", {
        fileSystemType: "extreme",
        protocolType: "NFS",
        zoneId: example.then(example => example.zones?.[0]?.zoneId),
        storageType: "standard",
        capacity: 100,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.nas.get_zones(file_system_type="extreme")
    foo = alicloud.nas.FileSystem("foo",
        file_system_type="extreme",
        protocol_type="NFS",
        zone_id=example.zones[0].zone_id,
        storage_type="standard",
        capacity=100)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := nas.GetZones(ctx, &nas.GetZonesArgs{
    			FileSystemType: pulumi.StringRef("extreme"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nas.NewFileSystem(ctx, "foo", &nas.FileSystemArgs{
    			FileSystemType: pulumi.String("extreme"),
    			ProtocolType:   pulumi.String("NFS"),
    			ZoneId:         pulumi.String(example.Zones[0].ZoneId),
    			StorageType:    pulumi.String("standard"),
    			Capacity:       pulumi.Int(100),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = AliCloud.Nas.GetZones.Invoke(new()
        {
            FileSystemType = "extreme",
        });
    
        var foo = new AliCloud.Nas.FileSystem("foo", new()
        {
            FileSystemType = "extreme",
            ProtocolType = "NFS",
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.ZoneId),
            StorageType = "standard",
            Capacity = 100,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.nas.NasFunctions;
    import com.pulumi.alicloud.nas.inputs.GetZonesArgs;
    import com.pulumi.alicloud.nas.FileSystem;
    import com.pulumi.alicloud.nas.FileSystemArgs;
    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) {
            final var example = NasFunctions.getZones(GetZonesArgs.builder()
                .fileSystemType("extreme")
                .build());
    
            var foo = new FileSystem("foo", FileSystemArgs.builder()
                .fileSystemType("extreme")
                .protocolType("NFS")
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].zoneId()))
                .storageType("standard")
                .capacity("100")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: alicloud:nas:FileSystem
        properties:
          fileSystemType: extreme
          protocolType: NFS
          zoneId: ${example.zones[0].zoneId}
          storageType: standard
          capacity: '100'
    variables:
      example:
        fn::invoke:
          Function: alicloud:nas:getZones
          Arguments:
            fileSystemType: extreme
    
    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = alicloud.nas.getZones({
        fileSystemType: "cpfs",
    });
    const exampleNetwork = new alicloud.vpc.Network("example", {
        vpcName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
    });
    const exampleSwitch = new alicloud.vpc.Switch("example", {
        vswitchName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
        vpcId: exampleNetwork.id,
        zoneId: example.then(example => example.zones?.[1]?.zoneId),
    });
    const exampleFileSystem = new alicloud.nas.FileSystem("example", {
        protocolType: "cpfs",
        storageType: "advance_200",
        fileSystemType: "cpfs",
        capacity: 3600,
        zoneId: example.then(example => example.zones?.[1]?.zoneId),
        vpcId: exampleNetwork.id,
        vswitchId: exampleSwitch.id,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.nas.get_zones(file_system_type="cpfs")
    example_network = alicloud.vpc.Network("example",
        vpc_name="terraform-example",
        cidr_block="172.17.3.0/24")
    example_switch = alicloud.vpc.Switch("example",
        vswitch_name="terraform-example",
        cidr_block="172.17.3.0/24",
        vpc_id=example_network.id,
        zone_id=example.zones[1].zone_id)
    example_file_system = alicloud.nas.FileSystem("example",
        protocol_type="cpfs",
        storage_type="advance_200",
        file_system_type="cpfs",
        capacity=3600,
        zone_id=example.zones[1].zone_id,
        vpc_id=example_network.id,
        vswitch_id=example_switch.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := nas.GetZones(ctx, &nas.GetZonesArgs{
    			FileSystemType: pulumi.StringRef("cpfs"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
    			VpcName:   pulumi.String("terraform-example"),
    			CidrBlock: pulumi.String("172.17.3.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
    			VswitchName: pulumi.String("terraform-example"),
    			CidrBlock:   pulumi.String("172.17.3.0/24"),
    			VpcId:       exampleNetwork.ID(),
    			ZoneId:      pulumi.String(example.Zones[1].ZoneId),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = nas.NewFileSystem(ctx, "example", &nas.FileSystemArgs{
    			ProtocolType:   pulumi.String("cpfs"),
    			StorageType:    pulumi.String("advance_200"),
    			FileSystemType: pulumi.String("cpfs"),
    			Capacity:       pulumi.Int(3600),
    			ZoneId:         pulumi.String(example.Zones[1].ZoneId),
    			VpcId:          exampleNetwork.ID(),
    			VswitchId:      exampleSwitch.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = AliCloud.Nas.GetZones.Invoke(new()
        {
            FileSystemType = "cpfs",
        });
    
        var exampleNetwork = new AliCloud.Vpc.Network("example", new()
        {
            VpcName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
        });
    
        var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
        {
            VswitchName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
            VpcId = exampleNetwork.Id,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[1]?.ZoneId),
        });
    
        var exampleFileSystem = new AliCloud.Nas.FileSystem("example", new()
        {
            ProtocolType = "cpfs",
            StorageType = "advance_200",
            FileSystemType = "cpfs",
            Capacity = 3600,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[1]?.ZoneId),
            VpcId = exampleNetwork.Id,
            VswitchId = exampleSwitch.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.nas.NasFunctions;
    import com.pulumi.alicloud.nas.inputs.GetZonesArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.nas.FileSystem;
    import com.pulumi.alicloud.nas.FileSystemArgs;
    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) {
            final var example = NasFunctions.getZones(GetZonesArgs.builder()
                .fileSystemType("cpfs")
                .build());
    
            var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
                .vpcName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .build());
    
            var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
                .vswitchName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .vpcId(exampleNetwork.id())
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[1].zoneId()))
                .build());
    
            var exampleFileSystem = new FileSystem("exampleFileSystem", FileSystemArgs.builder()
                .protocolType("cpfs")
                .storageType("advance_200")
                .fileSystemType("cpfs")
                .capacity(3600)
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[1].zoneId()))
                .vpcId(exampleNetwork.id())
                .vswitchId(exampleSwitch.id())
                .build());
    
        }
    }
    
    resources:
      exampleNetwork:
        type: alicloud:vpc:Network
        name: example
        properties:
          vpcName: terraform-example
          cidrBlock: 172.17.3.0/24
      exampleSwitch:
        type: alicloud:vpc:Switch
        name: example
        properties:
          vswitchName: terraform-example
          cidrBlock: 172.17.3.0/24
          vpcId: ${exampleNetwork.id}
          zoneId: ${example.zones[1].zoneId}
      exampleFileSystem:
        type: alicloud:nas:FileSystem
        name: example
        properties:
          protocolType: cpfs
          storageType: advance_200
          fileSystemType: cpfs
          capacity: 3600
          zoneId: ${example.zones[1].zoneId}
          vpcId: ${exampleNetwork.id}
          vswitchId: ${exampleSwitch.id}
    variables:
      example:
        fn::invoke:
          Function: alicloud:nas:getZones
          Arguments:
            fileSystemType: cpfs
    

    Create FileSystem Resource

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

    Constructor syntax

    new FileSystem(name: string, args: FileSystemArgs, opts?: CustomResourceOptions);
    @overload
    def FileSystem(resource_name: str,
                   args: FileSystemArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileSystem(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   protocol_type: Optional[str] = None,
                   storage_type: Optional[str] = None,
                   capacity: Optional[int] = None,
                   description: Optional[str] = None,
                   encrypt_type: Optional[int] = None,
                   file_system_type: Optional[str] = None,
                   kms_key_id: Optional[str] = None,
                   tags: Optional[Mapping[str, Any]] = None,
                   vpc_id: Optional[str] = None,
                   vswitch_id: Optional[str] = None,
                   zone_id: Optional[str] = None)
    func NewFileSystem(ctx *Context, name string, args FileSystemArgs, opts ...ResourceOption) (*FileSystem, error)
    public FileSystem(string name, FileSystemArgs args, CustomResourceOptions? opts = null)
    public FileSystem(String name, FileSystemArgs args)
    public FileSystem(String name, FileSystemArgs args, CustomResourceOptions options)
    
    type: alicloud:nas:FileSystem
    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 FileSystemArgs
    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 FileSystemArgs
    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 FileSystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var alicloudFileSystemResource = new AliCloud.Nas.FileSystem("alicloudFileSystemResource", new()
    {
        ProtocolType = "string",
        StorageType = "string",
        Capacity = 0,
        Description = "string",
        EncryptType = 0,
        FileSystemType = "string",
        KmsKeyId = "string",
        Tags = 
        {
            { "string", "any" },
        },
        VpcId = "string",
        VswitchId = "string",
        ZoneId = "string",
    });
    
    example, err := nas.NewFileSystem(ctx, "alicloudFileSystemResource", &nas.FileSystemArgs{
    	ProtocolType:   pulumi.String("string"),
    	StorageType:    pulumi.String("string"),
    	Capacity:       pulumi.Int(0),
    	Description:    pulumi.String("string"),
    	EncryptType:    pulumi.Int(0),
    	FileSystemType: pulumi.String("string"),
    	KmsKeyId:       pulumi.String("string"),
    	Tags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	VpcId:     pulumi.String("string"),
    	VswitchId: pulumi.String("string"),
    	ZoneId:    pulumi.String("string"),
    })
    
    var alicloudFileSystemResource = new FileSystem("alicloudFileSystemResource", FileSystemArgs.builder()
        .protocolType("string")
        .storageType("string")
        .capacity(0)
        .description("string")
        .encryptType(0)
        .fileSystemType("string")
        .kmsKeyId("string")
        .tags(Map.of("string", "any"))
        .vpcId("string")
        .vswitchId("string")
        .zoneId("string")
        .build());
    
    alicloud_file_system_resource = alicloud.nas.FileSystem("alicloudFileSystemResource",
        protocol_type="string",
        storage_type="string",
        capacity=0,
        description="string",
        encrypt_type=0,
        file_system_type="string",
        kms_key_id="string",
        tags={
            "string": "any",
        },
        vpc_id="string",
        vswitch_id="string",
        zone_id="string")
    
    const alicloudFileSystemResource = new alicloud.nas.FileSystem("alicloudFileSystemResource", {
        protocolType: "string",
        storageType: "string",
        capacity: 0,
        description: "string",
        encryptType: 0,
        fileSystemType: "string",
        kmsKeyId: "string",
        tags: {
            string: "any",
        },
        vpcId: "string",
        vswitchId: "string",
        zoneId: "string",
    });
    
    type: alicloud:nas:FileSystem
    properties:
        capacity: 0
        description: string
        encryptType: 0
        fileSystemType: string
        kmsKeyId: string
        protocolType: string
        storageType: string
        tags:
            string: any
        vpcId: string
        vswitchId: string
        zoneId: string
    

    FileSystem Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FileSystem resource accepts the following input properties:

    ProtocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    StorageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    Capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    Description string
    The File System description.
    EncryptType int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    FileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    KmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    VswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    ZoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    ProtocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    StorageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    Capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    Description string
    The File System description.
    EncryptType int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    FileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    KmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    VswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    ZoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    protocolType String
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType String
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    capacity Integer
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description String
    The File System description.
    encryptType Integer
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType String
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId String
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId String
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId String
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    protocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    capacity number
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description string
    The File System description.
    encryptType number
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    vpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    protocol_type str
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storage_type str
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description str
    The File System description.
    encrypt_type int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    file_system_type str
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kms_key_id str
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    vpc_id str
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitch_id str
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zone_id str
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    protocolType String
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType String
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    capacity Number
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description String
    The File System description.
    encryptType Number
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType String
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId String
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    tags Map<Any>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId String
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId String
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FileSystem Resource

    Get an existing FileSystem 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?: FileSystemState, opts?: CustomResourceOptions): FileSystem
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            capacity: Optional[int] = None,
            description: Optional[str] = None,
            encrypt_type: Optional[int] = None,
            file_system_type: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            protocol_type: Optional[str] = None,
            storage_type: Optional[str] = None,
            tags: Optional[Mapping[str, Any]] = None,
            vpc_id: Optional[str] = None,
            vswitch_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> FileSystem
    func GetFileSystem(ctx *Context, name string, id IDInput, state *FileSystemState, opts ...ResourceOption) (*FileSystem, error)
    public static FileSystem Get(string name, Input<string> id, FileSystemState? state, CustomResourceOptions? opts = null)
    public static FileSystem get(String name, Output<String> id, FileSystemState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    Description string
    The File System description.
    EncryptType int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    FileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    KmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    ProtocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    StorageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    VswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    ZoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    Capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    Description string
    The File System description.
    EncryptType int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    FileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    KmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    ProtocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    StorageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    VpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    VswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    ZoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    capacity Integer
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description String
    The File System description.
    encryptType Integer
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType String
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId String
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    protocolType String
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType String
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId String
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId String
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    capacity number
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description string
    The File System description.
    encryptType number
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType string
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId string
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    protocolType string
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType string
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    vpcId string
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId string
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId string
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    capacity int
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description str
    The File System description.
    encrypt_type int
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    file_system_type str
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kms_key_id str
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    protocol_type str
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storage_type str
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    vpc_id str
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitch_id str
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zone_id str
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.
    capacity Number
    The capacity of the file system. The capacity is required when the file_system_type is extreme. Unit: gib; Note: The minimum value is 100.
    description String
    The File System description.
    encryptType Number
    Whether the file system is encrypted. Using kms service escrow key to encrypt and store the file system data. When reading and writing encrypted data, there is no need to decrypt.

    • Valid values:
    fileSystemType String
    the type of the file system. Valid values: standard (Default), extreme, cpfs.
    kmsKeyId String
    The id of the KMS key. The kms_key_id is required when the encrypt_type is 2.
    protocolType String
    The protocol type of the file system. Valid values: NFS, SMB (Available when the file_system_type is standard), cpfs (Available when the file_system_type is cpfs).
    storageType String
    The storage type of the file System.

    • Valid values:
    • Performance (Available when the file_system_type is standard)
    • Capacity (Available when the file_system_type is standard)
    tags Map<Any>
    A mapping of tags to assign to the resource.
    vpcId String
    The id of the VPC. The vpc_id is required when the file_system_type is cpfs.
    vswitchId String
    The id of the vSwitch. The vswitch_id is required when the file_system_type is cpfs.
    zoneId String
    The available zones information that supports nas.When FileSystemType=standard, this parameter is not required. Note: By default, a qualified availability zone is randomly selected according to the protocol_type and storage_type configuration.

    Import

    Nas File System can be imported using the id, e.g.

    $ pulumi import alicloud:nas/fileSystem:FileSystem foo 1337849c59
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi