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

alicloud.cloudstoragegateway.getGatewayFileShares

Explore with Pulumi AI

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

    This data source provides the Cloud Storage Gateway Gateway File Shares of the current Alibaba Cloud user.

    NOTE: Available in v1.144.0+.

    Example Usage

    Basic Usage

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

const ids = alicloud.cloudstoragegateway.getGatewayFileShares({
    gatewayId: "example_value",
    ids: [
        "example_value-1",
        "example_value-2",
    ],
});
export const cloudStorageGatewayGatewayFileShareId1 = ids.then(ids => ids.shares?.[0]?.id);
const nameRegex = alicloud.cloudstoragegateway.getGatewayFileShares({
    gatewayId: "example_value",
    nameRegex: "^my-GatewayFileShare",
});
export const cloudStorageGatewayGatewayFileShareId2 = nameRegex.then(nameRegex => nameRegex.shares?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.cloudstoragegateway.get_gateway_file_shares(gateway_id="example_value",
    ids=[
        "example_value-1",
        "example_value-2",
    ])
pulumi.export("cloudStorageGatewayGatewayFileShareId1", ids.shares[0].id)
name_regex = alicloud.cloudstoragegateway.get_gateway_file_shares(gateway_id="example_value",
    name_regex="^my-GatewayFileShare")
pulumi.export("cloudStorageGatewayGatewayFileShareId2", name_regex.shares[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cloudstoragegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := cloudstoragegateway.GetGatewayFileShares(ctx, &cloudstoragegateway.GetGatewayFileSharesArgs{
			GatewayId: "example_value",
			Ids: []string{
				"example_value-1",
				"example_value-2",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("cloudStorageGatewayGatewayFileShareId1", ids.Shares[0].Id)
		nameRegex, err := cloudstoragegateway.GetGatewayFileShares(ctx, &cloudstoragegateway.GetGatewayFileSharesArgs{
			GatewayId: "example_value",
			NameRegex: pulumi.StringRef("^my-GatewayFileShare"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("cloudStorageGatewayGatewayFileShareId2", nameRegex.Shares[0].Id)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.CloudStorageGateway.GetGatewayFileShares.Invoke(new()
    {
        GatewayId = "example_value",
        Ids = new[]
        {
            "example_value-1",
            "example_value-2",
        },
    });

    var nameRegex = AliCloud.CloudStorageGateway.GetGatewayFileShares.Invoke(new()
    {
        GatewayId = "example_value",
        NameRegex = "^my-GatewayFileShare",
    });

    return new Dictionary<string, object?>
    {
        ["cloudStorageGatewayGatewayFileShareId1"] = ids.Apply(getGatewayFileSharesResult => getGatewayFileSharesResult.Shares[0]?.Id),
        ["cloudStorageGatewayGatewayFileShareId2"] = nameRegex.Apply(getGatewayFileSharesResult => getGatewayFileSharesResult.Shares[0]?.Id),
    };
});

    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.GetGatewayFileSharesArgs;
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 ids = CloudstoragegatewayFunctions.getGatewayFileShares(GetGatewayFileSharesArgs.builder()
            .gatewayId("example_value")
            .ids(            
                "example_value-1",
                "example_value-2")
            .build());

        ctx.export("cloudStorageGatewayGatewayFileShareId1", ids.applyValue(getGatewayFileSharesResult -> getGatewayFileSharesResult.shares()[0].id()));
        final var nameRegex = CloudstoragegatewayFunctions.getGatewayFileShares(GetGatewayFileSharesArgs.builder()
            .gatewayId("example_value")
            .nameRegex("^my-GatewayFileShare")
            .build());

        ctx.export("cloudStorageGatewayGatewayFileShareId2", nameRegex.applyValue(getGatewayFileSharesResult -> getGatewayFileSharesResult.shares()[0].id()));
    }
}

    variables:
  ids:
    fn::invoke:
      function: alicloud:cloudstoragegateway:getGatewayFileShares
      arguments:
        gatewayId: example_value
        ids:
          - example_value-1
          - example_value-2
  nameRegex:
    fn::invoke:
      function: alicloud:cloudstoragegateway:getGatewayFileShares
      arguments:
        gatewayId: example_value
        nameRegex: ^my-GatewayFileShare
outputs:
  cloudStorageGatewayGatewayFileShareId1: ${ids.shares[0].id}
  cloudStorageGatewayGatewayFileShareId2: ${nameRegex.shares[0].id}

    Using getGatewayFileShares

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayFileShares(args: GetGatewayFileSharesArgs, opts?: InvokeOptions): Promise<GetGatewayFileSharesResult>
function getGatewayFileSharesOutput(args: GetGatewayFileSharesOutputArgs, opts?: InvokeOptions): Output<GetGatewayFileSharesResult>
    def get_gateway_file_shares(gateway_id: Optional[str] = None,
                            ids: Optional[Sequence[str]] = None,
                            name_regex: Optional[str] = None,
                            output_file: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGatewayFileSharesResult
def get_gateway_file_shares_output(gateway_id: Optional[pulumi.Input[str]] = None,
                            ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            name_regex: Optional[pulumi.Input[str]] = None,
                            output_file: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayFileSharesResult]
    func GetGatewayFileShares(ctx *Context, args *GetGatewayFileSharesArgs, opts ...InvokeOption) (*GetGatewayFileSharesResult, error)
func GetGatewayFileSharesOutput(ctx *Context, args *GetGatewayFileSharesOutputArgs, opts ...InvokeOption) GetGatewayFileSharesResultOutput

    > Note: This function is named GetGatewayFileShares in the Go SDK.

    public static class GetGatewayFileShares 
{
    public static Task<GetGatewayFileSharesResult> InvokeAsync(GetGatewayFileSharesArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayFileSharesResult> Invoke(GetGatewayFileSharesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayFileSharesResult> getGatewayFileShares(GetGatewayFileSharesArgs args, InvokeOptions options)
public static Output<GetGatewayFileSharesResult> getGatewayFileShares(GetGatewayFileSharesArgs args, InvokeOptions options)

    fn::invoke:
  function: alicloud:cloudstoragegateway/getGatewayFileShares:getGatewayFileShares
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GatewayId string
    The ID of the gateway.
    Ids List<string>
    A list of Gateway File Share IDs.
    NameRegex string
    A regex string to filter results by Gateway File Share name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    GatewayId string
    The ID of the gateway.
    Ids []string
    A list of Gateway File Share IDs.
    NameRegex string
    A regex string to filter results by Gateway File Share name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    gatewayId String
    The ID of the gateway.
    ids List<String>
    A list of Gateway File Share IDs.
    nameRegex String
    A regex string to filter results by Gateway File Share name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    gatewayId string
    The ID of the gateway.
    ids string[]
    A list of Gateway File Share IDs.
    nameRegex string
    A regex string to filter results by Gateway File Share name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    gateway_id str
    The ID of the gateway.
    ids Sequence[str]
    A list of Gateway File Share IDs.
    name_regex str
    A regex string to filter results by Gateway File Share name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    gatewayId String
    The ID of the gateway.
    ids List<String>
    A list of Gateway File Share IDs.
    nameRegex String
    A regex string to filter results by Gateway File Share name.
    outputFile String
    File name where to save data source results (after running pulumi preview).

    getGatewayFileShares Result

    The following output properties are available:

    GatewayId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    Names List<string>
    Shares List<Pulumi.AliCloud.CloudStorageGateway.Outputs.GetGatewayFileSharesShare>
    NameRegex string
    OutputFile string
    GatewayId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Names []string
    Shares []GetGatewayFileSharesShare
    NameRegex string
    OutputFile string
    gatewayId String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    shares List<GetGatewayFileSharesShare>
    nameRegex String
    outputFile String
    gatewayId string
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    names string[]
    shares GetGatewayFileSharesShare[]
    nameRegex string
    outputFile string
    gateway_id str
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    names Sequence[str]
    shares Sequence[GetGatewayFileSharesShare]
    name_regex str
    output_file str
    gatewayId String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    shares List<Property Map>
    nameRegex String
    outputFile String

    Supporting Types

    GetGatewayFileSharesShare

    AccessBasedEnumeration bool
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    Address string
    Share the private IP address of the RDS instance.
    BackendLimit int
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    BucketInfos string
    Multi-Bucket information.
    BucketsStub bool
    Whether there are multiple buckets.
    BypassCacheRead bool
    Direct reading OSS of the gateway file share.
    CacheMode string
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    ClientSideCmk string
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    ClientSideEncryption bool
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    DirectIo bool
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    DiskId string
    The ID of the disk.
    DiskType string
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    DownloadLimit int
    The set up gateway file share maximum download speed. 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.
    Enabled bool
    Shared whether the changes take effect.
    ExpressSyncId string
    Speed synchronization group ID.
    FastReclaim bool
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    FeLimit int
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    FileNumLimit string
    Supported by the file system file number.
    FsSizeLimit string
    File system capacity. Unit: B.
    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.
    Id string
    The ID of the Gateway File Share.
    IgnoreDelete bool
    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: Gateway version >= 1.0.40 above support.
    InPlace bool
    Whether debris optimization of the gateway file share. Default value: false.
    InRate string
    Cache growth. Unit: B/s.
    IndexId string
    The ID of the file share.
    KmsRotatePeriod int
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    LagPeriod string
    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.
    MnsHealth string
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    NfsV4Optimization bool
    The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    ObsoleteBuckets string
    Multi-Bucket, removing the Bucket.
    OssBucketName string
    The name of the Bucket.
    OssBucketSsl bool
    Whether they are using SSL connect to OSS Bucket.
    OssEndpoint string
    The set up 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.
    OssHealth string
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    OssUsed string
    For a cloud-based data is. Unit: B.
    OutRate string
    Upload speed. Unit: B/s.
    PartialSyncPaths string
    In part mode, the directory path group JSON format.
    PathPrefix string
    The prefix of the OSS.
    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.
    RemainingMetaSpace string
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    RoClientList string
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    ServerSideCmk string
    File share is enabled server-side encryption, encryption used by the KMS key.
    ServerSideEncryption bool
    If the OSS Bucket side encryption.
    Size string
    The caching capacity. Unit: B.
    Squash string
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    State string
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    SupportArchive bool
    Whether to support the archive transparent read.
    SyncProgress int
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    TotalDownload string
    The OSS Bucket to the Gateway total downloads. Unit: B.
    TotalUpload string
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    Used string
    Used cache. Unit: B.
    WindowsAcl bool
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.
    AccessBasedEnumeration bool
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    Address string
    Share the private IP address of the RDS instance.
    BackendLimit int
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    BucketInfos string
    Multi-Bucket information.
    BucketsStub bool
    Whether there are multiple buckets.
    BypassCacheRead bool
    Direct reading OSS of the gateway file share.
    CacheMode string
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    ClientSideCmk string
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    ClientSideEncryption bool
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    DirectIo bool
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    DiskId string
    The ID of the disk.
    DiskType string
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    DownloadLimit int
    The set up gateway file share maximum download speed. 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.
    Enabled bool
    Shared whether the changes take effect.
    ExpressSyncId string
    Speed synchronization group ID.
    FastReclaim bool
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    FeLimit int
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    FileNumLimit string
    Supported by the file system file number.
    FsSizeLimit string
    File system capacity. Unit: B.
    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.
    Id string
    The ID of the Gateway File Share.
    IgnoreDelete bool
    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: Gateway version >= 1.0.40 above support.
    InPlace bool
    Whether debris optimization of the gateway file share. Default value: false.
    InRate string
    Cache growth. Unit: B/s.
    IndexId string
    The ID of the file share.
    KmsRotatePeriod int
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    LagPeriod string
    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.
    MnsHealth string
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    NfsV4Optimization bool
    The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    ObsoleteBuckets string
    Multi-Bucket, removing the Bucket.
    OssBucketName string
    The name of the Bucket.
    OssBucketSsl bool
    Whether they are using SSL connect to OSS Bucket.
    OssEndpoint string
    The set up 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.
    OssHealth string
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    OssUsed string
    For a cloud-based data is. Unit: B.
    OutRate string
    Upload speed. Unit: B/s.
    PartialSyncPaths string
    In part mode, the directory path group JSON format.
    PathPrefix string
    The prefix of the OSS.
    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.
    RemainingMetaSpace string
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    RoClientList string
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    ServerSideCmk string
    File share is enabled server-side encryption, encryption used by the KMS key.
    ServerSideEncryption bool
    If the OSS Bucket side encryption.
    Size string
    The caching capacity. Unit: B.
    Squash string
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    State string
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    SupportArchive bool
    Whether to support the archive transparent read.
    SyncProgress int
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    TotalDownload string
    The OSS Bucket to the Gateway total downloads. Unit: B.
    TotalUpload string
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    Used string
    Used cache. Unit: B.
    WindowsAcl bool
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.
    accessBasedEnumeration Boolean
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    address String
    Share the private IP address of the RDS instance.
    backendLimit Integer
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    bucketInfos String
    Multi-Bucket information.
    bucketsStub Boolean
    Whether there are multiple buckets.
    bypassCacheRead Boolean
    Direct reading OSS of the gateway file share.
    cacheMode String
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    clientSideCmk String
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    clientSideEncryption Boolean
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    directIo Boolean
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    diskId String
    The ID of the disk.
    diskType String
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    downloadLimit Integer
    The set up gateway file share maximum download speed. 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.
    enabled Boolean
    Shared whether the changes take effect.
    expressSyncId String
    Speed synchronization group ID.
    fastReclaim Boolean
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    feLimit Integer
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    fileNumLimit String
    Supported by the file system file number.
    fsSizeLimit String
    File system capacity. Unit: B.
    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.
    id String
    The ID of the Gateway File Share.
    ignoreDelete Boolean
    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: Gateway version >= 1.0.40 above support.
    inPlace Boolean
    Whether debris optimization of the gateway file share. Default value: false.
    inRate String
    Cache growth. Unit: B/s.
    indexId String
    The ID of the file share.
    kmsRotatePeriod Integer
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    lagPeriod String
    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.
    mnsHealth String
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    nfsV4Optimization Boolean
    The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    obsoleteBuckets String
    Multi-Bucket, removing the Bucket.
    ossBucketName String
    The name of the Bucket.
    ossBucketSsl Boolean
    Whether they are using SSL connect to OSS Bucket.
    ossEndpoint String
    The set up 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.
    ossHealth String
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    ossUsed String
    For a cloud-based data is. Unit: B.
    outRate String
    Upload speed. Unit: B/s.
    partialSyncPaths String
    In part mode, the directory path group JSON format.
    pathPrefix String
    The prefix of the OSS.
    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.
    remainingMetaSpace String
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    roClientList String
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    serverSideCmk String
    File share is enabled server-side encryption, encryption used by the KMS key.
    serverSideEncryption Boolean
    If the OSS Bucket side encryption.
    size String
    The caching capacity. Unit: B.
    squash String
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    state String
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    supportArchive Boolean
    Whether to support the archive transparent read.
    syncProgress Integer
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    totalDownload String
    The OSS Bucket to the Gateway total downloads. Unit: B.
    totalUpload String
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    used String
    Used cache. Unit: B.
    windowsAcl Boolean
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.
    accessBasedEnumeration boolean
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    address string
    Share the private IP address of the RDS instance.
    backendLimit number
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    bucketInfos string
    Multi-Bucket information.
    bucketsStub boolean
    Whether there are multiple buckets.
    bypassCacheRead boolean
    Direct reading OSS of the gateway file share.
    cacheMode string
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    clientSideCmk string
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    clientSideEncryption boolean
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    directIo boolean
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    diskId string
    The ID of the disk.
    diskType string
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    downloadLimit number
    The set up gateway file share maximum download speed. 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.
    enabled boolean
    Shared whether the changes take effect.
    expressSyncId string
    Speed synchronization group ID.
    fastReclaim boolean
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    feLimit number
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    fileNumLimit string
    Supported by the file system file number.
    fsSizeLimit string
    File system capacity. Unit: B.
    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.
    id string
    The ID of the Gateway File Share.
    ignoreDelete boolean
    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: Gateway version >= 1.0.40 above support.
    inPlace boolean
    Whether debris optimization of the gateway file share. Default value: false.
    inRate string
    Cache growth. Unit: B/s.
    indexId string
    The ID of the file share.
    kmsRotatePeriod number
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    lagPeriod string
    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.
    mnsHealth string
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    nfsV4Optimization boolean
    The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    obsoleteBuckets string
    Multi-Bucket, removing the Bucket.
    ossBucketName string
    The name of the Bucket.
    ossBucketSsl boolean
    Whether they are using SSL connect to OSS Bucket.
    ossEndpoint string
    The set up 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.
    ossHealth string
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    ossUsed string
    For a cloud-based data is. Unit: B.
    outRate string
    Upload speed. Unit: B/s.
    partialSyncPaths string
    In part mode, the directory path group JSON format.
    pathPrefix string
    The prefix of the OSS.
    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.
    remainingMetaSpace string
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    roClientList string
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    serverSideCmk string
    File share is enabled server-side encryption, encryption used by the KMS key.
    serverSideEncryption boolean
    If the OSS Bucket side encryption.
    size string
    The caching capacity. Unit: B.
    squash string
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    state string
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    supportArchive boolean
    Whether to support the archive transparent read.
    syncProgress number
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    totalDownload string
    The OSS Bucket to the Gateway total downloads. Unit: B.
    totalUpload string
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    used string
    Used cache. Unit: B.
    windowsAcl boolean
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.
    access_based_enumeration bool
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    address str
    Share the private IP address of the RDS instance.
    backend_limit int
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    bucket_infos str
    Multi-Bucket information.
    buckets_stub bool
    Whether there are multiple buckets.
    bypass_cache_read bool
    Direct reading OSS of the gateway file share.
    cache_mode str
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    client_side_cmk str
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    client_side_encryption bool
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    direct_io bool
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    disk_id str
    The ID of the disk.
    disk_type str
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    download_limit int
    The set up gateway file share maximum download speed. 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.
    enabled bool
    Shared whether the changes take effect.
    express_sync_id str
    Speed synchronization group ID.
    fast_reclaim bool
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    fe_limit int
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    file_num_limit str
    Supported by the file system file number.
    fs_size_limit str
    File system capacity. Unit: B.
    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.
    id str
    The ID of the Gateway File Share.
    ignore_delete bool
    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: Gateway version >= 1.0.40 above support.
    in_place bool
    Whether debris optimization of the gateway file share. Default value: false.
    in_rate str
    Cache growth. Unit: B/s.
    index_id str
    The ID of the file share.
    kms_rotate_period int
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    lag_period str
    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.
    mns_health str
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    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: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    obsolete_buckets str
    Multi-Bucket, removing the Bucket.
    oss_bucket_name str
    The name of the Bucket.
    oss_bucket_ssl bool
    Whether they are using SSL connect to OSS Bucket.
    oss_endpoint str
    The set up 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.
    oss_health str
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    oss_used str
    For a cloud-based data is. Unit: B.
    out_rate str
    Upload speed. Unit: B/s.
    partial_sync_paths str
    In part mode, the directory path group JSON format.
    path_prefix str
    The prefix of the OSS.
    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.
    remaining_meta_space str
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    ro_client_list str
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    server_side_cmk str
    File share is enabled server-side encryption, encryption used by the KMS key.
    server_side_encryption bool
    If the OSS Bucket side encryption.
    size str
    The caching capacity. Unit: B.
    squash str
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    state str
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    support_archive bool
    Whether to support the archive transparent read.
    sync_progress int
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    total_download str
    The OSS Bucket to the Gateway total downloads. Unit: B.
    total_upload str
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    used str
    Used cache. Unit: B.
    windows_acl bool
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.
    accessBasedEnumeration Boolean
    The set up gateway file share Server Message Block (SMB) protocol, 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: Gateway version >= 1.0.45 above support.
    address String
    Share the private IP address of the RDS instance.
    backendLimit Number
    The set up gateway file share Max upload speed. 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 set up gateway file share Server Message Block (SMB) protocol whether browsable (that is, in the network neighborhood of whether you can find). The parameters in the NFS protocol not valid under. Default value: true.
    bucketInfos String
    Multi-Bucket information.
    bucketsStub Boolean
    Whether there are multiple buckets.
    bypassCacheRead Boolean
    Direct reading OSS of the gateway file share.
    cacheMode String
    The cache mode of the gateway file share. Value range: Cache: cached mode. Sync: replication mode are available.
    clientSideCmk String
    File share is enabled to client-side encryption, the encryption by the use of the KMS key. NOTE: note: This KMS key must be the gateway and is in the same Region.
    clientSideEncryption Boolean
    Whether to enabled to client-side encryption of the gateway file share. Default value: false. NOTE: need to contact us open whitelist before you can the settings, and only supports enhanced more than online gateway, at the same time, server-side encryption and to client-side encryption can not simultaneously configuration.
    directIo Boolean
    Whether directio (direct I/O data transfer) is enabled for file share. Default: false.
    diskId String
    The ID of the disk.
    diskType String
    The cache disk type. Valid values: cloud_efficiency: Ultra cloud disk. cloud_ssd:SSD cloud disk.
    downloadLimit Number
    The set up gateway file share maximum download speed. 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.
    enabled Boolean
    Shared whether the changes take effect.
    expressSyncId String
    Speed synchronization group ID.
    fastReclaim Boolean
    The set up gateway file share whether to enable Upload optimization, which is suitable for data pure backup migration scenarios. Default value: false. NOTE: Gateway version >= 1.0.39 above support.
    feLimit Number
    The set up gateway file share and the maximum write speed. Unit: MB/s, 0 means unlimited. Value range: 0 ~ 1280. Default value: 0.
    fileNumLimit String
    Supported by the file system file number.
    fsSizeLimit String
    File system capacity. Unit: B.
    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.
    id String
    The ID of the Gateway File Share.
    ignoreDelete Boolean
    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: Gateway version >= 1.0.40 above support.
    inPlace Boolean
    Whether debris optimization of the gateway file share. Default value: false.
    inRate String
    Cache growth. Unit: B/s.
    indexId String
    The ID of the file share.
    kmsRotatePeriod Number
    File share is enabled to client-side encryption, key rotation period of time. Seconds. 0 represents no rotation. Rotation of the value range: 3600 ~ 86400. Default value: 0.
    lagPeriod String
    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.
    mnsHealth String
    The messages from the queue health types. Valid values: TopicAndQueueFailure: A Message Queuing message theme can be accessed during the black hole period. TopicFailure: a message theme can be accessed during the black hole period. MNSFullSyncInit: full synchronization wait. MNSFullSyncing: full synchronization in progress. QueueFailure: a message queue can be accessed during the black hole period. MNSNotEnabled: Top speed synchronization is not enabled. MNSHealthy: sync fine.
    nfsV4Optimization Boolean
    The set up gateway file share NFS protocol, whether to enable NFS v4 optimization improve Mount Upload efficiency. Default value: false. NOTE: turns on after I will not support NFS v3 mount the filesystem on a. Gateway version >= 1.2.0 above support.
    obsoleteBuckets String
    Multi-Bucket, removing the Bucket.
    ossBucketName String
    The name of the Bucket.
    ossBucketSsl Boolean
    Whether they are using SSL connect to OSS Bucket.
    ossEndpoint String
    The set up 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.
    ossHealth String
    The OSS Bucket of type. Valid values: BucketHealthy: OSS connectivity. BucketAccessDenied: OBJECT STORAGE Service (OSS) access to an exception. BucketMiscFailure: OBJECT STORAGE Service (OSS) access to additional exception. BucketNetworkFailure: OBJECT STORAGE Service (OSS) access network an exception. BucketNotExist: OSS Bucket does not exist. Nothing returns: We may not have ever known existed.
    ossUsed String
    For a cloud-based data is. Unit: B.
    outRate String
    Upload speed. Unit: B/s.
    partialSyncPaths String
    In part mode, the directory path group JSON format.
    pathPrefix String
    The prefix of the OSS.
    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.
    remainingMetaSpace String
    You can use the metadata space. Unit: B.
    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 shared opens the reverse synchronization or acceded to by the speed synchronization group, this parameter will not take effect.
    roClientList String
    The read-only client list. When Protocol NFS is returned when the status is.
    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.
    serverSideCmk String
    File share is enabled server-side encryption, encryption used by the KMS key.
    serverSideEncryption Boolean
    If the OSS Bucket side encryption.
    size String
    The caching capacity. Unit: B.
    squash String
    The set up gateway file share NFS protocol user mapping. Valid values: none, root_squash, all_squash, all_anonymous. Default value: none.
    state String
    File synchronization types. Valid values: clean, dirty. clean: synchronization is complete. dirty: synchronization has not been completed.
    supportArchive Boolean
    Whether to support the archive transparent read.
    syncProgress Number
    Full synchronization progress. When the share has been added for a synchronization group, the return parameters are valid, that shared full synchronization progress (0~100). -2: indicates that share the Gateway version does not support this feature. -1: the share does not occur full synchronization.
    totalDownload String
    The OSS Bucket to the Gateway total downloads. Unit: B.
    totalUpload String
    The OSS Bucket to the Gateway total Upload amount. Unit: B.
    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.
    used String
    Used cache. Unit: B.
    windowsAcl Boolean
    The set up gateway file share Server Message Block (SMB) protocol, whether to enable by Windows access list (requires AD domain) the permissions control. Default value: false. NOTE: Gateway version >= 1.0.45 above support.

    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