1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. cloudstoragegateway
  5. GatewayFileShare
alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.cloudstoragegateway.GatewayFileShare

Provides a Cloud Storage Gateway Gateway File Share resource.

For information about Cloud Storage Gateway Gateway File Share and how to use it, see What is Gateway File Share.

NOTE: Available in v1.144.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var defaultStocks = AliCloud.CloudStorageGateway.GetStocks.Invoke(new()
    {
        GatewayClass = "Standard",
    });

    var vpc = new AliCloud.Vpc.Network("vpc", new()
    {
        VpcName = "example_value",
        CidrBlock = "172.16.0.0/12",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
    {
        VpcId = vpc.Id,
        CidrBlock = "172.16.0.0/21",
        ZoneId = defaultStocks.Apply(getStocksResult => getStocksResult.Stocks[0]?.ZoneId),
        VswitchName = "example_value",
    });

    var defaultStorageBundle = new AliCloud.CloudStorageGateway.StorageBundle("defaultStorageBundle", new()
    {
        StorageBundleName = "example_value",
    });

    var defaultGateway = new AliCloud.CloudStorageGateway.Gateway("defaultGateway", new()
    {
        Description = "tf-acctestDesalone",
        GatewayClass = "Standard",
        Type = "File",
        PaymentType = "PayAsYouGo",
        VswitchId = defaultSwitch.Id,
        ReleaseAfterExpiration = true,
        PublicNetworkBandwidth = 10,
        StorageBundleId = defaultStorageBundle.Id,
        Location = "Cloud",
        GatewayName = "example_value",
    });

    var defaultGatewayCacheDisk = new AliCloud.CloudStorageGateway.GatewayCacheDisk("defaultGatewayCacheDisk", new()
    {
        CacheDiskCategory = "cloud_efficiency",
        GatewayId = defaultGateway.Id,
        CacheDiskSizeInGb = 50,
    });

    var defaultBucket = new AliCloud.Oss.Bucket("defaultBucket", new()
    {
        BucketName = "example_value",
    });

    var defaultGatewayFileShare = new AliCloud.CloudStorageGateway.GatewayFileShare("defaultGatewayFileShare", new()
    {
        GatewayFileShareName = "example_value",
        GatewayId = defaultGateway.Id,
        LocalPath = defaultGatewayCacheDisk.LocalFilePath,
        OssBucketName = defaultBucket.BucketName,
        OssEndpoint = defaultBucket.ExtranetEndpoint,
        Protocol = "NFS",
        RemoteSync = true,
        PollingInterval = 4500,
        FeLimit = 0,
        BackendLimit = 0,
        CacheMode = "Cache",
        Squash = "none",
        LagPeriod = 5,
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cloudstoragegateway"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
	"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 {
		defaultStocks, err := cloudstoragegateway.GetStocks(ctx, &cloudstoragegateway.GetStocksArgs{
			GatewayClass: pulumi.StringRef("Standard"),
		}, nil)
		if err != nil {
			return err
		}
		vpc, err := vpc.NewNetwork(ctx, "vpc", &vpc.NetworkArgs{
			VpcName:   pulumi.String("example_value"),
			CidrBlock: pulumi.String("172.16.0.0/12"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
			VpcId:       vpc.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/21"),
			ZoneId:      *pulumi.String(defaultStocks.Stocks[0].ZoneId),
			VswitchName: pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		defaultStorageBundle, err := cloudstoragegateway.NewStorageBundle(ctx, "defaultStorageBundle", &cloudstoragegateway.StorageBundleArgs{
			StorageBundleName: pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		defaultGateway, err := cloudstoragegateway.NewGateway(ctx, "defaultGateway", &cloudstoragegateway.GatewayArgs{
			Description:            pulumi.String("tf-acctestDesalone"),
			GatewayClass:           pulumi.String("Standard"),
			Type:                   pulumi.String("File"),
			PaymentType:            pulumi.String("PayAsYouGo"),
			VswitchId:              defaultSwitch.ID(),
			ReleaseAfterExpiration: pulumi.Bool(true),
			PublicNetworkBandwidth: pulumi.Int(10),
			StorageBundleId:        defaultStorageBundle.ID(),
			Location:               pulumi.String("Cloud"),
			GatewayName:            pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		defaultGatewayCacheDisk, err := cloudstoragegateway.NewGatewayCacheDisk(ctx, "defaultGatewayCacheDisk", &cloudstoragegateway.GatewayCacheDiskArgs{
			CacheDiskCategory: pulumi.String("cloud_efficiency"),
			GatewayId:         defaultGateway.ID(),
			CacheDiskSizeInGb: pulumi.Int(50),
		})
		if err != nil {
			return err
		}
		defaultBucket, err := oss.NewBucket(ctx, "defaultBucket", &oss.BucketArgs{
			Bucket: pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		_, err = cloudstoragegateway.NewGatewayFileShare(ctx, "defaultGatewayFileShare", &cloudstoragegateway.GatewayFileShareArgs{
			GatewayFileShareName: pulumi.String("example_value"),
			GatewayId:            defaultGateway.ID(),
			LocalPath:            defaultGatewayCacheDisk.LocalFilePath,
			OssBucketName:        defaultBucket.Bucket,
			OssEndpoint:          defaultBucket.ExtranetEndpoint,
			Protocol:             pulumi.String("NFS"),
			RemoteSync:           pulumi.Bool(true),
			PollingInterval:      pulumi.Int(4500),
			FeLimit:              pulumi.Int(0),
			BackendLimit:         pulumi.Int(0),
			CacheMode:            pulumi.String("Cache"),
			Squash:               pulumi.String("none"),
			LagPeriod:            pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cloudstoragegateway.CloudstoragegatewayFunctions;
import com.pulumi.alicloud.cloudstoragegateway.inputs.GetStocksArgs;
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.cloudstoragegateway.StorageBundle;
import com.pulumi.alicloud.cloudstoragegateway.StorageBundleArgs;
import com.pulumi.alicloud.cloudstoragegateway.Gateway;
import com.pulumi.alicloud.cloudstoragegateway.GatewayArgs;
import com.pulumi.alicloud.cloudstoragegateway.GatewayCacheDisk;
import com.pulumi.alicloud.cloudstoragegateway.GatewayCacheDiskArgs;
import com.pulumi.alicloud.oss.Bucket;
import com.pulumi.alicloud.oss.BucketArgs;
import com.pulumi.alicloud.cloudstoragegateway.GatewayFileShare;
import com.pulumi.alicloud.cloudstoragegateway.GatewayFileShareArgs;
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 defaultStocks = CloudstoragegatewayFunctions.getStocks(GetStocksArgs.builder()
            .gatewayClass("Standard")
            .build());

        var vpc = new Network("vpc", NetworkArgs.builder()        
            .vpcName("example_value")
            .cidrBlock("172.16.0.0/12")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()        
            .vpcId(vpc.id())
            .cidrBlock("172.16.0.0/21")
            .zoneId(defaultStocks.applyValue(getStocksResult -> getStocksResult.stocks()[0].zoneId()))
            .vswitchName("example_value")
            .build());

        var defaultStorageBundle = new StorageBundle("defaultStorageBundle", StorageBundleArgs.builder()        
            .storageBundleName("example_value")
            .build());

        var defaultGateway = new Gateway("defaultGateway", GatewayArgs.builder()        
            .description("tf-acctestDesalone")
            .gatewayClass("Standard")
            .type("File")
            .paymentType("PayAsYouGo")
            .vswitchId(defaultSwitch.id())
            .releaseAfterExpiration(true)
            .publicNetworkBandwidth(10)
            .storageBundleId(defaultStorageBundle.id())
            .location("Cloud")
            .gatewayName("example_value")
            .build());

        var defaultGatewayCacheDisk = new GatewayCacheDisk("defaultGatewayCacheDisk", GatewayCacheDiskArgs.builder()        
            .cacheDiskCategory("cloud_efficiency")
            .gatewayId(defaultGateway.id())
            .cacheDiskSizeInGb(50)
            .build());

        var defaultBucket = new Bucket("defaultBucket", BucketArgs.builder()        
            .bucket("example_value")
            .build());

        var defaultGatewayFileShare = new GatewayFileShare("defaultGatewayFileShare", GatewayFileShareArgs.builder()        
            .gatewayFileShareName("example_value")
            .gatewayId(defaultGateway.id())
            .localPath(defaultGatewayCacheDisk.localFilePath())
            .ossBucketName(defaultBucket.bucket())
            .ossEndpoint(defaultBucket.extranetEndpoint())
            .protocol("NFS")
            .remoteSync(true)
            .pollingInterval(4500)
            .feLimit(0)
            .backendLimit(0)
            .cacheMode("Cache")
            .squash("none")
            .lagPeriod(5)
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

default_stocks = alicloud.cloudstoragegateway.get_stocks(gateway_class="Standard")
vpc = alicloud.vpc.Network("vpc",
    vpc_name="example_value",
    cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    vpc_id=vpc.id,
    cidr_block="172.16.0.0/21",
    zone_id=default_stocks.stocks[0].zone_id,
    vswitch_name="example_value")
default_storage_bundle = alicloud.cloudstoragegateway.StorageBundle("defaultStorageBundle", storage_bundle_name="example_value")
default_gateway = alicloud.cloudstoragegateway.Gateway("defaultGateway",
    description="tf-acctestDesalone",
    gateway_class="Standard",
    type="File",
    payment_type="PayAsYouGo",
    vswitch_id=default_switch.id,
    release_after_expiration=True,
    public_network_bandwidth=10,
    storage_bundle_id=default_storage_bundle.id,
    location="Cloud",
    gateway_name="example_value")
default_gateway_cache_disk = alicloud.cloudstoragegateway.GatewayCacheDisk("defaultGatewayCacheDisk",
    cache_disk_category="cloud_efficiency",
    gateway_id=default_gateway.id,
    cache_disk_size_in_gb=50)
default_bucket = alicloud.oss.Bucket("defaultBucket", bucket="example_value")
default_gateway_file_share = alicloud.cloudstoragegateway.GatewayFileShare("defaultGatewayFileShare",
    gateway_file_share_name="example_value",
    gateway_id=default_gateway.id,
    local_path=default_gateway_cache_disk.local_file_path,
    oss_bucket_name=default_bucket.bucket,
    oss_endpoint=default_bucket.extranet_endpoint,
    protocol="NFS",
    remote_sync=True,
    polling_interval=4500,
    fe_limit=0,
    backend_limit=0,
    cache_mode="Cache",
    squash="none",
    lag_period=5)

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

const defaultStocks = alicloud.cloudstoragegateway.getStocks({
    gatewayClass: "Standard",
});
const vpc = new alicloud.vpc.Network("vpc", {
    vpcName: "example_value",
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vpcId: vpc.id,
    cidrBlock: "172.16.0.0/21",
    zoneId: defaultStocks.then(defaultStocks => defaultStocks.stocks?.[0]?.zoneId),
    vswitchName: "example_value",
});
const defaultStorageBundle = new alicloud.cloudstoragegateway.StorageBundle("defaultStorageBundle", {storageBundleName: "example_value"});
const defaultGateway = new alicloud.cloudstoragegateway.Gateway("defaultGateway", {
    description: "tf-acctestDesalone",
    gatewayClass: "Standard",
    type: "File",
    paymentType: "PayAsYouGo",
    vswitchId: defaultSwitch.id,
    releaseAfterExpiration: true,
    publicNetworkBandwidth: 10,
    storageBundleId: defaultStorageBundle.id,
    location: "Cloud",
    gatewayName: "example_value",
});
const defaultGatewayCacheDisk = new alicloud.cloudstoragegateway.GatewayCacheDisk("defaultGatewayCacheDisk", {
    cacheDiskCategory: "cloud_efficiency",
    gatewayId: defaultGateway.id,
    cacheDiskSizeInGb: 50,
});
const defaultBucket = new alicloud.oss.Bucket("defaultBucket", {bucket: "example_value"});
const defaultGatewayFileShare = new alicloud.cloudstoragegateway.GatewayFileShare("defaultGatewayFileShare", {
    gatewayFileShareName: "example_value",
    gatewayId: defaultGateway.id,
    localPath: defaultGatewayCacheDisk.localFilePath,
    ossBucketName: defaultBucket.bucket,
    ossEndpoint: defaultBucket.extranetEndpoint,
    protocol: "NFS",
    remoteSync: true,
    pollingInterval: 4500,
    feLimit: 0,
    backendLimit: 0,
    cacheMode: "Cache",
    squash: "none",
    lagPeriod: 5,
});

resources:
  vpc:
    type: alicloud:vpc:Network
    properties:
      vpcName: example_value
      cidrBlock: 172.16.0.0/12
  defaultSwitch:
    type: alicloud:vpc:Switch
    properties:
      vpcId: ${vpc.id}
      cidrBlock: 172.16.0.0/21
      zoneId: ${defaultStocks.stocks[0].zoneId}
      vswitchName: example_value
  defaultStorageBundle:
    type: alicloud:cloudstoragegateway:StorageBundle
    properties:
      storageBundleName: example_value
  defaultGateway:
    type: alicloud:cloudstoragegateway:Gateway
    properties:
      description: tf-acctestDesalone
      gatewayClass: Standard
      type: File
      paymentType: PayAsYouGo
      vswitchId: ${defaultSwitch.id}
      releaseAfterExpiration: true
      publicNetworkBandwidth: 10
      storageBundleId: ${defaultStorageBundle.id}
      location: Cloud
      gatewayName: example_value
  defaultGatewayCacheDisk:
    type: alicloud:cloudstoragegateway:GatewayCacheDisk
    properties:
      cacheDiskCategory: cloud_efficiency
      gatewayId: ${defaultGateway.id}
      cacheDiskSizeInGb: 50
  defaultBucket:
    type: alicloud:oss:Bucket
    properties:
      bucket: example_value
  defaultGatewayFileShare:
    type: alicloud:cloudstoragegateway:GatewayFileShare
    properties:
      gatewayFileShareName: example_value
      gatewayId: ${defaultGateway.id}
      localPath: ${defaultGatewayCacheDisk.localFilePath}
      ossBucketName: ${defaultBucket.bucket}
      ossEndpoint: ${defaultBucket.extranetEndpoint}
      protocol: NFS
      remoteSync: true
      pollingInterval: 4500
      feLimit: 0
      backendLimit: 0
      cacheMode: Cache
      squash: none
      lagPeriod: 5
variables:
  defaultStocks:
    fn::invoke:
      Function: alicloud:cloudstoragegateway:getStocks
      Arguments:
        gatewayClass: Standard

Create GatewayFileShare Resource

new GatewayFileShare(name: string, args: GatewayFileShareArgs, opts?: CustomResourceOptions);
@overload
def GatewayFileShare(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     access_based_enumeration: Optional[bool] = None,
                     backend_limit: Optional[int] = None,
                     browsable: Optional[bool] = None,
                     bypass_cache_read: Optional[bool] = None,
                     cache_mode: Optional[str] = None,
                     direct_io: Optional[bool] = None,
                     download_limit: Optional[int] = None,
                     fast_reclaim: Optional[bool] = None,
                     fe_limit: Optional[int] = None,
                     gateway_file_share_name: Optional[str] = None,
                     gateway_id: Optional[str] = None,
                     ignore_delete: Optional[bool] = None,
                     in_place: Optional[bool] = None,
                     lag_period: Optional[int] = None,
                     local_path: Optional[str] = None,
                     nfs_v4_optimization: Optional[bool] = None,
                     oss_bucket_name: Optional[str] = None,
                     oss_bucket_ssl: Optional[bool] = None,
                     oss_endpoint: Optional[str] = None,
                     partial_sync_paths: Optional[str] = None,
                     path_prefix: Optional[str] = None,
                     polling_interval: Optional[int] = None,
                     protocol: Optional[str] = None,
                     remote_sync: Optional[bool] = None,
                     remote_sync_download: Optional[bool] = None,
                     ro_client_list: Optional[str] = None,
                     ro_user_list: Optional[str] = None,
                     rw_client_list: Optional[str] = None,
                     rw_user_list: Optional[str] = None,
                     squash: Optional[str] = None,
                     support_archive: Optional[bool] = None,
                     transfer_acceleration: Optional[bool] = None,
                     windows_acl: Optional[bool] = None)
@overload
def GatewayFileShare(resource_name: str,
                     args: GatewayFileShareArgs,
                     opts: Optional[ResourceOptions] = None)
func NewGatewayFileShare(ctx *Context, name string, args GatewayFileShareArgs, opts ...ResourceOption) (*GatewayFileShare, error)
public GatewayFileShare(string name, GatewayFileShareArgs args, CustomResourceOptions? opts = null)
public GatewayFileShare(String name, GatewayFileShareArgs args)
public GatewayFileShare(String name, GatewayFileShareArgs args, CustomResourceOptions options)

type: alicloud:cloudstoragegateway:GatewayFileShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayFileShareArgs
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 GatewayFileShareArgs
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 GatewayFileShareArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayFileShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GatewayFileShareArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

GatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

GatewayId string

The ID of the gateway.

LocalPath string

The cache disk inside the device name.

OssBucketName string

The name of the OSS Bucket.

OssEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

Protocol string

Share types. Valid values: SMB, NFS.

AccessBasedEnumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

BackendLimit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

Browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

BypassCacheRead bool

Direct reading OSS of the gateway file share.

CacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

DirectIo bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

DownloadLimit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

FastReclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

FeLimit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

IgnoreDelete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

InPlace bool

The whether debris optimization of the gateway file share. Default value: false.

LagPeriod int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

NfsV4Optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

OssBucketSsl bool

Whether they are using SSL connect to OSS Bucket.

PartialSyncPaths string

In part mode, the directory path group JSON format.

PathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

PollingInterval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

RemoteSync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

RemoteSyncDownload bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

RoClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

RoUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

RwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

RwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

Squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

SupportArchive bool

Whether to support the archive transparent read.

TransferAcceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

WindowsAcl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

GatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

GatewayId string

The ID of the gateway.

LocalPath string

The cache disk inside the device name.

OssBucketName string

The name of the OSS Bucket.

OssEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

Protocol string

Share types. Valid values: SMB, NFS.

AccessBasedEnumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

BackendLimit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

Browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

BypassCacheRead bool

Direct reading OSS of the gateway file share.

CacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

DirectIo bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

DownloadLimit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

FastReclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

FeLimit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

IgnoreDelete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

InPlace bool

The whether debris optimization of the gateway file share. Default value: false.

LagPeriod int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

NfsV4Optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

OssBucketSsl bool

Whether they are using SSL connect to OSS Bucket.

PartialSyncPaths string

In part mode, the directory path group JSON format.

PathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

PollingInterval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

RemoteSync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

RemoteSyncDownload bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

RoClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

RoUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

RwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

RwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

Squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

SupportArchive bool

Whether to support the archive transparent read.

TransferAcceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

WindowsAcl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

gatewayFileShareName String

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId String

The ID of the gateway.

localPath String

The cache disk inside the device name.

ossBucketName String

The name of the OSS Bucket.

ossEndpoint String

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

protocol String

Share types. Valid values: SMB, NFS.

accessBasedEnumeration Boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit Integer

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable Boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead Boolean

Direct reading OSS of the gateway file share.

cacheMode String

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo Boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit Integer

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim Boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit Integer

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

ignoreDelete Boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace Boolean

The whether debris optimization of the gateway file share. Default value: false.

lagPeriod Integer

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

nfsV4Optimization Boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketSsl Boolean

Whether they are using SSL connect to OSS Bucket.

partialSyncPaths String

In part mode, the directory path group JSON format.

pathPrefix String

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval Integer

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

remoteSync Boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload Boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList String

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList String

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList String

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList String

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash String

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive Boolean

Whether to support the archive transparent read.

transferAcceleration Boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl Boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

gatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId string

The ID of the gateway.

localPath string

The cache disk inside the device name.

ossBucketName string

The name of the OSS Bucket.

ossEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

protocol string

Share types. Valid values: SMB, NFS.

accessBasedEnumeration boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit number

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead boolean

Direct reading OSS of the gateway file share.

cacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit number

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit number

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

ignoreDelete boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace boolean

The whether debris optimization of the gateway file share. Default value: false.

lagPeriod number

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

nfsV4Optimization boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketSsl boolean

Whether they are using SSL connect to OSS Bucket.

partialSyncPaths string

In part mode, the directory path group JSON format.

pathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval number

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

remoteSync boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive boolean

Whether to support the archive transparent read.

transferAcceleration boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

gateway_file_share_name str

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gateway_id str

The ID of the gateway.

local_path str

The cache disk inside the device name.

oss_bucket_name str

The name of the OSS Bucket.

oss_endpoint str

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

protocol str

Share types. Valid values: SMB, NFS.

access_based_enumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backend_limit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypass_cache_read bool

Direct reading OSS of the gateway file share.

cache_mode str

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

direct_io bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

download_limit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fast_reclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

fe_limit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

ignore_delete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

in_place bool

The whether debris optimization of the gateway file share. Default value: false.

lag_period int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

nfs_v4_optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

oss_bucket_ssl bool

Whether they are using SSL connect to OSS Bucket.

partial_sync_paths str

In part mode, the directory path group JSON format.

path_prefix str

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

polling_interval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

remote_sync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remote_sync_download bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

ro_client_list str

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

ro_user_list str

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rw_client_list str

Read and write the client list. When Protocol NFS is returned when the status is.

rw_user_list str

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash str

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

support_archive bool

Whether to support the archive transparent read.

transfer_acceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windows_acl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

gatewayFileShareName String

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId String

The ID of the gateway.

localPath String

The cache disk inside the device name.

ossBucketName String

The name of the OSS Bucket.

ossEndpoint String

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

protocol String

Share types. Valid values: SMB, NFS.

accessBasedEnumeration Boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit Number

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable Boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead Boolean

Direct reading OSS of the gateway file share.

cacheMode String

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo Boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit Number

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim Boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit Number

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

ignoreDelete Boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace Boolean

The whether debris optimization of the gateway file share. Default value: false.

lagPeriod Number

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

nfsV4Optimization Boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketSsl Boolean

Whether they are using SSL connect to OSS Bucket.

partialSyncPaths String

In part mode, the directory path group JSON format.

pathPrefix String

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval Number

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

remoteSync Boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload Boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList String

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList String

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList String

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList String

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash String

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive Boolean

Whether to support the archive transparent read.

transferAcceleration Boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl Boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

IndexId string

The ID of the file share.

Id string

The provider-assigned unique ID for this managed resource.

IndexId string

The ID of the file share.

id String

The provider-assigned unique ID for this managed resource.

indexId String

The ID of the file share.

id string

The provider-assigned unique ID for this managed resource.

indexId string

The ID of the file share.

id str

The provider-assigned unique ID for this managed resource.

index_id str

The ID of the file share.

id String

The provider-assigned unique ID for this managed resource.

indexId String

The ID of the file share.

Look up Existing GatewayFileShare Resource

Get an existing GatewayFileShare 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?: GatewayFileShareState, opts?: CustomResourceOptions): GatewayFileShare
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_based_enumeration: Optional[bool] = None,
        backend_limit: Optional[int] = None,
        browsable: Optional[bool] = None,
        bypass_cache_read: Optional[bool] = None,
        cache_mode: Optional[str] = None,
        direct_io: Optional[bool] = None,
        download_limit: Optional[int] = None,
        fast_reclaim: Optional[bool] = None,
        fe_limit: Optional[int] = None,
        gateway_file_share_name: Optional[str] = None,
        gateway_id: Optional[str] = None,
        ignore_delete: Optional[bool] = None,
        in_place: Optional[bool] = None,
        index_id: Optional[str] = None,
        lag_period: Optional[int] = None,
        local_path: Optional[str] = None,
        nfs_v4_optimization: Optional[bool] = None,
        oss_bucket_name: Optional[str] = None,
        oss_bucket_ssl: Optional[bool] = None,
        oss_endpoint: Optional[str] = None,
        partial_sync_paths: Optional[str] = None,
        path_prefix: Optional[str] = None,
        polling_interval: Optional[int] = None,
        protocol: Optional[str] = None,
        remote_sync: Optional[bool] = None,
        remote_sync_download: Optional[bool] = None,
        ro_client_list: Optional[str] = None,
        ro_user_list: Optional[str] = None,
        rw_client_list: Optional[str] = None,
        rw_user_list: Optional[str] = None,
        squash: Optional[str] = None,
        support_archive: Optional[bool] = None,
        transfer_acceleration: Optional[bool] = None,
        windows_acl: Optional[bool] = None) -> GatewayFileShare
func GetGatewayFileShare(ctx *Context, name string, id IDInput, state *GatewayFileShareState, opts ...ResourceOption) (*GatewayFileShare, error)
public static GatewayFileShare Get(string name, Input<string> id, GatewayFileShareState? state, CustomResourceOptions? opts = null)
public static GatewayFileShare get(String name, Output<String> id, GatewayFileShareState 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:
AccessBasedEnumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

BackendLimit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

Browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

BypassCacheRead bool

Direct reading OSS of the gateway file share.

CacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

DirectIo bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

DownloadLimit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

FastReclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

FeLimit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

GatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

GatewayId string

The ID of the gateway.

IgnoreDelete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

InPlace bool

The whether debris optimization of the gateway file share. Default value: false.

IndexId string

The ID of the file share.

LagPeriod int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

LocalPath string

The cache disk inside the device name.

NfsV4Optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

OssBucketName string

The name of the OSS Bucket.

OssBucketSsl bool

Whether they are using SSL connect to OSS Bucket.

OssEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

PartialSyncPaths string

In part mode, the directory path group JSON format.

PathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

PollingInterval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

Protocol string

Share types. Valid values: SMB, NFS.

RemoteSync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

RemoteSyncDownload bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

RoClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

RoUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

RwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

RwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

Squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

SupportArchive bool

Whether to support the archive transparent read.

TransferAcceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

WindowsAcl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

AccessBasedEnumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

BackendLimit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

Browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

BypassCacheRead bool

Direct reading OSS of the gateway file share.

CacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

DirectIo bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

DownloadLimit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

FastReclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

FeLimit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

GatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

GatewayId string

The ID of the gateway.

IgnoreDelete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

InPlace bool

The whether debris optimization of the gateway file share. Default value: false.

IndexId string

The ID of the file share.

LagPeriod int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

LocalPath string

The cache disk inside the device name.

NfsV4Optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

OssBucketName string

The name of the OSS Bucket.

OssBucketSsl bool

Whether they are using SSL connect to OSS Bucket.

OssEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

PartialSyncPaths string

In part mode, the directory path group JSON format.

PathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

PollingInterval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

Protocol string

Share types. Valid values: SMB, NFS.

RemoteSync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

RemoteSyncDownload bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

RoClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

RoUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

RwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

RwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

Squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

SupportArchive bool

Whether to support the archive transparent read.

TransferAcceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

WindowsAcl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

accessBasedEnumeration Boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit Integer

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable Boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead Boolean

Direct reading OSS of the gateway file share.

cacheMode String

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo Boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit Integer

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim Boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit Integer

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

gatewayFileShareName String

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId String

The ID of the gateway.

ignoreDelete Boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace Boolean

The whether debris optimization of the gateway file share. Default value: false.

indexId String

The ID of the file share.

lagPeriod Integer

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

localPath String

The cache disk inside the device name.

nfsV4Optimization Boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketName String

The name of the OSS Bucket.

ossBucketSsl Boolean

Whether they are using SSL connect to OSS Bucket.

ossEndpoint String

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

partialSyncPaths String

In part mode, the directory path group JSON format.

pathPrefix String

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval Integer

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

protocol String

Share types. Valid values: SMB, NFS.

remoteSync Boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload Boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList String

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList String

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList String

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList String

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash String

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive Boolean

Whether to support the archive transparent read.

transferAcceleration Boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl Boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

accessBasedEnumeration boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit number

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead boolean

Direct reading OSS of the gateway file share.

cacheMode string

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit number

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit number

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

gatewayFileShareName string

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId string

The ID of the gateway.

ignoreDelete boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace boolean

The whether debris optimization of the gateway file share. Default value: false.

indexId string

The ID of the file share.

lagPeriod number

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

localPath string

The cache disk inside the device name.

nfsV4Optimization boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketName string

The name of the OSS Bucket.

ossBucketSsl boolean

Whether they are using SSL connect to OSS Bucket.

ossEndpoint string

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

partialSyncPaths string

In part mode, the directory path group JSON format.

pathPrefix string

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval number

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

protocol string

Share types. Valid values: SMB, NFS.

remoteSync boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList string

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList string

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList string

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList string

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash string

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive boolean

Whether to support the archive transparent read.

transferAcceleration boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

access_based_enumeration bool

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backend_limit int

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable bool

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypass_cache_read bool

Direct reading OSS of the gateway file share.

cache_mode str

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

direct_io bool

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

download_limit int

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fast_reclaim bool

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

fe_limit int

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

gateway_file_share_name str

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gateway_id str

The ID of the gateway.

ignore_delete bool

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

in_place bool

The whether debris optimization of the gateway file share. Default value: false.

index_id str

The ID of the file share.

lag_period int

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

local_path str

The cache disk inside the device name.

nfs_v4_optimization bool

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

oss_bucket_name str

The name of the OSS Bucket.

oss_bucket_ssl bool

Whether they are using SSL connect to OSS Bucket.

oss_endpoint str

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

partial_sync_paths str

In part mode, the directory path group JSON format.

path_prefix str

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

polling_interval int

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

protocol str

Share types. Valid values: SMB, NFS.

remote_sync bool

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remote_sync_download bool

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

ro_client_list str

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

ro_user_list str

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rw_client_list str

Read and write the client list. When Protocol NFS is returned when the status is.

rw_user_list str

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash str

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

support_archive bool

Whether to support the archive transparent read.

transfer_acceleration bool

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windows_acl bool

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

accessBasedEnumeration Boolean

Whether to enable Windows ABE, the prime minister, need windowsAcl parameter is set to true in the entry into force of. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

backendLimit Number

The Max upload speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0. NOTE: at the same time if you have to limit the maximum write speed, maximum upload speed is no less than the maximum write speed.

browsable Boolean

The whether browsable of the gateway file share (that is, in the network neighborhood of whether you can find). The attribute is valid when the attribute protocol is SMB. Default value: true.

bypassCacheRead Boolean

Direct reading OSS of the gateway file share.

cacheMode String

The set up gateway file share cache mode. Valid values: Cache or Sync. Cache: cached mode. Sync: replication mode are available. Default value: Cache.

directIo Boolean

File sharing Whether to enable DirectIO (direct I/O mode for data transmission). Default value: false.

downloadLimit Number

The maximum download speed of the gateway file share. Unit: MB/s. 0 means unlimited. Value range: 0 ~ 1280. NOTE: only in copy mode and enable download file data can be set. only when the shared opens the reverse synchronization or acceded to by the speed synchronization Group when, this parameter will not take effect. Gateway version >= 1.3.0 above support.

fastReclaim Boolean

The whether to enable Upload optimization of the gateway file share, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.

feLimit Number

The maximum write speed of the gateway file share. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.

gatewayFileShareName String

The name of the file share. Length from 1 to 255 characters can contain lowercase letters, digits, (.), (_) Or (-), at the same time, must start with a lowercase letter.

gatewayId String

The ID of the gateway.

ignoreDelete Boolean

The whether to ignore deleted of the gateway file share. After the opening of the Gateway side delete file or delete cloud (OSS) corresponding to the file. Default value: false. NOTE: ignore_delete and remote_sync cannot be enabled simultaneously. Gateway version >= 1.0.40 above support.

inPlace Boolean

The whether debris optimization of the gateway file share. Default value: false.

indexId String

The ID of the file share.

lagPeriod Number

The synchronization delay, I.e. gateway local cache sync to Alibaba Cloud Object Storage Service (oss) of the delay time. Unit: Seconds. Value range: 5 ~ 120. Default value: 5. NOTE: Gateway version >= 1.0.40 above support.

localPath String

The cache disk inside the device name.

nfsV4Optimization Boolean

The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: If it is enabled, NFS V3 cannot be mounted. The attribute is valid when the attribute protocol is NFS. Gateway version >= 1.2.0 above support.

ossBucketName String

The name of the OSS Bucket.

ossBucketSsl Boolean

Whether they are using SSL connect to OSS Bucket.

ossEndpoint String

The gateway file share corresponds to the Object Storage SERVICE (OSS), Bucket Endpoint. NOTE: distinguish between intranet and internet Endpoint. We recommend that if the OSS Bucket and the gateway is in the same Region is use the RDS intranet IP Endpoint: oss-cn-hangzhou-internal.aliyuncs.com.

partialSyncPaths String

In part mode, the directory path group JSON format.

pathPrefix String

The subdirectory path under the object storage (OSS) bucket corresponding to the file share. If it is blank, it means the root directory of the bucket.

pollingInterval Number

The reverse synchronization time intervals of the gateway file share. Value range: 15 ~ 36000. NOTE: in copy mode + reverse synchronization is enabled Download file data, value range: 3600 ~ 36000.

protocol String

Share types. Valid values: SMB, NFS.

remoteSync Boolean

Whether to enable reverse synchronization of the gateway file share. Default value: false.

remoteSyncDownload Boolean

Copy mode, whether to download the file data. Default value: false. NOTE: only when the attribute remote_sync is true or acceded to by the speed synchronization group, this parameter will not take effect.

roClientList String

File sharing NFS read-only client list (IP address or IP address range). Use commas (,) to separate multiple clients.

roUserList String

The read-only client list. When Protocol for Server Message Block (SMB) to go back to.

rwClientList String

Read and write the client list. When Protocol NFS is returned when the status is.

rwUserList String

Read-write user list. When Protocol for Server Message Block (SMB) to go back to.

squash String

The NFS protocol user mapping of the gateway file share. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none. NOTE: The attribute is valid when the attribute protocol is NFS.

supportArchive Boolean

Whether to support the archive transparent read.

transferAcceleration Boolean

The set up gateway file share whether to enable transmission acceleration needs corresponding OSS Bucket enabled transport acceleration. NOTE: Gateway version >= 1.3.0 above support.

windowsAcl Boolean

Whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: The attribute is valid when the attribute protocol is SMB. Gateway version >= 1.0.45 above support.

Import

Cloud Storage Gateway Gateway File Share can be imported using the id, e.g.

 $ pulumi import alicloud:cloudstoragegateway/gatewayFileShare:GatewayFileShare example <gateway_id>:<index_id>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.