This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

nas¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.nas.AccessGroup(resource_name, opts=None, description=None, name=None, type=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Nas Access Group resource.

In NAS, the permission group acts as a whitelist that allows you to restrict file system access. You can allow specified IP addresses or CIDR blocks to access the file system, and assign different levels of access permission to different IP addresses or CIDR blocks by adding rules to the permission group.

NOTE: Available in v1.33.0+.

import pulumi
import pulumi_alicloud as alicloud

foo = alicloud.nas.AccessGroup("foo",
    description="test_AccessG",
    type="Classic")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The Access Group description.
name (pulumi.Input[str]) – A Name of one Access Group.
type (pulumi.Input[str]) – A Type of one Access Group. Valid values: Vpc and Classic.

description: pulumi.Output[str] = None¶: The Access Group description.

name: pulumi.Output[str] = None¶: A Name of one Access Group.

type: pulumi.Output[str] = None¶: A Type of one Access Group. Valid values: Vpc and Classic.

static get(resource_name, id, opts=None, description=None, name=None, type=None)¶

Get an existing AccessGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The Access Group description.
name (pulumi.Input[str]) – A Name of one Access Group.
type (pulumi.Input[str]) – A Type of one Access Group. Valid values: Vpc and Classic.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.nas.AccessRule(resource_name, opts=None, access_group_name=None, priority=None, rw_access_type=None, source_cidr_ip=None, user_access_type=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Nas Access Rule resource.

When NAS is activated, the Default VPC Permission Group is automatically generated. It allows all IP addresses in a VPC to access the mount point with full permissions. Full permissions include Read/Write permission with no restriction on root users.

NOTE: Available in v1.34.0+.

import pulumi
import pulumi_alicloud as alicloud

foo_access_group = alicloud.nas.AccessGroup("fooAccessGroup",
    description="tf-testAccNasConfig",
    type="Vpc")
foo_access_rule = alicloud.nas.AccessRule("fooAccessRule",
    access_group_name=foo_access_group.id,
    priority=2,
    rw_access_type="RDWR",
    source_cidr_ip="168.1.1.0/16",
    user_access_type="no_squash")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_group_name (pulumi.Input[str]) – Permission group name.
priority (pulumi.Input[float]) – Priority level. Range: 1-100. Default value: 1.
rw_access_type (pulumi.Input[str]) – Read-write permission type: RDWR (default), RDONLY.
source_cidr_ip (pulumi.Input[str]) – Address or address segment.
user_access_type (pulumi.Input[str]) – User permission type: no_squash (default), root_squash, all_squash.

access_group_name: pulumi.Output[str] = None¶: Permission group name.

access_rule_id: pulumi.Output[str] = None¶: The nas access rule ID.

priority: pulumi.Output[float] = None¶: Priority level. Range: 1-100. Default value: 1.

rw_access_type: pulumi.Output[str] = None¶: Read-write permission type: RDWR (default), RDONLY.

source_cidr_ip: pulumi.Output[str] = None¶: Address or address segment.

user_access_type: pulumi.Output[str] = None¶: User permission type: no_squash (default), root_squash, all_squash.

static get(resource_name, id, opts=None, access_group_name=None, access_rule_id=None, priority=None, rw_access_type=None, source_cidr_ip=None, user_access_type=None)¶

Get an existing AccessRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_group_name (pulumi.Input[str]) – Permission group name.
access_rule_id (pulumi.Input[str]) – The nas access rule ID.
priority (pulumi.Input[float]) – Priority level. Range: 1-100. Default value: 1.
rw_access_type (pulumi.Input[str]) – Read-write permission type: RDWR (default), RDONLY.
source_cidr_ip (pulumi.Input[str]) – Address or address segment.
user_access_type (pulumi.Input[str]) – User permission type: no_squash (default), root_squash, all_squash.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.nas.AwaitableGetAccessGroupsResult(description=None, groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None, type=None)¶

class pulumi_alicloud.nas.AwaitableGetAccessRulesResult(access_group_name=None, id=None, ids=None, output_file=None, rules=None, rw_access=None, source_cidr_ip=None, user_access=None)¶

class pulumi_alicloud.nas.AwaitableGetFileSystemsResult(description_regex=None, descriptions=None, id=None, ids=None, output_file=None, protocol_type=None, storage_type=None, systems=None)¶

class pulumi_alicloud.nas.AwaitableGetMountTargetsResult(access_group_name=None, file_system_id=None, id=None, ids=None, mount_target_domain=None, output_file=None, targets=None, type=None, vpc_id=None, vswitch_id=None)¶

class pulumi_alicloud.nas.AwaitableGetProtocolsResult(id=None, output_file=None, protocols=None, type=None, zone_id=None)¶

class pulumi_alicloud.nas.FileSystem(resource_name, opts=None, description=None, protocol_type=None, storage_type=None, __props__=None, __name__=None, __opts__=None)¶

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+.

import pulumi
import pulumi_alicloud as alicloud

foo = alicloud.nas.FileSystem("foo",
    description="tf-testAccNasConfig",
    protocol_type="NFS",
    storage_type="Performance")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The File System description.
protocol_type (pulumi.Input[str]) – The Protocol Type of a File System. Valid values: NFS and SMB.
storage_type (pulumi.Input[str]) – The Storage Type of a File System. Valid values: Capacity and Performance.

description: pulumi.Output[str] = None¶: The File System description.

protocol_type: pulumi.Output[str] = None¶: The Protocol Type of a File System. Valid values: NFS and SMB.

storage_type: pulumi.Output[str] = None¶: The Storage Type of a File System. Valid values: Capacity and Performance.

static get(resource_name, id, opts=None, description=None, protocol_type=None, storage_type=None)¶

Get an existing FileSystem resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The File System description.
protocol_type (pulumi.Input[str]) – The Protocol Type of a File System. Valid values: NFS and SMB.
storage_type (pulumi.Input[str]) – The Storage Type of a File System. Valid values: Capacity and Performance.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.nas.GetAccessGroupsResult(description=None, groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None, type=None)¶

A collection of values returned by getAccessGroups.

description = None¶: Destription of the AccessGroup.

groups = None¶: A list of AccessGroups. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of AccessGroup IDs, the value is set to names .

names = None¶: A list of AccessGroup names.

type = None¶: AccessGroupType of the AccessGroup.

class pulumi_alicloud.nas.GetAccessRulesResult(access_group_name=None, id=None, ids=None, output_file=None, rules=None, rw_access=None, source_cidr_ip=None, user_access=None)¶

A collection of values returned by getAccessRules.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of rule IDs, Each element set to access_rule_id (Each element formats as <access_group_name>:<access rule id> before 1.53.0).

rules = None¶: A list of AccessRules. Each element contains the following attributes:

rw_access = None¶: RWAccess of the AccessRule.

source_cidr_ip = None¶: SourceCidrIp of the AccessRule.

user_access = None¶: UserAccess of the AccessRule

class pulumi_alicloud.nas.GetFileSystemsResult(description_regex=None, descriptions=None, id=None, ids=None, output_file=None, protocol_type=None, storage_type=None, systems=None)¶

A collection of values returned by getFileSystems.

descriptions = None¶: A list of FileSystem descriptions.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of FileSystem Id.

protocol_type = None¶: ProtocolType block of the FileSystem

storage_type = None¶: StorageType block of the FileSystem.

systems = None¶: A list of VPCs. Each element contains the following attributes:

class pulumi_alicloud.nas.GetMountTargetsResult(access_group_name=None, file_system_id=None, id=None, ids=None, mount_target_domain=None, output_file=None, targets=None, type=None, vpc_id=None, vswitch_id=None)¶

A collection of values returned by getMountTargets.

access_group_name = None¶: AccessGroup of The MountTarget.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of MountTargetDomain.

mount_target_domain = None¶

MountTargetDomain of the MountTarget.

type- NetworkType of The MountTarget.

targets = None¶: A list of MountTargetDomains. Each element contains the following attributes:

vpc_id = None¶: VpcId of The MountTarget.

vswitch_id = None¶: VSwitchId of The MountTarget.

class pulumi_alicloud.nas.GetProtocolsResult(id=None, output_file=None, protocols=None, type=None, zone_id=None)¶

A collection of values returned by getProtocols.

id = None¶: The provider-assigned unique ID for this managed resource.

protocols = None¶: A list of supported protocol type..

class pulumi_alicloud.nas.MountTarget(resource_name, opts=None, access_group_name=None, file_system_id=None, status=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Nas Mount Target resource.

NOTE: Available in v1.34.0+.
NOTE: Currently this resource support create a mount point in a classic network only when current region is China mainland regions.
NOTE: You must grant NAS with specific RAM permissions when creating a classic mount targets, and it only can be achieved by creating a classic mount target mannually. See Add a mount point and Why do I need RAM permissions to create a mount point in a classic network.

import pulumi
import pulumi_alicloud as alicloud

foo_file_system = alicloud.nas.FileSystem("fooFileSystem",
    description="tf-testAccNasConfigFs",
    protocol_type="NFS",
    storage_type="Performance")
foo_access_group = alicloud.nas.AccessGroup("fooAccessGroup",
    description="tf-testAccNasConfig",
    type="Classic")
bar = alicloud.nas.AccessGroup("bar",
    description="tf-testAccNasConfig-2",
    type="Classic")
foo_mount_target = alicloud.nas.MountTarget("fooMountTarget",
    access_group_name=foo_access_group.id,
    file_system_id=foo_file_system.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_group_name (pulumi.Input[str]) – Permission group name.
file_system_id (pulumi.Input[str]) – File system ID.
status (pulumi.Input[str]) – Whether the MountTarget is active. An inactive MountTarget is inusable. Valid values are Active(default) and Inactive.
vswitch_id (pulumi.Input[str]) – VSwitch ID.

access_group_name: pulumi.Output[str] = None¶: Permission group name.

file_system_id: pulumi.Output[str] = None¶: File system ID.

status: pulumi.Output[str] = None¶: Whether the MountTarget is active. An inactive MountTarget is inusable. Valid values are Active(default) and Inactive.

vswitch_id: pulumi.Output[str] = None¶: VSwitch ID.

static get(resource_name, id, opts=None, access_group_name=None, file_system_id=None, status=None, vswitch_id=None)¶

Get an existing MountTarget resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_group_name (pulumi.Input[str]) – Permission group name.
file_system_id (pulumi.Input[str]) – File system ID.
status (pulumi.Input[str]) – Whether the MountTarget is active. An inactive MountTarget is inusable. Valid values are Active(default) and Inactive.
vswitch_id (pulumi.Input[str]) – VSwitch ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.nas.get_access_groups(description=None, name_regex=None, output_file=None, type=None, opts=None)¶

This data source provides user-available access groups. Use when you can create mount points

NOTE: Available in 1.35.0+

import pulumi
import pulumi_alicloud as alicloud

ag = alicloud.nas.get_access_groups(description="tf-testAccAccessGroupsdatasource",
    name_regex="^foo",
    type="Classic")
pulumi.export("alicloudNasAccessGroupsId", ag.groups[0]["id"])

Parameters

description (str) – Filter results by a specific Description.
name_regex (str) – A regex string to filter AccessGroups by name.
type (str) – Filter results by a specific AccessGroupType.

pulumi_alicloud.nas.get_access_rules(access_group_name=None, ids=None, output_file=None, rw_access=None, source_cidr_ip=None, user_access=None, opts=None)¶

This data source provides AccessRule available to the user.

NOTE: Available in 1.35.0+

Parameters

access_group_name (str) – Filter results by a specific AccessGroupName.
ids (list) – A list of rule IDs.
rw_access (str) – Filter results by a specific RWAccess.
source_cidr_ip (str) – Filter results by a specific SourceCidrIp.
user_access (str) – Filter results by a specific UserAccess.

pulumi_alicloud.nas.get_file_systems(description_regex=None, ids=None, output_file=None, protocol_type=None, storage_type=None, opts=None)¶

This data source provides FileSystems available to the user.

NOTE: Available in 1.35.0+

import pulumi
import pulumi_alicloud as alicloud

fs = alicloud.nas.get_file_systems(description=alicloud_nas_file_system["foo"]["description"],
    protocol_type="NFS")
pulumi.export("alicloudNasFileSystemsId", fs.systems[0]["id"])

Parameters

description_regex (str) – A regex string to filter the results by the ：FileSystem description.
ids (list) – A list of FileSystemId.
protocol_type (str) – Filter results by a specific ProtocolType.
storage_type (str) – Filter results by a specific StorageType.

pulumi_alicloud.nas.get_mount_targets(access_group_name=None, file_system_id=None, ids=None, mount_target_domain=None, output_file=None, type=None, vpc_id=None, vswitch_id=None, opts=None)¶

This data source provides MountTargets available to the user.

NOTE: Available in 1.35.0+

import pulumi
import pulumi_alicloud as alicloud

mt = alicloud.nas.get_mount_targets(access_group_name="tf-testAccNasConfig",
    file_system_id="1a2sc4d")
pulumi.export("alicloudNasMountTargetsId", mt.targets[0]["id"])

Parameters

access_group_name (str) – Filter results by a specific AccessGroupName.
file_system_id (str) – The ID of the FileSystem that owns the MountTarget.
ids (list) – A list of MountTargetDomain.
mount_target_domain (str) – Filter results by a specific MountTargetDomain.
type (str) – Filter results by a specific NetworkType.
vpc_id (str) – Filter results by a specific VpcId.
vswitch_id (str) – Filter results by a specific VSwitchId.

pulumi_alicloud.nas.get_protocols(output_file=None, type=None, zone_id=None, opts=None)¶

Provide a data source to retrieve the type of protocol used to create NAS file system.

NOTE: Available in 1.42.0

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.nas.get_protocols(output_file="protocols.txt",
    type="Performance",
    zone_id="cn-beijing-e")
pulumi.export("nasProtocolsProtocol", default.protocols[0])

Parameters

type (str) – The file system type. Valid Values: Performance and Capacity.
zone_id (str) – String to filter results by zone id.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

nas¶

On This Page