Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cloudstoragegateway
  5. GatewayFileShare
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.cloudstoragegateway.GatewayFileShare

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

    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 since v1.144.0.

    Create GatewayFileShare Resource

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

    Constructor syntax

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

@overload
def GatewayFileShare(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     gateway_file_share_name: Optional[str] = None,
                     protocol: Optional[str] = None,
                     oss_endpoint: Optional[str] = None,
                     oss_bucket_name: Optional[str] = None,
                     local_path: Optional[str] = None,
                     gateway_id: Optional[str] = None,
                     fe_limit: Optional[int] = None,
                     partial_sync_paths: Optional[str] = None,
                     access_based_enumeration: Optional[bool] = None,
                     download_limit: Optional[int] = None,
                     direct_io: Optional[bool] = None,
                     ignore_delete: Optional[bool] = None,
                     in_place: Optional[bool] = None,
                     lag_period: Optional[int] = None,
                     cache_mode: Optional[str] = None,
                     nfs_v4_optimization: Optional[bool] = None,
                     bypass_cache_read: Optional[bool] = None,
                     oss_bucket_ssl: Optional[bool] = None,
                     browsable: Optional[bool] = None,
                     fast_reclaim: Optional[bool] = None,
                     path_prefix: Optional[str] = None,
                     polling_interval: Optional[int] = None,
                     backend_limit: Optional[int] = 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)
    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.

    Parameters

    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.

    Constructor example

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

    var gatewayFileShareResource = new AliCloud.CloudStorageGateway.GatewayFileShare("gatewayFileShareResource", new()
{
    GatewayFileShareName = "string",
    Protocol = "string",
    OssEndpoint = "string",
    OssBucketName = "string",
    LocalPath = "string",
    GatewayId = "string",
    FeLimit = 0,
    PartialSyncPaths = "string",
    AccessBasedEnumeration = false,
    DownloadLimit = 0,
    DirectIo = false,
    IgnoreDelete = false,
    InPlace = false,
    LagPeriod = 0,
    CacheMode = "string",
    NfsV4Optimization = false,
    BypassCacheRead = false,
    OssBucketSsl = false,
    Browsable = false,
    FastReclaim = false,
    PathPrefix = "string",
    PollingInterval = 0,
    BackendLimit = 0,
    RemoteSync = false,
    RemoteSyncDownload = false,
    RoClientList = "string",
    RoUserList = "string",
    RwClientList = "string",
    RwUserList = "string",
    Squash = "string",
    SupportArchive = false,
    TransferAcceleration = false,
    WindowsAcl = false,
});

    example, err := cloudstoragegateway.NewGatewayFileShare(ctx, "gatewayFileShareResource", &cloudstoragegateway.GatewayFileShareArgs{
	GatewayFileShareName:   pulumi.String("string"),
	Protocol:               pulumi.String("string"),
	OssEndpoint:            pulumi.String("string"),
	OssBucketName:          pulumi.String("string"),
	LocalPath:              pulumi.String("string"),
	GatewayId:              pulumi.String("string"),
	FeLimit:                pulumi.Int(0),
	PartialSyncPaths:       pulumi.String("string"),
	AccessBasedEnumeration: pulumi.Bool(false),
	DownloadLimit:          pulumi.Int(0),
	DirectIo:               pulumi.Bool(false),
	IgnoreDelete:           pulumi.Bool(false),
	InPlace:                pulumi.Bool(false),
	LagPeriod:              pulumi.Int(0),
	CacheMode:              pulumi.String("string"),
	NfsV4Optimization:      pulumi.Bool(false),
	BypassCacheRead:        pulumi.Bool(false),
	OssBucketSsl:           pulumi.Bool(false),
	Browsable:              pulumi.Bool(false),
	FastReclaim:            pulumi.Bool(false),
	PathPrefix:             pulumi.String("string"),
	PollingInterval:        pulumi.Int(0),
	BackendLimit:           pulumi.Int(0),
	RemoteSync:             pulumi.Bool(false),
	RemoteSyncDownload:     pulumi.Bool(false),
	RoClientList:           pulumi.String("string"),
	RoUserList:             pulumi.String("string"),
	RwClientList:           pulumi.String("string"),
	RwUserList:             pulumi.String("string"),
	Squash:                 pulumi.String("string"),
	SupportArchive:         pulumi.Bool(false),
	TransferAcceleration:   pulumi.Bool(false),
	WindowsAcl:             pulumi.Bool(false),
})

    var gatewayFileShareResource = new GatewayFileShare("gatewayFileShareResource", GatewayFileShareArgs.builder()
    .gatewayFileShareName("string")
    .protocol("string")
    .ossEndpoint("string")
    .ossBucketName("string")
    .localPath("string")
    .gatewayId("string")
    .feLimit(0)
    .partialSyncPaths("string")
    .accessBasedEnumeration(false)
    .downloadLimit(0)
    .directIo(false)
    .ignoreDelete(false)
    .inPlace(false)
    .lagPeriod(0)
    .cacheMode("string")
    .nfsV4Optimization(false)
    .bypassCacheRead(false)
    .ossBucketSsl(false)
    .browsable(false)
    .fastReclaim(false)
    .pathPrefix("string")
    .pollingInterval(0)
    .backendLimit(0)
    .remoteSync(false)
    .remoteSyncDownload(false)
    .roClientList("string")
    .roUserList("string")
    .rwClientList("string")
    .rwUserList("string")
    .squash("string")
    .supportArchive(false)
    .transferAcceleration(false)
    .windowsAcl(false)
    .build());

    gateway_file_share_resource = alicloud.cloudstoragegateway.GatewayFileShare("gatewayFileShareResource",
    gateway_file_share_name="string",
    protocol="string",
    oss_endpoint="string",
    oss_bucket_name="string",
    local_path="string",
    gateway_id="string",
    fe_limit=0,
    partial_sync_paths="string",
    access_based_enumeration=False,
    download_limit=0,
    direct_io=False,
    ignore_delete=False,
    in_place=False,
    lag_period=0,
    cache_mode="string",
    nfs_v4_optimization=False,
    bypass_cache_read=False,
    oss_bucket_ssl=False,
    browsable=False,
    fast_reclaim=False,
    path_prefix="string",
    polling_interval=0,
    backend_limit=0,
    remote_sync=False,
    remote_sync_download=False,
    ro_client_list="string",
    ro_user_list="string",
    rw_client_list="string",
    rw_user_list="string",
    squash="string",
    support_archive=False,
    transfer_acceleration=False,
    windows_acl=False)

    const gatewayFileShareResource = new alicloud.cloudstoragegateway.GatewayFileShare("gatewayFileShareResource", {
    gatewayFileShareName: "string",
    protocol: "string",
    ossEndpoint: "string",
    ossBucketName: "string",
    localPath: "string",
    gatewayId: "string",
    feLimit: 0,
    partialSyncPaths: "string",
    accessBasedEnumeration: false,
    downloadLimit: 0,
    directIo: false,
    ignoreDelete: false,
    inPlace: false,
    lagPeriod: 0,
    cacheMode: "string",
    nfsV4Optimization: false,
    bypassCacheRead: false,
    ossBucketSsl: false,
    browsable: false,
    fastReclaim: false,
    pathPrefix: "string",
    pollingInterval: 0,
    backendLimit: 0,
    remoteSync: false,
    remoteSyncDownload: false,
    roClientList: "string",
    roUserList: "string",
    rwClientList: "string",
    rwUserList: "string",
    squash: "string",
    supportArchive: false,
    transferAcceleration: false,
    windowsAcl: false,
});

    type: alicloud:cloudstoragegateway:GatewayFileShare
properties:
    accessBasedEnumeration: false
    backendLimit: 0
    browsable: false
    bypassCacheRead: false
    cacheMode: string
    directIo: false
    downloadLimit: 0
    fastReclaim: false
    feLimit: 0
    gatewayFileShareName: string
    gatewayId: string
    ignoreDelete: false
    inPlace: false
    lagPeriod: 0
    localPath: string
    nfsV4Optimization: false
    ossBucketName: string
    ossBucketSsl: false
    ossEndpoint: string
    partialSyncPaths: string
    pathPrefix: string
    pollingInterval: 0
    protocol: string
    remoteSync: false
    remoteSyncDownload: false
    roClientList: string
    roUserList: string
    rwClientList: string
    rwUserList: string
    squash: string
    supportArchive: false
    transferAcceleration: false
    windowsAcl: false

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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)
    resources:  _:    type: alicloud:cloudstoragegateway:GatewayFileShare    get:      id: ${id}
    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>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-alicloud