1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. nas
  5. AccessRule
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.nas.AccessRule

Explore with Pulumi AI

Provides a NAS Access Rule resource.

For information about NAS Access Rule and how to use it, see What is Access Rule.

NOTE: Available since v1.34.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
const defaultAccessGroup = new alicloud.nas.AccessGroup("default", {
    accessGroupType: "Vpc",
    description: "ExtremeAccessGroup",
    accessGroupName: `terraform-example-${_default.result}`,
    fileSystemType: "extreme",
});
const defaultAccessRule = new alicloud.nas.AccessRule("default", {
    accessGroupName: defaultAccessGroup.accessGroupName,
    rwAccessType: "RDONLY",
    ipv6SourceCidrIp: "::1",
    userAccessType: "no_squash",
    priority: 1,
    fileSystemType: "extreme",
});
Copy
import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = random.index.Integer("default",
    min=10000,
    max=99999)
default_access_group = alicloud.nas.AccessGroup("default",
    access_group_type="Vpc",
    description="ExtremeAccessGroup",
    access_group_name=f"terraform-example-{default['result']}",
    file_system_type="extreme")
default_access_rule = alicloud.nas.AccessRule("default",
    access_group_name=default_access_group.access_group_name,
    rw_access_type="RDONLY",
    ipv6_source_cidr_ip="::1",
    user_access_type="no_squash",
    priority=1,
    file_system_type="extreme")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
			Min: 10000,
			Max: 99999,
		})
		if err != nil {
			return err
		}
		defaultAccessGroup, err := nas.NewAccessGroup(ctx, "default", &nas.AccessGroupArgs{
			AccessGroupType: pulumi.String("Vpc"),
			Description:     pulumi.String("ExtremeAccessGroup"),
			AccessGroupName: pulumi.Sprintf("terraform-example-%v", _default.Result),
			FileSystemType:  pulumi.String("extreme"),
		})
		if err != nil {
			return err
		}
		_, err = nas.NewAccessRule(ctx, "default", &nas.AccessRuleArgs{
			AccessGroupName:  defaultAccessGroup.AccessGroupName,
			RwAccessType:     pulumi.String("RDONLY"),
			Ipv6SourceCidrIp: pulumi.String("::1"),
			UserAccessType:   pulumi.String("no_squash"),
			Priority:         pulumi.Int(1),
			FileSystemType:   pulumi.String("extreme"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var defaultAccessGroup = new AliCloud.Nas.AccessGroup("default", new()
    {
        AccessGroupType = "Vpc",
        Description = "ExtremeAccessGroup",
        AccessGroupName = $"terraform-example-{@default.Result}",
        FileSystemType = "extreme",
    });

    var defaultAccessRule = new AliCloud.Nas.AccessRule("default", new()
    {
        AccessGroupName = defaultAccessGroup.AccessGroupName,
        RwAccessType = "RDONLY",
        Ipv6SourceCidrIp = "::1",
        UserAccessType = "no_squash",
        Priority = 1,
        FileSystemType = "extreme",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.nas.AccessGroup;
import com.pulumi.alicloud.nas.AccessGroupArgs;
import com.pulumi.alicloud.nas.AccessRule;
import com.pulumi.alicloud.nas.AccessRuleArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var default_ = new Integer("default", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var defaultAccessGroup = new AccessGroup("defaultAccessGroup", AccessGroupArgs.builder()
            .accessGroupType("Vpc")
            .description("ExtremeAccessGroup")
            .accessGroupName(String.format("terraform-example-%s", default_.result()))
            .fileSystemType("extreme")
            .build());

        var defaultAccessRule = new AccessRule("defaultAccessRule", AccessRuleArgs.builder()
            .accessGroupName(defaultAccessGroup.accessGroupName())
            .rwAccessType("RDONLY")
            .ipv6SourceCidrIp("::1")
            .userAccessType("no_squash")
            .priority("1")
            .fileSystemType("extreme")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  default:
    type: random:integer
    properties:
      min: 10000
      max: 99999
  defaultAccessGroup:
    type: alicloud:nas:AccessGroup
    name: default
    properties:
      accessGroupType: Vpc
      description: ExtremeAccessGroup
      accessGroupName: terraform-example-${default.result}
      fileSystemType: extreme
  defaultAccessRule:
    type: alicloud:nas:AccessRule
    name: default
    properties:
      accessGroupName: ${defaultAccessGroup.accessGroupName}
      rwAccessType: RDONLY
      ipv6SourceCidrIp: ::1
      userAccessType: no_squash
      priority: '1'
      fileSystemType: extreme
Copy

Create AccessRule Resource

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

Constructor syntax

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

@overload
def AccessRule(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_group_name: Optional[str] = None,
               file_system_type: Optional[str] = None,
               ipv6_source_cidr_ip: Optional[str] = None,
               priority: Optional[int] = None,
               rw_access_type: Optional[str] = None,
               source_cidr_ip: Optional[str] = None,
               user_access_type: Optional[str] = None)
func NewAccessRule(ctx *Context, name string, args AccessRuleArgs, opts ...ResourceOption) (*AccessRule, error)
public AccessRule(string name, AccessRuleArgs args, CustomResourceOptions? opts = null)
public AccessRule(String name, AccessRuleArgs args)
public AccessRule(String name, AccessRuleArgs args, CustomResourceOptions options)
type: alicloud:nas:AccessRule
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. AccessRuleArgs
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. AccessRuleArgs
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. AccessRuleArgs
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. AccessRuleArgs
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. AccessRuleArgs
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 alicloudAccessRuleResource = new AliCloud.Nas.AccessRule("alicloudAccessRuleResource", new()
{
    AccessGroupName = "string",
    FileSystemType = "string",
    Ipv6SourceCidrIp = "string",
    Priority = 0,
    RwAccessType = "string",
    SourceCidrIp = "string",
    UserAccessType = "string",
});
Copy
example, err := nas.NewAccessRule(ctx, "alicloudAccessRuleResource", &nas.AccessRuleArgs{
	AccessGroupName:  pulumi.String("string"),
	FileSystemType:   pulumi.String("string"),
	Ipv6SourceCidrIp: pulumi.String("string"),
	Priority:         pulumi.Int(0),
	RwAccessType:     pulumi.String("string"),
	SourceCidrIp:     pulumi.String("string"),
	UserAccessType:   pulumi.String("string"),
})
Copy
var alicloudAccessRuleResource = new AccessRule("alicloudAccessRuleResource", AccessRuleArgs.builder()
    .accessGroupName("string")
    .fileSystemType("string")
    .ipv6SourceCidrIp("string")
    .priority(0)
    .rwAccessType("string")
    .sourceCidrIp("string")
    .userAccessType("string")
    .build());
Copy
alicloud_access_rule_resource = alicloud.nas.AccessRule("alicloudAccessRuleResource",
    access_group_name="string",
    file_system_type="string",
    ipv6_source_cidr_ip="string",
    priority=0,
    rw_access_type="string",
    source_cidr_ip="string",
    user_access_type="string")
Copy
const alicloudAccessRuleResource = new alicloud.nas.AccessRule("alicloudAccessRuleResource", {
    accessGroupName: "string",
    fileSystemType: "string",
    ipv6SourceCidrIp: "string",
    priority: 0,
    rwAccessType: "string",
    sourceCidrIp: "string",
    userAccessType: "string",
});
Copy
type: alicloud:nas:AccessRule
properties:
    accessGroupName: string
    fileSystemType: string
    ipv6SourceCidrIp: string
    priority: 0
    rwAccessType: string
    sourceCidrIp: string
    userAccessType: string
Copy

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

AccessGroupName
This property is required.
Changes to this property will trigger replacement.
string
AccessGroupName.
FileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
Ipv6SourceCidrIp string
Ipv6SourceCidrIp.
Priority int
Priority.
RwAccessType string
RWAccess.
SourceCidrIp string
SourceCidrIp.
UserAccessType string
UserAccess.
AccessGroupName
This property is required.
Changes to this property will trigger replacement.
string
AccessGroupName.
FileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
Ipv6SourceCidrIp string
Ipv6SourceCidrIp.
Priority int
Priority.
RwAccessType string
RWAccess.
SourceCidrIp string
SourceCidrIp.
UserAccessType string
UserAccess.
accessGroupName
This property is required.
Changes to this property will trigger replacement.
String
AccessGroupName.
fileSystemType Changes to this property will trigger replacement. String
filesystem type. include standard, extreme.
ipv6SourceCidrIp String
Ipv6SourceCidrIp.
priority Integer
Priority.
rwAccessType String
RWAccess.
sourceCidrIp String
SourceCidrIp.
userAccessType String
UserAccess.
accessGroupName
This property is required.
Changes to this property will trigger replacement.
string
AccessGroupName.
fileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
ipv6SourceCidrIp string
Ipv6SourceCidrIp.
priority number
Priority.
rwAccessType string
RWAccess.
sourceCidrIp string
SourceCidrIp.
userAccessType string
UserAccess.
access_group_name
This property is required.
Changes to this property will trigger replacement.
str
AccessGroupName.
file_system_type Changes to this property will trigger replacement. str
filesystem type. include standard, extreme.
ipv6_source_cidr_ip str
Ipv6SourceCidrIp.
priority int
Priority.
rw_access_type str
RWAccess.
source_cidr_ip str
SourceCidrIp.
user_access_type str
UserAccess.
accessGroupName
This property is required.
Changes to this property will trigger replacement.
String
AccessGroupName.
fileSystemType Changes to this property will trigger replacement. String
filesystem type. include standard, extreme.
ipv6SourceCidrIp String
Ipv6SourceCidrIp.
priority Number
Priority.
rwAccessType String
RWAccess.
sourceCidrIp String
SourceCidrIp.
userAccessType String
UserAccess.

Outputs

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

AccessRuleId string
The first ID of the resource.
Id string
The provider-assigned unique ID for this managed resource.
AccessRuleId string
The first ID of the resource.
Id string
The provider-assigned unique ID for this managed resource.
accessRuleId String
The first ID of the resource.
id String
The provider-assigned unique ID for this managed resource.
accessRuleId string
The first ID of the resource.
id string
The provider-assigned unique ID for this managed resource.
access_rule_id str
The first ID of the resource.
id str
The provider-assigned unique ID for this managed resource.
accessRuleId String
The first ID of the resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AccessRule Resource

Get an existing AccessRule 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?: AccessRuleState, opts?: CustomResourceOptions): AccessRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_group_name: Optional[str] = None,
        access_rule_id: Optional[str] = None,
        file_system_type: Optional[str] = None,
        ipv6_source_cidr_ip: Optional[str] = None,
        priority: Optional[int] = None,
        rw_access_type: Optional[str] = None,
        source_cidr_ip: Optional[str] = None,
        user_access_type: Optional[str] = None) -> AccessRule
func GetAccessRule(ctx *Context, name string, id IDInput, state *AccessRuleState, opts ...ResourceOption) (*AccessRule, error)
public static AccessRule Get(string name, Input<string> id, AccessRuleState? state, CustomResourceOptions? opts = null)
public static AccessRule get(String name, Output<String> id, AccessRuleState state, CustomResourceOptions options)
resources:  _:    type: alicloud:nas:AccessRule    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:
AccessGroupName Changes to this property will trigger replacement. string
AccessGroupName.
AccessRuleId string
The first ID of the resource.
FileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
Ipv6SourceCidrIp string
Ipv6SourceCidrIp.
Priority int
Priority.
RwAccessType string
RWAccess.
SourceCidrIp string
SourceCidrIp.
UserAccessType string
UserAccess.
AccessGroupName Changes to this property will trigger replacement. string
AccessGroupName.
AccessRuleId string
The first ID of the resource.
FileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
Ipv6SourceCidrIp string
Ipv6SourceCidrIp.
Priority int
Priority.
RwAccessType string
RWAccess.
SourceCidrIp string
SourceCidrIp.
UserAccessType string
UserAccess.
accessGroupName Changes to this property will trigger replacement. String
AccessGroupName.
accessRuleId String
The first ID of the resource.
fileSystemType Changes to this property will trigger replacement. String
filesystem type. include standard, extreme.
ipv6SourceCidrIp String
Ipv6SourceCidrIp.
priority Integer
Priority.
rwAccessType String
RWAccess.
sourceCidrIp String
SourceCidrIp.
userAccessType String
UserAccess.
accessGroupName Changes to this property will trigger replacement. string
AccessGroupName.
accessRuleId string
The first ID of the resource.
fileSystemType Changes to this property will trigger replacement. string
filesystem type. include standard, extreme.
ipv6SourceCidrIp string
Ipv6SourceCidrIp.
priority number
Priority.
rwAccessType string
RWAccess.
sourceCidrIp string
SourceCidrIp.
userAccessType string
UserAccess.
access_group_name Changes to this property will trigger replacement. str
AccessGroupName.
access_rule_id str
The first ID of the resource.
file_system_type Changes to this property will trigger replacement. str
filesystem type. include standard, extreme.
ipv6_source_cidr_ip str
Ipv6SourceCidrIp.
priority int
Priority.
rw_access_type str
RWAccess.
source_cidr_ip str
SourceCidrIp.
user_access_type str
UserAccess.
accessGroupName Changes to this property will trigger replacement. String
AccessGroupName.
accessRuleId String
The first ID of the resource.
fileSystemType Changes to this property will trigger replacement. String
filesystem type. include standard, extreme.
ipv6SourceCidrIp String
Ipv6SourceCidrIp.
priority Number
Priority.
rwAccessType String
RWAccess.
sourceCidrIp String
SourceCidrIp.
userAccessType String
UserAccess.

Import

NAS Access Rule can be imported using the id, e.g.

$ pulumi import alicloud:nas/accessRule:AccessRule example <access_group_name>:<file_system_type>:<access_rule_id>
Copy

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.