pulumi-alicloud-kotlin/com.pulumi.alicloud.cloudstoragegateway.kotlin/GatewayFileShareArgs

GatewayFileShareArgs

data class GatewayFileShareArgs(val accessBasedEnumeration: Output<Boolean>? = null, val backendLimit: Output<Int>? = null, val browsable: Output<Boolean>? = null, val bypassCacheRead: Output<Boolean>? = null, val cacheMode: Output<String>? = null, val directIo: Output<Boolean>? = null, val downloadLimit: Output<Int>? = null, val fastReclaim: Output<Boolean>? = null, val feLimit: Output<Int>? = null, val gatewayFileShareName: Output<String>? = null, val gatewayId: Output<String>? = null, val ignoreDelete: Output<Boolean>? = null, val inPlace: Output<Boolean>? = null, val lagPeriod: Output<Int>? = null, val localPath: Output<String>? = null, val nfsV4Optimization: Output<Boolean>? = null, val ossBucketName: Output<String>? = null, val ossBucketSsl: Output<Boolean>? = null, val ossEndpoint: Output<String>? = null, val partialSyncPaths: Output<String>? = null, val pathPrefix: Output<String>? = null, val pollingInterval: Output<Int>? = null, val protocol: Output<String>? = null, val remoteSync: Output<Boolean>? = null, val remoteSyncDownload: Output<Boolean>? = null, val roClientList: Output<String>? = null, val roUserList: Output<String>? = null, val rwClientList: Output<String>? = null, val rwUserList: Output<String>? = null, val squash: Output<String>? = null, val supportArchive: Output<Boolean>? = null, val transferAcceleration: Output<Boolean>? = null, val windowsAcl: Output<Boolean>? = null) : ConvertibleToJava<GatewayFileShareArgs>

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

NOTE: Available in v1.144.0+.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cloudstoragegateway.CloudstoragegatewayFunctions;
import com.pulumi.alicloud.cloudstoragegateway.inputs.GetStocksArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.cloudstoragegateway.StorageBundle;
import com.pulumi.alicloud.cloudstoragegateway.StorageBundleArgs;
import com.pulumi.alicloud.cloudstoragegateway.Gateway;
import com.pulumi.alicloud.cloudstoragegateway.GatewayArgs;
import com.pulumi.alicloud.cloudstoragegateway.GatewayCacheDisk;
import com.pulumi.alicloud.cloudstoragegateway.GatewayCacheDiskArgs;
import com.pulumi.alicloud.oss.Bucket;
import com.pulumi.alicloud.oss.BucketArgs;
import com.pulumi.alicloud.cloudstoragegateway.GatewayFileShare;
import com.pulumi.alicloud.cloudstoragegateway.GatewayFileShareArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var defaultStocks = CloudstoragegatewayFunctions.getStocks(GetStocksArgs.builder()
            .gatewayClass("Standard")
            .build());
        var vpc = new Network("vpc", NetworkArgs.builder()
            .vpcName("example_value")
            .cidrBlock("172.16.0.0/12")
            .build());
        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vpcId(vpc.id())
            .cidrBlock("172.16.0.0/21")
            .zoneId(defaultStocks.applyValue(getStocksResult -> getStocksResult.stocks()[0].zoneId()))
            .vswitchName("example_value")
            .build());
        var defaultStorageBundle = new StorageBundle("defaultStorageBundle", StorageBundleArgs.builder()
            .storageBundleName("example_value")
            .build());
        var defaultGateway = new Gateway("defaultGateway", GatewayArgs.builder()
            .description("tf-acctestDesalone")
            .gatewayClass("Standard")
            .type("File")
            .paymentType("PayAsYouGo")
            .vswitchId(defaultSwitch.id())
            .releaseAfterExpiration(true)
            .publicNetworkBandwidth(10)
            .storageBundleId(defaultStorageBundle.id())
            .location("Cloud")
            .gatewayName("example_value")
            .build());
        var defaultGatewayCacheDisk = new GatewayCacheDisk("defaultGatewayCacheDisk", GatewayCacheDiskArgs.builder()
            .cacheDiskCategory("cloud_efficiency")
            .gatewayId(defaultGateway.id())
            .cacheDiskSizeInGb(50)
            .build());
        var defaultBucket = new Bucket("defaultBucket", BucketArgs.builder()
            .bucket("example_value")
            .build());
        var defaultGatewayFileShare = new GatewayFileShare("defaultGatewayFileShare", GatewayFileShareArgs.builder()
            .gatewayFileShareName("example_value")
            .gatewayId(defaultGateway.id())
            .localPath(defaultGatewayCacheDisk.localFilePath())
            .ossBucketName(defaultBucket.bucket())
            .ossEndpoint(defaultBucket.extranetEndpoint())
            .protocol("NFS")
            .remoteSync(true)
            .pollingInterval(4500)
            .feLimit(0)
            .backendLimit(0)
            .cacheMode("Cache")
            .squash("none")
            .lagPeriod(5)
            .build());
    }
}
Content copied to clipboard

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>
Content copied to clipboard

Constructors

Link copied to clipboard
fun GatewayFileShareArgs(accessBasedEnumeration: Output<Boolean>? = null, backendLimit: Output<Int>? = null, browsable: Output<Boolean>? = null, bypassCacheRead: Output<Boolean>? = null, cacheMode: Output<String>? = null, directIo: Output<Boolean>? = null, downloadLimit: Output<Int>? = null, fastReclaim: Output<Boolean>? = null, feLimit: Output<Int>? = null, gatewayFileShareName: Output<String>? = null, gatewayId: Output<String>? = null, ignoreDelete: Output<Boolean>? = null, inPlace: Output<Boolean>? = null, lagPeriod: Output<Int>? = null, localPath: Output<String>? = null, nfsV4Optimization: Output<Boolean>? = null, ossBucketName: Output<String>? = null, ossBucketSsl: Output<Boolean>? = null, ossEndpoint: Output<String>? = null, partialSyncPaths: Output<String>? = null, pathPrefix: Output<String>? = null, pollingInterval: Output<Int>? = null, protocol: Output<String>? = null, remoteSync: Output<Boolean>? = null, remoteSyncDownload: Output<Boolean>? = null, roClientList: Output<String>? = null, roUserList: Output<String>? = null, rwClientList: Output<String>? = null, rwUserList: Output<String>? = null, squash: Output<String>? = null, supportArchive: Output<Boolean>? = null, transferAcceleration: Output<Boolean>? = null, windowsAcl: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): GatewayFileShareArgs

Properties

Link copied to clipboard
val accessBasedEnumeration: Output<Boolean>? = null

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.

Link copied to clipboard
val backendLimit: Output<Int>? = null

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.

Link copied to clipboard
val browsable: Output<Boolean>? = null

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.

Link copied to clipboard
val bypassCacheRead: Output<Boolean>? = null

Direct reading OSS of the gateway file share.

Link copied to clipboard
val cacheMode: Output<String>? = null

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

Link copied to clipboard
val directIo: Output<Boolean>? = null

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

Link copied to clipboard
val downloadLimit: Output<Int>? = null

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.

Link copied to clipboard
val fastReclaim: Output<Boolean>? = null

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.

Link copied to clipboard
val feLimit: Output<Int>? = null

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

Link copied to clipboard
val gatewayFileShareName: Output<String>? = null

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.

Link copied to clipboard
val gatewayId: Output<String>? = null

The ID of the gateway.

Link copied to clipboard
val ignoreDelete: Output<Boolean>? = null

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.

Link copied to clipboard
val inPlace: Output<Boolean>? = null

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

Link copied to clipboard
val lagPeriod: Output<Int>? = null

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.

Link copied to clipboard
val localPath: Output<String>? = null

The cache disk inside the device name.

Link copied to clipboard
val nfsV4Optimization: Output<Boolean>? = null

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.

Link copied to clipboard
val ossBucketName: Output<String>? = null

The name of the OSS Bucket.

Link copied to clipboard
val ossBucketSsl: Output<Boolean>? = null

Whether they are using SSL connect to OSS Bucket.

Link copied to clipboard
val ossEndpoint: Output<String>? = null

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.

Link copied to clipboard
val partialSyncPaths: Output<String>? = null

In part mode, the directory path group JSON format.

Link copied to clipboard
val pathPrefix: Output<String>? = null

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.

Link copied to clipboard
val pollingInterval: Output<Int>? = null

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.

Link copied to clipboard
val protocol: Output<String>? = null

Share types. Valid values: SMB, NFS.

Link copied to clipboard
val remoteSync: Output<Boolean>? = null

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

Link copied to clipboard
val remoteSyncDownload: Output<Boolean>? = null

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.

Link copied to clipboard
val roClientList: Output<String>? = null

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

Link copied to clipboard
val roUserList: Output<String>? = null

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

Link copied to clipboard
val rwClientList: Output<String>? = null

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

Link copied to clipboard
val rwUserList: Output<String>? = null

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

Link copied to clipboard
val squash: Output<String>? = null

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.

Link copied to clipboard
val supportArchive: Output<Boolean>? = null

Whether to support the archive transparent read.

Link copied to clipboard
val transferAcceleration: Output<Boolean>? = null

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.

Link copied to clipboard
val windowsAcl: Output<Boolean>? = null

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.