published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
A RemoteServer is a specific type of Behavior called remoteServerSync.
Remote Servers can be either an FTP server, SFTP server, S3 bucket, Google Cloud Storage, Wasabi, Backblaze B2 Cloud Storage, Rackspace Cloud Files container, WebDAV, Box, Dropbox, OneDrive, SharePoint, Google Drive, Azure Blob Storage, or Files.com direct link.
Not every attribute will apply to every remote server.
FTP Servers require that you specify their hostname, port, username, password, and a value for ssl. Optionally, provide serverCertificate.
SFTP Servers require that you specify their hostname, port, username, password or privateKey, and a value for ssl. Optionally, provide serverCertificate, privateKeyPassphrase.
S3 Buckets require that you specify their s3Bucket name, and s3Region. Optionally provide a awsAccessKey, and awsSecretKey. If you don’t provide credentials, you will need to use AWS to grant us access to your bucket.
S3-Compatible Buckets require that you specify s3CompatibleBucket, s3CompatibleEndpoint, s3CompatibleAccessKey, and s3CompatibleSecretKey. Optionally provide s3CompatibleVirtualHostedStyle to use virtual-hosted-style URLs instead of path-style URLs.
Google Cloud Storage requires that you specify googleCloudStorageBucket, and then one of the following sets of authentication credentials, selected by googleCloudStorageAuthenticationMethod (defaults to json):
for JSON authentication:
googleCloudStorageProjectId, andgoogleCloudStorageCredentialsJsonfor HMAC (S3-Compatible) authentication:
googleCloudStorageS3CompatibleAccessKey, andgoogleCloudStorageS3CompatibleSecretKeyfor OAuth authentication:
googleCloudStorageOauthScope, then follow theauthSetupLinkand login with Google
Wasabi requires wasabiBucket, wasabiRegion, wasabiAccessKey, and wasabiSecretKey.
Backblaze B2 Cloud Storage backblazeB2Bucket, backblazeB2S3Endpoint, backblazeB2ApplicationKey, and backblazeB2KeyId. (Requires S3 Compatible API) See https://help.backblaze.com/hc/en-us/articles/360047425453
WebDAV Servers require that you specify their hostname, username, and password.
OneDrive follow the authSetupLink and login with Microsoft.
SharePoint supports delegated authentication through authSetupLink, or app-only authentication with sharepointTenantId, sharepointClientId, and either sharepointClientSecret or sharepointClientCertificate. Set sharepointSiteUrl to scope the remote server to a site granted through Microsoft Graph Sites.Selected; leave it blank to browse all sites.
Box follow the authSetupLink and login with Box.
Dropbox specify if dropboxTeams then follow the authSetupLink and login with Dropbox.
Google Drive follow the authSetupLink and login with Google.
Azure Blob Storage azureBlobStorageAccount, azureBlobStorageContainer, azureBlobStorageAccessKey, azureBlobStorageSasToken, azureBlobStorageDnsSuffix
Azure File Storage azureFilesStorageAccount, azureFilesStorageAccessKey, azureFilesStorageShareName, azureFilesStorageDnsSuffix
Filebase requires filebaseBucket, filebaseAccessKey, and filebaseSecretKey.
Cloudflare requires cloudflareBucket, cloudflareAccessKey, cloudflareSecretKey and cloudflareEndpoint.
Linode requires linodeBucket, linodeAccessKey, linodeSecretKey and linodeRegion.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";
const exampleRemoteServer = new filescom.RemoteServer("example_remote_server", {
userId: 1,
resetAuthentication: false,
allowRelativePaths: true,
awsAccessKey: "example",
azureBlobStorageAccount: "storage-account-name",
azureBlobStorageContainer: "container-name",
azureBlobStorageDnsSuffix: "usgovcloudapi.net",
azureBlobStorageHierarchicalNamespace: true,
azureFilesStorageAccount: "storage-account-name",
azureFilesStorageDnsSuffix: "file.core.windows.net",
azureFilesStorageShareName: "share-name",
backblazeB2Bucket: "my-bucket",
backblazeB2S3Endpoint: "s3.us-west-001.backblazeb2.com",
bufferUploads: "example",
cloudflareAccessKey: "example",
cloudflareBucket: "my-bucket",
cloudflareEndpoint: "https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
description: "More information or notes about my server",
dropboxTeams: true,
enableDedicatedIps: true,
filebaseAccessKey: "example",
filebaseBucket: "my-bucket",
filesAgentPermissionSet: "read_write",
filesAgentRoot: "example",
filesAgentVersion: "example",
outboundAgentId: 1,
googleCloudStorageAuthenticationMethod: "json",
googleCloudStorageBucket: "my-bucket",
googleCloudStorageOauthScope: "https://www.googleapis.com/auth/devstorage.read_only",
googleCloudStorageProjectId: "my-project",
googleCloudStorageS3CompatibleAccessKey: "example",
hostname: "remote-server.com",
linodeAccessKey: "example",
linodeBucket: "my-bucket",
linodeRegion: "us-east-1",
maxConnections: 1,
name: "My Remote server",
oneDriveAccountType: "personal",
pinToSiteRegion: true,
port: 1,
uploadStagingPath: "/tmp/uploads",
remoteServerCredentialId: 1,
s3AssumeRoleArn: "example",
s3AssumeRoleDurationSeconds: 1,
s3Bucket: "my-bucket",
s3CompatibleAccessKey: "example",
s3CompatibleBucket: "my-bucket",
s3CompatibleEndpoint: "mys3platform.com",
s3CompatibleRegion: "us-east-1",
s3CompatibleVirtualHostedStyle: true,
s3Region: "us-east-1",
serverCertificate: "require_match",
serverHostKey: "[public key]",
serverType: "s3",
sharepointClientId: "00000000-0000-0000-0000-000000000000",
sharepointSiteUrl: "https://example.sharepoint.com/sites/accounting",
sharepointTenantId: "00000000-0000-0000-0000-000000000000",
ssl: "if_available",
username: "user",
wasabiAccessKey: "example",
wasabiBucket: "my-bucket",
wasabiRegion: "us-west-1",
workspaceId: 0,
});
import pulumi
import pulumi_filescom as filescom
example_remote_server = filescom.RemoteServer("example_remote_server",
user_id=1,
reset_authentication=False,
allow_relative_paths=True,
aws_access_key="example",
azure_blob_storage_account="storage-account-name",
azure_blob_storage_container="container-name",
azure_blob_storage_dns_suffix="usgovcloudapi.net",
azure_blob_storage_hierarchical_namespace=True,
azure_files_storage_account="storage-account-name",
azure_files_storage_dns_suffix="file.core.windows.net",
azure_files_storage_share_name="share-name",
backblaze_b2_bucket="my-bucket",
backblaze_b2_s3_endpoint="s3.us-west-001.backblazeb2.com",
buffer_uploads="example",
cloudflare_access_key="example",
cloudflare_bucket="my-bucket",
cloudflare_endpoint="https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
description="More information or notes about my server",
dropbox_teams=True,
enable_dedicated_ips=True,
filebase_access_key="example",
filebase_bucket="my-bucket",
files_agent_permission_set="read_write",
files_agent_root="example",
files_agent_version="example",
outbound_agent_id=1,
google_cloud_storage_authentication_method="json",
google_cloud_storage_bucket="my-bucket",
google_cloud_storage_oauth_scope="https://www.googleapis.com/auth/devstorage.read_only",
google_cloud_storage_project_id="my-project",
google_cloud_storage_s3_compatible_access_key="example",
hostname="remote-server.com",
linode_access_key="example",
linode_bucket="my-bucket",
linode_region="us-east-1",
max_connections=1,
name="My Remote server",
one_drive_account_type="personal",
pin_to_site_region=True,
port=1,
upload_staging_path="/tmp/uploads",
remote_server_credential_id=1,
s3_assume_role_arn="example",
s3_assume_role_duration_seconds=1,
s3_bucket="my-bucket",
s3_compatible_access_key="example",
s3_compatible_bucket="my-bucket",
s3_compatible_endpoint="mys3platform.com",
s3_compatible_region="us-east-1",
s3_compatible_virtual_hosted_style=True,
s3_region="us-east-1",
server_certificate="require_match",
server_host_key="[public key]",
server_type="s3",
sharepoint_client_id="00000000-0000-0000-0000-000000000000",
sharepoint_site_url="https://example.sharepoint.com/sites/accounting",
sharepoint_tenant_id="00000000-0000-0000-0000-000000000000",
ssl="if_available",
username="user",
wasabi_access_key="example",
wasabi_bucket="my-bucket",
wasabi_region="us-west-1",
workspace_id=0)
package main
import (
"github.com/jschady/pulumi-filescom/sdk/go/filescom"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := filescom.NewRemoteServer(ctx, "example_remote_server", &filescom.RemoteServerArgs{
UserId: pulumi.Int(1),
ResetAuthentication: pulumi.Bool(false),
AllowRelativePaths: pulumi.Bool(true),
AwsAccessKey: pulumi.String("example"),
AzureBlobStorageAccount: pulumi.String("storage-account-name"),
AzureBlobStorageContainer: pulumi.String("container-name"),
AzureBlobStorageDnsSuffix: pulumi.String("usgovcloudapi.net"),
AzureBlobStorageHierarchicalNamespace: pulumi.Bool(true),
AzureFilesStorageAccount: pulumi.String("storage-account-name"),
AzureFilesStorageDnsSuffix: pulumi.String("file.core.windows.net"),
AzureFilesStorageShareName: pulumi.String("share-name"),
BackblazeB2Bucket: pulumi.String("my-bucket"),
BackblazeB2S3Endpoint: pulumi.String("s3.us-west-001.backblazeb2.com"),
BufferUploads: pulumi.String("example"),
CloudflareAccessKey: pulumi.String("example"),
CloudflareBucket: pulumi.String("my-bucket"),
CloudflareEndpoint: pulumi.String("https://<ACCOUNT_ID>.r2.cloudflarestorage.com"),
Description: pulumi.String("More information or notes about my server"),
DropboxTeams: pulumi.Bool(true),
EnableDedicatedIps: pulumi.Bool(true),
FilebaseAccessKey: pulumi.String("example"),
FilebaseBucket: pulumi.String("my-bucket"),
FilesAgentPermissionSet: pulumi.String("read_write"),
FilesAgentRoot: pulumi.String("example"),
FilesAgentVersion: pulumi.String("example"),
OutboundAgentId: pulumi.Int(1),
GoogleCloudStorageAuthenticationMethod: pulumi.String("json"),
GoogleCloudStorageBucket: pulumi.String("my-bucket"),
GoogleCloudStorageOauthScope: pulumi.String("https://www.googleapis.com/auth/devstorage.read_only"),
GoogleCloudStorageProjectId: pulumi.String("my-project"),
GoogleCloudStorageS3CompatibleAccessKey: pulumi.String("example"),
Hostname: pulumi.String("remote-server.com"),
LinodeAccessKey: pulumi.String("example"),
LinodeBucket: pulumi.String("my-bucket"),
LinodeRegion: pulumi.String("us-east-1"),
MaxConnections: pulumi.Int(1),
Name: pulumi.String("My Remote server"),
OneDriveAccountType: pulumi.String("personal"),
PinToSiteRegion: pulumi.Bool(true),
Port: pulumi.Int(1),
UploadStagingPath: pulumi.String("/tmp/uploads"),
RemoteServerCredentialId: pulumi.Int(1),
S3AssumeRoleArn: pulumi.String("example"),
S3AssumeRoleDurationSeconds: pulumi.Int(1),
S3Bucket: pulumi.String("my-bucket"),
S3CompatibleAccessKey: pulumi.String("example"),
S3CompatibleBucket: pulumi.String("my-bucket"),
S3CompatibleEndpoint: pulumi.String("mys3platform.com"),
S3CompatibleRegion: pulumi.String("us-east-1"),
S3CompatibleVirtualHostedStyle: pulumi.Bool(true),
S3Region: pulumi.String("us-east-1"),
ServerCertificate: pulumi.String("require_match"),
ServerHostKey: pulumi.String("[public key]"),
ServerType: pulumi.String("s3"),
SharepointClientId: pulumi.String("00000000-0000-0000-0000-000000000000"),
SharepointSiteUrl: pulumi.String("https://example.sharepoint.com/sites/accounting"),
SharepointTenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
Ssl: pulumi.String("if_available"),
Username: pulumi.String("user"),
WasabiAccessKey: pulumi.String("example"),
WasabiBucket: pulumi.String("my-bucket"),
WasabiRegion: pulumi.String("us-west-1"),
WorkspaceId: pulumi.Int(0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;
return await Deployment.RunAsync(() =>
{
var exampleRemoteServer = new Filescom.RemoteServer("example_remote_server", new()
{
UserId = 1,
ResetAuthentication = false,
AllowRelativePaths = true,
AwsAccessKey = "example",
AzureBlobStorageAccount = "storage-account-name",
AzureBlobStorageContainer = "container-name",
AzureBlobStorageDnsSuffix = "usgovcloudapi.net",
AzureBlobStorageHierarchicalNamespace = true,
AzureFilesStorageAccount = "storage-account-name",
AzureFilesStorageDnsSuffix = "file.core.windows.net",
AzureFilesStorageShareName = "share-name",
BackblazeB2Bucket = "my-bucket",
BackblazeB2S3Endpoint = "s3.us-west-001.backblazeb2.com",
BufferUploads = "example",
CloudflareAccessKey = "example",
CloudflareBucket = "my-bucket",
CloudflareEndpoint = "https://<ACCOUNT_ID>.r2.cloudflarestorage.com",
Description = "More information or notes about my server",
DropboxTeams = true,
EnableDedicatedIps = true,
FilebaseAccessKey = "example",
FilebaseBucket = "my-bucket",
FilesAgentPermissionSet = "read_write",
FilesAgentRoot = "example",
FilesAgentVersion = "example",
OutboundAgentId = 1,
GoogleCloudStorageAuthenticationMethod = "json",
GoogleCloudStorageBucket = "my-bucket",
GoogleCloudStorageOauthScope = "https://www.googleapis.com/auth/devstorage.read_only",
GoogleCloudStorageProjectId = "my-project",
GoogleCloudStorageS3CompatibleAccessKey = "example",
Hostname = "remote-server.com",
LinodeAccessKey = "example",
LinodeBucket = "my-bucket",
LinodeRegion = "us-east-1",
MaxConnections = 1,
Name = "My Remote server",
OneDriveAccountType = "personal",
PinToSiteRegion = true,
Port = 1,
UploadStagingPath = "/tmp/uploads",
RemoteServerCredentialId = 1,
S3AssumeRoleArn = "example",
S3AssumeRoleDurationSeconds = 1,
S3Bucket = "my-bucket",
S3CompatibleAccessKey = "example",
S3CompatibleBucket = "my-bucket",
S3CompatibleEndpoint = "mys3platform.com",
S3CompatibleRegion = "us-east-1",
S3CompatibleVirtualHostedStyle = true,
S3Region = "us-east-1",
ServerCertificate = "require_match",
ServerHostKey = "[public key]",
ServerType = "s3",
SharepointClientId = "00000000-0000-0000-0000-000000000000",
SharepointSiteUrl = "https://example.sharepoint.com/sites/accounting",
SharepointTenantId = "00000000-0000-0000-0000-000000000000",
Ssl = "if_available",
Username = "user",
WasabiAccessKey = "example",
WasabiBucket = "my-bucket",
WasabiRegion = "us-west-1",
WorkspaceId = 0,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.RemoteServer;
import com.pulumi.filescom.RemoteServerArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var exampleRemoteServer = new RemoteServer("exampleRemoteServer", RemoteServerArgs.builder()
.userId(1)
.resetAuthentication(false)
.allowRelativePaths(true)
.awsAccessKey("example")
.azureBlobStorageAccount("storage-account-name")
.azureBlobStorageContainer("container-name")
.azureBlobStorageDnsSuffix("usgovcloudapi.net")
.azureBlobStorageHierarchicalNamespace(true)
.azureFilesStorageAccount("storage-account-name")
.azureFilesStorageDnsSuffix("file.core.windows.net")
.azureFilesStorageShareName("share-name")
.backblazeB2Bucket("my-bucket")
.backblazeB2S3Endpoint("s3.us-west-001.backblazeb2.com")
.bufferUploads("example")
.cloudflareAccessKey("example")
.cloudflareBucket("my-bucket")
.cloudflareEndpoint("https://<ACCOUNT_ID>.r2.cloudflarestorage.com")
.description("More information or notes about my server")
.dropboxTeams(true)
.enableDedicatedIps(true)
.filebaseAccessKey("example")
.filebaseBucket("my-bucket")
.filesAgentPermissionSet("read_write")
.filesAgentRoot("example")
.filesAgentVersion("example")
.outboundAgentId(1)
.googleCloudStorageAuthenticationMethod("json")
.googleCloudStorageBucket("my-bucket")
.googleCloudStorageOauthScope("https://www.googleapis.com/auth/devstorage.read_only")
.googleCloudStorageProjectId("my-project")
.googleCloudStorageS3CompatibleAccessKey("example")
.hostname("remote-server.com")
.linodeAccessKey("example")
.linodeBucket("my-bucket")
.linodeRegion("us-east-1")
.maxConnections(1)
.name("My Remote server")
.oneDriveAccountType("personal")
.pinToSiteRegion(true)
.port(1)
.uploadStagingPath("/tmp/uploads")
.remoteServerCredentialId(1)
.s3AssumeRoleArn("example")
.s3AssumeRoleDurationSeconds(1)
.s3Bucket("my-bucket")
.s3CompatibleAccessKey("example")
.s3CompatibleBucket("my-bucket")
.s3CompatibleEndpoint("mys3platform.com")
.s3CompatibleRegion("us-east-1")
.s3CompatibleVirtualHostedStyle(true)
.s3Region("us-east-1")
.serverCertificate("require_match")
.serverHostKey("[public key]")
.serverType("s3")
.sharepointClientId("00000000-0000-0000-0000-000000000000")
.sharepointSiteUrl("https://example.sharepoint.com/sites/accounting")
.sharepointTenantId("00000000-0000-0000-0000-000000000000")
.ssl("if_available")
.username("user")
.wasabiAccessKey("example")
.wasabiBucket("my-bucket")
.wasabiRegion("us-west-1")
.workspaceId(0)
.build());
}
}
resources:
exampleRemoteServer:
type: filescom:RemoteServer
name: example_remote_server
properties:
userId: 1
resetAuthentication: false
allowRelativePaths: true
awsAccessKey: example
azureBlobStorageAccount: storage-account-name
azureBlobStorageContainer: container-name
azureBlobStorageDnsSuffix: usgovcloudapi.net
azureBlobStorageHierarchicalNamespace: true
azureFilesStorageAccount: storage-account-name
azureFilesStorageDnsSuffix: file.core.windows.net
azureFilesStorageShareName: share-name
backblazeB2Bucket: my-bucket
backblazeB2S3Endpoint: s3.us-west-001.backblazeb2.com
bufferUploads: example
cloudflareAccessKey: example
cloudflareBucket: my-bucket
cloudflareEndpoint: https://<ACCOUNT_ID>.r2.cloudflarestorage.com
description: More information or notes about my server
dropboxTeams: true
enableDedicatedIps: true
filebaseAccessKey: example
filebaseBucket: my-bucket
filesAgentPermissionSet: read_write
filesAgentRoot: example
filesAgentVersion: example
outboundAgentId: 1
googleCloudStorageAuthenticationMethod: json
googleCloudStorageBucket: my-bucket
googleCloudStorageOauthScope: https://www.googleapis.com/auth/devstorage.read_only
googleCloudStorageProjectId: my-project
googleCloudStorageS3CompatibleAccessKey: example
hostname: remote-server.com
linodeAccessKey: example
linodeBucket: my-bucket
linodeRegion: us-east-1
maxConnections: 1
name: My Remote server
oneDriveAccountType: personal
pinToSiteRegion: true
port: 1
uploadStagingPath: /tmp/uploads
remoteServerCredentialId: 1
s3AssumeRoleArn: example
s3AssumeRoleDurationSeconds: 1
s3Bucket: my-bucket
s3CompatibleAccessKey: example
s3CompatibleBucket: my-bucket
s3CompatibleEndpoint: mys3platform.com
s3CompatibleRegion: us-east-1
s3CompatibleVirtualHostedStyle: true
s3Region: us-east-1
serverCertificate: require_match
serverHostKey: '[public key]'
serverType: s3
sharepointClientId: 00000000-0000-0000-0000-000000000000
sharepointSiteUrl: https://example.sharepoint.com/sites/accounting
sharepointTenantId: 00000000-0000-0000-0000-000000000000
ssl: if_available
username: user
wasabiAccessKey: example
wasabiBucket: my-bucket
wasabiRegion: us-west-1
workspaceId: 0
pulumi {
required_providers {
filescom = {
source = "pulumi/filescom"
}
}
}
resource "filescom_remoteserver" "example_remote_server" {
user_id = 1
reset_authentication = false
allow_relative_paths = true
aws_access_key = "example"
azure_blob_storage_account = "storage-account-name"
azure_blob_storage_container = "container-name"
azure_blob_storage_dns_suffix = "usgovcloudapi.net"
azure_blob_storage_hierarchical_namespace = true
azure_files_storage_account = "storage-account-name"
azure_files_storage_dns_suffix = "file.core.windows.net"
azure_files_storage_share_name = "share-name"
backblaze_b2_bucket = "my-bucket"
backblaze_b2_s3_endpoint = "s3.us-west-001.backblazeb2.com"
buffer_uploads = "example"
cloudflare_access_key = "example"
cloudflare_bucket = "my-bucket"
cloudflare_endpoint = "https://<ACCOUNT_ID>.r2.cloudflarestorage.com"
description = "More information or notes about my server"
dropbox_teams = true
enable_dedicated_ips = true
filebase_access_key = "example"
filebase_bucket = "my-bucket"
files_agent_permission_set = "read_write"
files_agent_root = "example"
files_agent_version = "example"
outbound_agent_id = 1
google_cloud_storage_authentication_method = "json"
google_cloud_storage_bucket = "my-bucket"
google_cloud_storage_oauth_scope = "https://www.googleapis.com/auth/devstorage.read_only"
google_cloud_storage_project_id = "my-project"
google_cloud_storage_s3_compatible_access_key = "example"
hostname = "remote-server.com"
linode_access_key = "example"
linode_bucket = "my-bucket"
linode_region = "us-east-1"
max_connections = 1
name = "My Remote server"
one_drive_account_type = "personal"
pin_to_site_region = true
port = 1
upload_staging_path = "/tmp/uploads"
remote_server_credential_id = 1
s3_assume_role_arn = "example"
s3_assume_role_duration_seconds = 1
s3_bucket = "my-bucket"
s3_compatible_access_key = "example"
s3_compatible_bucket = "my-bucket"
s3_compatible_endpoint = "mys3platform.com"
s3_compatible_region = "us-east-1"
s3_compatible_virtual_hosted_style = true
s3_region = "us-east-1"
server_certificate = "require_match"
server_host_key = "[public key]"
server_type = "s3"
sharepoint_client_id = "00000000-0000-0000-0000-000000000000"
sharepoint_site_url = "https://example.sharepoint.com/sites/accounting"
sharepoint_tenant_id = "00000000-0000-0000-0000-000000000000"
ssl = "if_available"
username = "user"
wasabi_access_key = "example"
wasabi_bucket = "my-bucket"
wasabi_region = "us-west-1"
workspace_id = 0
}
Create RemoteServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RemoteServer(name: string, args?: RemoteServerArgs, opts?: CustomResourceOptions);@overload
def RemoteServer(resource_name: str,
args: Optional[RemoteServerArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def RemoteServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_relative_paths: Optional[bool] = None,
aws_access_key: Optional[str] = None,
aws_secret_key: Optional[str] = None,
azure_blob_storage_access_key: Optional[str] = None,
azure_blob_storage_account: Optional[str] = None,
azure_blob_storage_container: Optional[str] = None,
azure_blob_storage_dns_suffix: Optional[str] = None,
azure_blob_storage_hierarchical_namespace: Optional[bool] = None,
azure_blob_storage_sas_token: Optional[str] = None,
azure_files_storage_access_key: Optional[str] = None,
azure_files_storage_account: Optional[str] = None,
azure_files_storage_dns_suffix: Optional[str] = None,
azure_files_storage_sas_token: Optional[str] = None,
azure_files_storage_share_name: Optional[str] = None,
backblaze_b2_application_key: Optional[str] = None,
backblaze_b2_bucket: Optional[str] = None,
backblaze_b2_key_id: Optional[str] = None,
backblaze_b2_s3_endpoint: Optional[str] = None,
buffer_uploads: Optional[str] = None,
cloudflare_access_key: Optional[str] = None,
cloudflare_bucket: Optional[str] = None,
cloudflare_endpoint: Optional[str] = None,
cloudflare_secret_key: Optional[str] = None,
description: Optional[str] = None,
dropbox_teams: Optional[bool] = None,
enable_dedicated_ips: Optional[bool] = None,
filebase_access_key: Optional[str] = None,
filebase_bucket: Optional[str] = None,
filebase_secret_key: Optional[str] = None,
files_agent_permission_set: Optional[str] = None,
files_agent_root: Optional[str] = None,
files_agent_version: Optional[str] = None,
files_api_key: Optional[str] = None,
google_cloud_storage_authentication_method: Optional[str] = None,
google_cloud_storage_bucket: Optional[str] = None,
google_cloud_storage_credentials_json: Optional[str] = None,
google_cloud_storage_oauth_scope: Optional[str] = None,
google_cloud_storage_project_id: Optional[str] = None,
google_cloud_storage_s3_compatible_access_key: Optional[str] = None,
google_cloud_storage_s3_compatible_secret_key: Optional[str] = None,
hostname: Optional[str] = None,
linode_access_key: Optional[str] = None,
linode_bucket: Optional[str] = None,
linode_region: Optional[str] = None,
linode_secret_key: Optional[str] = None,
max_connections: Optional[int] = None,
name: Optional[str] = None,
one_drive_account_type: Optional[str] = None,
outbound_agent_id: Optional[int] = None,
password: Optional[str] = None,
pin_to_site_region: Optional[bool] = None,
port: Optional[int] = None,
private_key: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
remote_server_credential_id: Optional[int] = None,
reset_authentication: Optional[bool] = None,
s3_assume_role_arn: Optional[str] = None,
s3_assume_role_duration_seconds: Optional[int] = None,
s3_bucket: Optional[str] = None,
s3_compatible_access_key: Optional[str] = None,
s3_compatible_bucket: Optional[str] = None,
s3_compatible_endpoint: Optional[str] = None,
s3_compatible_region: Optional[str] = None,
s3_compatible_secret_key: Optional[str] = None,
s3_compatible_virtual_hosted_style: Optional[bool] = None,
s3_region: Optional[str] = None,
server_certificate: Optional[str] = None,
server_host_key: Optional[str] = None,
server_type: Optional[str] = None,
sharepoint_client_certificate: Optional[str] = None,
sharepoint_client_id: Optional[str] = None,
sharepoint_client_secret: Optional[str] = None,
sharepoint_site_url: Optional[str] = None,
sharepoint_tenant_id: Optional[str] = None,
ssl: Optional[str] = None,
ssl_certificate: Optional[str] = None,
upload_staging_path: Optional[str] = None,
user_id: Optional[int] = None,
username: Optional[str] = None,
wasabi_access_key: Optional[str] = None,
wasabi_bucket: Optional[str] = None,
wasabi_region: Optional[str] = None,
wasabi_secret_key: Optional[str] = None,
workspace_id: Optional[int] = None)func NewRemoteServer(ctx *Context, name string, args *RemoteServerArgs, opts ...ResourceOption) (*RemoteServer, error)public RemoteServer(string name, RemoteServerArgs? args = null, CustomResourceOptions? opts = null)
public RemoteServer(String name, RemoteServerArgs args)
public RemoteServer(String name, RemoteServerArgs args, CustomResourceOptions options)
type: filescom:RemoteServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "filescom_remote_server" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args RemoteServerArgs
- 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 RemoteServerArgs
- 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 RemoteServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RemoteServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RemoteServerArgs
- 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 remoteServerResource = new Filescom.RemoteServer("remoteServerResource", new()
{
AllowRelativePaths = false,
AwsAccessKey = "string",
AwsSecretKey = "string",
AzureBlobStorageAccessKey = "string",
AzureBlobStorageAccount = "string",
AzureBlobStorageContainer = "string",
AzureBlobStorageDnsSuffix = "string",
AzureBlobStorageHierarchicalNamespace = false,
AzureBlobStorageSasToken = "string",
AzureFilesStorageAccessKey = "string",
AzureFilesStorageAccount = "string",
AzureFilesStorageDnsSuffix = "string",
AzureFilesStorageSasToken = "string",
AzureFilesStorageShareName = "string",
BackblazeB2ApplicationKey = "string",
BackblazeB2Bucket = "string",
BackblazeB2KeyId = "string",
BackblazeB2S3Endpoint = "string",
BufferUploads = "string",
CloudflareAccessKey = "string",
CloudflareBucket = "string",
CloudflareEndpoint = "string",
CloudflareSecretKey = "string",
Description = "string",
DropboxTeams = false,
EnableDedicatedIps = false,
FilebaseAccessKey = "string",
FilebaseBucket = "string",
FilebaseSecretKey = "string",
FilesAgentPermissionSet = "string",
FilesAgentRoot = "string",
FilesAgentVersion = "string",
FilesApiKey = "string",
GoogleCloudStorageAuthenticationMethod = "string",
GoogleCloudStorageBucket = "string",
GoogleCloudStorageCredentialsJson = "string",
GoogleCloudStorageOauthScope = "string",
GoogleCloudStorageProjectId = "string",
GoogleCloudStorageS3CompatibleAccessKey = "string",
GoogleCloudStorageS3CompatibleSecretKey = "string",
Hostname = "string",
LinodeAccessKey = "string",
LinodeBucket = "string",
LinodeRegion = "string",
LinodeSecretKey = "string",
MaxConnections = 0,
Name = "string",
OneDriveAccountType = "string",
OutboundAgentId = 0,
Password = "string",
PinToSiteRegion = false,
Port = 0,
PrivateKey = "string",
PrivateKeyPassphrase = "string",
RemoteServerCredentialId = 0,
ResetAuthentication = false,
S3AssumeRoleArn = "string",
S3AssumeRoleDurationSeconds = 0,
S3Bucket = "string",
S3CompatibleAccessKey = "string",
S3CompatibleBucket = "string",
S3CompatibleEndpoint = "string",
S3CompatibleRegion = "string",
S3CompatibleSecretKey = "string",
S3CompatibleVirtualHostedStyle = false,
S3Region = "string",
ServerCertificate = "string",
ServerHostKey = "string",
ServerType = "string",
SharepointClientCertificate = "string",
SharepointClientId = "string",
SharepointClientSecret = "string",
SharepointSiteUrl = "string",
SharepointTenantId = "string",
Ssl = "string",
SslCertificate = "string",
UploadStagingPath = "string",
UserId = 0,
Username = "string",
WasabiAccessKey = "string",
WasabiBucket = "string",
WasabiRegion = "string",
WasabiSecretKey = "string",
WorkspaceId = 0,
});
example, err := filescom.NewRemoteServer(ctx, "remoteServerResource", &filescom.RemoteServerArgs{
AllowRelativePaths: pulumi.Bool(false),
AwsAccessKey: pulumi.String("string"),
AwsSecretKey: pulumi.String("string"),
AzureBlobStorageAccessKey: pulumi.String("string"),
AzureBlobStorageAccount: pulumi.String("string"),
AzureBlobStorageContainer: pulumi.String("string"),
AzureBlobStorageDnsSuffix: pulumi.String("string"),
AzureBlobStorageHierarchicalNamespace: pulumi.Bool(false),
AzureBlobStorageSasToken: pulumi.String("string"),
AzureFilesStorageAccessKey: pulumi.String("string"),
AzureFilesStorageAccount: pulumi.String("string"),
AzureFilesStorageDnsSuffix: pulumi.String("string"),
AzureFilesStorageSasToken: pulumi.String("string"),
AzureFilesStorageShareName: pulumi.String("string"),
BackblazeB2ApplicationKey: pulumi.String("string"),
BackblazeB2Bucket: pulumi.String("string"),
BackblazeB2KeyId: pulumi.String("string"),
BackblazeB2S3Endpoint: pulumi.String("string"),
BufferUploads: pulumi.String("string"),
CloudflareAccessKey: pulumi.String("string"),
CloudflareBucket: pulumi.String("string"),
CloudflareEndpoint: pulumi.String("string"),
CloudflareSecretKey: pulumi.String("string"),
Description: pulumi.String("string"),
DropboxTeams: pulumi.Bool(false),
EnableDedicatedIps: pulumi.Bool(false),
FilebaseAccessKey: pulumi.String("string"),
FilebaseBucket: pulumi.String("string"),
FilebaseSecretKey: pulumi.String("string"),
FilesAgentPermissionSet: pulumi.String("string"),
FilesAgentRoot: pulumi.String("string"),
FilesAgentVersion: pulumi.String("string"),
FilesApiKey: pulumi.String("string"),
GoogleCloudStorageAuthenticationMethod: pulumi.String("string"),
GoogleCloudStorageBucket: pulumi.String("string"),
GoogleCloudStorageCredentialsJson: pulumi.String("string"),
GoogleCloudStorageOauthScope: pulumi.String("string"),
GoogleCloudStorageProjectId: pulumi.String("string"),
GoogleCloudStorageS3CompatibleAccessKey: pulumi.String("string"),
GoogleCloudStorageS3CompatibleSecretKey: pulumi.String("string"),
Hostname: pulumi.String("string"),
LinodeAccessKey: pulumi.String("string"),
LinodeBucket: pulumi.String("string"),
LinodeRegion: pulumi.String("string"),
LinodeSecretKey: pulumi.String("string"),
MaxConnections: pulumi.Int(0),
Name: pulumi.String("string"),
OneDriveAccountType: pulumi.String("string"),
OutboundAgentId: pulumi.Int(0),
Password: pulumi.String("string"),
PinToSiteRegion: pulumi.Bool(false),
Port: pulumi.Int(0),
PrivateKey: pulumi.String("string"),
PrivateKeyPassphrase: pulumi.String("string"),
RemoteServerCredentialId: pulumi.Int(0),
ResetAuthentication: pulumi.Bool(false),
S3AssumeRoleArn: pulumi.String("string"),
S3AssumeRoleDurationSeconds: pulumi.Int(0),
S3Bucket: pulumi.String("string"),
S3CompatibleAccessKey: pulumi.String("string"),
S3CompatibleBucket: pulumi.String("string"),
S3CompatibleEndpoint: pulumi.String("string"),
S3CompatibleRegion: pulumi.String("string"),
S3CompatibleSecretKey: pulumi.String("string"),
S3CompatibleVirtualHostedStyle: pulumi.Bool(false),
S3Region: pulumi.String("string"),
ServerCertificate: pulumi.String("string"),
ServerHostKey: pulumi.String("string"),
ServerType: pulumi.String("string"),
SharepointClientCertificate: pulumi.String("string"),
SharepointClientId: pulumi.String("string"),
SharepointClientSecret: pulumi.String("string"),
SharepointSiteUrl: pulumi.String("string"),
SharepointTenantId: pulumi.String("string"),
Ssl: pulumi.String("string"),
SslCertificate: pulumi.String("string"),
UploadStagingPath: pulumi.String("string"),
UserId: pulumi.Int(0),
Username: pulumi.String("string"),
WasabiAccessKey: pulumi.String("string"),
WasabiBucket: pulumi.String("string"),
WasabiRegion: pulumi.String("string"),
WasabiSecretKey: pulumi.String("string"),
WorkspaceId: pulumi.Int(0),
})
resource "filescom_remote_server" "remoteServerResource" {
lifecycle {
create_before_destroy = true
}
allow_relative_paths = false
aws_access_key = "string"
aws_secret_key = "string"
azure_blob_storage_access_key = "string"
azure_blob_storage_account = "string"
azure_blob_storage_container = "string"
azure_blob_storage_dns_suffix = "string"
azure_blob_storage_hierarchical_namespace = false
azure_blob_storage_sas_token = "string"
azure_files_storage_access_key = "string"
azure_files_storage_account = "string"
azure_files_storage_dns_suffix = "string"
azure_files_storage_sas_token = "string"
azure_files_storage_share_name = "string"
backblaze_b2_application_key = "string"
backblaze_b2_bucket = "string"
backblaze_b2_key_id = "string"
backblaze_b2_s3_endpoint = "string"
buffer_uploads = "string"
cloudflare_access_key = "string"
cloudflare_bucket = "string"
cloudflare_endpoint = "string"
cloudflare_secret_key = "string"
description = "string"
dropbox_teams = false
enable_dedicated_ips = false
filebase_access_key = "string"
filebase_bucket = "string"
filebase_secret_key = "string"
files_agent_permission_set = "string"
files_agent_root = "string"
files_agent_version = "string"
files_api_key = "string"
google_cloud_storage_authentication_method = "string"
google_cloud_storage_bucket = "string"
google_cloud_storage_credentials_json = "string"
google_cloud_storage_oauth_scope = "string"
google_cloud_storage_project_id = "string"
google_cloud_storage_s3_compatible_access_key = "string"
google_cloud_storage_s3_compatible_secret_key = "string"
hostname = "string"
linode_access_key = "string"
linode_bucket = "string"
linode_region = "string"
linode_secret_key = "string"
max_connections = 0
name = "string"
one_drive_account_type = "string"
outbound_agent_id = 0
password = "string"
pin_to_site_region = false
port = 0
private_key = "string"
private_key_passphrase = "string"
remote_server_credential_id = 0
reset_authentication = false
s3_assume_role_arn = "string"
s3_assume_role_duration_seconds = 0
s3_bucket = "string"
s3_compatible_access_key = "string"
s3_compatible_bucket = "string"
s3_compatible_endpoint = "string"
s3_compatible_region = "string"
s3_compatible_secret_key = "string"
s3_compatible_virtual_hosted_style = false
s3_region = "string"
server_certificate = "string"
server_host_key = "string"
server_type = "string"
sharepoint_client_certificate = "string"
sharepoint_client_id = "string"
sharepoint_client_secret = "string"
sharepoint_site_url = "string"
sharepoint_tenant_id = "string"
ssl = "string"
ssl_certificate = "string"
upload_staging_path = "string"
user_id = 0
username = "string"
wasabi_access_key = "string"
wasabi_bucket = "string"
wasabi_region = "string"
wasabi_secret_key = "string"
workspace_id = 0
}
var remoteServerResource = new RemoteServer("remoteServerResource", RemoteServerArgs.builder()
.allowRelativePaths(false)
.awsAccessKey("string")
.awsSecretKey("string")
.azureBlobStorageAccessKey("string")
.azureBlobStorageAccount("string")
.azureBlobStorageContainer("string")
.azureBlobStorageDnsSuffix("string")
.azureBlobStorageHierarchicalNamespace(false)
.azureBlobStorageSasToken("string")
.azureFilesStorageAccessKey("string")
.azureFilesStorageAccount("string")
.azureFilesStorageDnsSuffix("string")
.azureFilesStorageSasToken("string")
.azureFilesStorageShareName("string")
.backblazeB2ApplicationKey("string")
.backblazeB2Bucket("string")
.backblazeB2KeyId("string")
.backblazeB2S3Endpoint("string")
.bufferUploads("string")
.cloudflareAccessKey("string")
.cloudflareBucket("string")
.cloudflareEndpoint("string")
.cloudflareSecretKey("string")
.description("string")
.dropboxTeams(false)
.enableDedicatedIps(false)
.filebaseAccessKey("string")
.filebaseBucket("string")
.filebaseSecretKey("string")
.filesAgentPermissionSet("string")
.filesAgentRoot("string")
.filesAgentVersion("string")
.filesApiKey("string")
.googleCloudStorageAuthenticationMethod("string")
.googleCloudStorageBucket("string")
.googleCloudStorageCredentialsJson("string")
.googleCloudStorageOauthScope("string")
.googleCloudStorageProjectId("string")
.googleCloudStorageS3CompatibleAccessKey("string")
.googleCloudStorageS3CompatibleSecretKey("string")
.hostname("string")
.linodeAccessKey("string")
.linodeBucket("string")
.linodeRegion("string")
.linodeSecretKey("string")
.maxConnections(0)
.name("string")
.oneDriveAccountType("string")
.outboundAgentId(0)
.password("string")
.pinToSiteRegion(false)
.port(0)
.privateKey("string")
.privateKeyPassphrase("string")
.remoteServerCredentialId(0)
.resetAuthentication(false)
.s3AssumeRoleArn("string")
.s3AssumeRoleDurationSeconds(0)
.s3Bucket("string")
.s3CompatibleAccessKey("string")
.s3CompatibleBucket("string")
.s3CompatibleEndpoint("string")
.s3CompatibleRegion("string")
.s3CompatibleSecretKey("string")
.s3CompatibleVirtualHostedStyle(false)
.s3Region("string")
.serverCertificate("string")
.serverHostKey("string")
.serverType("string")
.sharepointClientCertificate("string")
.sharepointClientId("string")
.sharepointClientSecret("string")
.sharepointSiteUrl("string")
.sharepointTenantId("string")
.ssl("string")
.sslCertificate("string")
.uploadStagingPath("string")
.userId(0)
.username("string")
.wasabiAccessKey("string")
.wasabiBucket("string")
.wasabiRegion("string")
.wasabiSecretKey("string")
.workspaceId(0)
.build());
remote_server_resource = filescom.RemoteServer("remoteServerResource",
allow_relative_paths=False,
aws_access_key="string",
aws_secret_key="string",
azure_blob_storage_access_key="string",
azure_blob_storage_account="string",
azure_blob_storage_container="string",
azure_blob_storage_dns_suffix="string",
azure_blob_storage_hierarchical_namespace=False,
azure_blob_storage_sas_token="string",
azure_files_storage_access_key="string",
azure_files_storage_account="string",
azure_files_storage_dns_suffix="string",
azure_files_storage_sas_token="string",
azure_files_storage_share_name="string",
backblaze_b2_application_key="string",
backblaze_b2_bucket="string",
backblaze_b2_key_id="string",
backblaze_b2_s3_endpoint="string",
buffer_uploads="string",
cloudflare_access_key="string",
cloudflare_bucket="string",
cloudflare_endpoint="string",
cloudflare_secret_key="string",
description="string",
dropbox_teams=False,
enable_dedicated_ips=False,
filebase_access_key="string",
filebase_bucket="string",
filebase_secret_key="string",
files_agent_permission_set="string",
files_agent_root="string",
files_agent_version="string",
files_api_key="string",
google_cloud_storage_authentication_method="string",
google_cloud_storage_bucket="string",
google_cloud_storage_credentials_json="string",
google_cloud_storage_oauth_scope="string",
google_cloud_storage_project_id="string",
google_cloud_storage_s3_compatible_access_key="string",
google_cloud_storage_s3_compatible_secret_key="string",
hostname="string",
linode_access_key="string",
linode_bucket="string",
linode_region="string",
linode_secret_key="string",
max_connections=0,
name="string",
one_drive_account_type="string",
outbound_agent_id=0,
password="string",
pin_to_site_region=False,
port=0,
private_key="string",
private_key_passphrase="string",
remote_server_credential_id=0,
reset_authentication=False,
s3_assume_role_arn="string",
s3_assume_role_duration_seconds=0,
s3_bucket="string",
s3_compatible_access_key="string",
s3_compatible_bucket="string",
s3_compatible_endpoint="string",
s3_compatible_region="string",
s3_compatible_secret_key="string",
s3_compatible_virtual_hosted_style=False,
s3_region="string",
server_certificate="string",
server_host_key="string",
server_type="string",
sharepoint_client_certificate="string",
sharepoint_client_id="string",
sharepoint_client_secret="string",
sharepoint_site_url="string",
sharepoint_tenant_id="string",
ssl="string",
ssl_certificate="string",
upload_staging_path="string",
user_id=0,
username="string",
wasabi_access_key="string",
wasabi_bucket="string",
wasabi_region="string",
wasabi_secret_key="string",
workspace_id=0)
const remoteServerResource = new filescom.RemoteServer("remoteServerResource", {
allowRelativePaths: false,
awsAccessKey: "string",
awsSecretKey: "string",
azureBlobStorageAccessKey: "string",
azureBlobStorageAccount: "string",
azureBlobStorageContainer: "string",
azureBlobStorageDnsSuffix: "string",
azureBlobStorageHierarchicalNamespace: false,
azureBlobStorageSasToken: "string",
azureFilesStorageAccessKey: "string",
azureFilesStorageAccount: "string",
azureFilesStorageDnsSuffix: "string",
azureFilesStorageSasToken: "string",
azureFilesStorageShareName: "string",
backblazeB2ApplicationKey: "string",
backblazeB2Bucket: "string",
backblazeB2KeyId: "string",
backblazeB2S3Endpoint: "string",
bufferUploads: "string",
cloudflareAccessKey: "string",
cloudflareBucket: "string",
cloudflareEndpoint: "string",
cloudflareSecretKey: "string",
description: "string",
dropboxTeams: false,
enableDedicatedIps: false,
filebaseAccessKey: "string",
filebaseBucket: "string",
filebaseSecretKey: "string",
filesAgentPermissionSet: "string",
filesAgentRoot: "string",
filesAgentVersion: "string",
filesApiKey: "string",
googleCloudStorageAuthenticationMethod: "string",
googleCloudStorageBucket: "string",
googleCloudStorageCredentialsJson: "string",
googleCloudStorageOauthScope: "string",
googleCloudStorageProjectId: "string",
googleCloudStorageS3CompatibleAccessKey: "string",
googleCloudStorageS3CompatibleSecretKey: "string",
hostname: "string",
linodeAccessKey: "string",
linodeBucket: "string",
linodeRegion: "string",
linodeSecretKey: "string",
maxConnections: 0,
name: "string",
oneDriveAccountType: "string",
outboundAgentId: 0,
password: "string",
pinToSiteRegion: false,
port: 0,
privateKey: "string",
privateKeyPassphrase: "string",
remoteServerCredentialId: 0,
resetAuthentication: false,
s3AssumeRoleArn: "string",
s3AssumeRoleDurationSeconds: 0,
s3Bucket: "string",
s3CompatibleAccessKey: "string",
s3CompatibleBucket: "string",
s3CompatibleEndpoint: "string",
s3CompatibleRegion: "string",
s3CompatibleSecretKey: "string",
s3CompatibleVirtualHostedStyle: false,
s3Region: "string",
serverCertificate: "string",
serverHostKey: "string",
serverType: "string",
sharepointClientCertificate: "string",
sharepointClientId: "string",
sharepointClientSecret: "string",
sharepointSiteUrl: "string",
sharepointTenantId: "string",
ssl: "string",
sslCertificate: "string",
uploadStagingPath: "string",
userId: 0,
username: "string",
wasabiAccessKey: "string",
wasabiBucket: "string",
wasabiRegion: "string",
wasabiSecretKey: "string",
workspaceId: 0,
});
type: filescom:RemoteServer
properties:
allowRelativePaths: false
awsAccessKey: string
awsSecretKey: string
azureBlobStorageAccessKey: string
azureBlobStorageAccount: string
azureBlobStorageContainer: string
azureBlobStorageDnsSuffix: string
azureBlobStorageHierarchicalNamespace: false
azureBlobStorageSasToken: string
azureFilesStorageAccessKey: string
azureFilesStorageAccount: string
azureFilesStorageDnsSuffix: string
azureFilesStorageSasToken: string
azureFilesStorageShareName: string
backblazeB2ApplicationKey: string
backblazeB2Bucket: string
backblazeB2KeyId: string
backblazeB2S3Endpoint: string
bufferUploads: string
cloudflareAccessKey: string
cloudflareBucket: string
cloudflareEndpoint: string
cloudflareSecretKey: string
description: string
dropboxTeams: false
enableDedicatedIps: false
filebaseAccessKey: string
filebaseBucket: string
filebaseSecretKey: string
filesAgentPermissionSet: string
filesAgentRoot: string
filesAgentVersion: string
filesApiKey: string
googleCloudStorageAuthenticationMethod: string
googleCloudStorageBucket: string
googleCloudStorageCredentialsJson: string
googleCloudStorageOauthScope: string
googleCloudStorageProjectId: string
googleCloudStorageS3CompatibleAccessKey: string
googleCloudStorageS3CompatibleSecretKey: string
hostname: string
linodeAccessKey: string
linodeBucket: string
linodeRegion: string
linodeSecretKey: string
maxConnections: 0
name: string
oneDriveAccountType: string
outboundAgentId: 0
password: string
pinToSiteRegion: false
port: 0
privateKey: string
privateKeyPassphrase: string
remoteServerCredentialId: 0
resetAuthentication: false
s3AssumeRoleArn: string
s3AssumeRoleDurationSeconds: 0
s3Bucket: string
s3CompatibleAccessKey: string
s3CompatibleBucket: string
s3CompatibleEndpoint: string
s3CompatibleRegion: string
s3CompatibleSecretKey: string
s3CompatibleVirtualHostedStyle: false
s3Region: string
serverCertificate: string
serverHostKey: string
serverType: string
sharepointClientCertificate: string
sharepointClientId: string
sharepointClientSecret: string
sharepointSiteUrl: string
sharepointTenantId: string
ssl: string
sslCertificate: string
uploadStagingPath: string
userId: 0
username: string
wasabiAccessKey: string
wasabiBucket: string
wasabiRegion: string
wasabiSecretKey: string
workspaceId: 0
RemoteServer 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 RemoteServer resource accepts the following input properties:
- Allow
Relative boolPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- Aws
Access stringKey - AWS Access Key.
- Aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- Azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- Azure
Blob stringStorage Account - Azure Blob Storage: Account name
- Azure
Blob stringStorage Container - Azure Blob Storage: Container name
- Azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- Azure
Blob boolStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- Azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- Azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- Azure
Files stringStorage Account - Azure Files: Storage Account name
- Azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- Azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- Backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- Backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- Backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- Backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- Buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- Cloudflare
Access stringKey - Cloudflare: Access Key.
- Cloudflare
Bucket string - Cloudflare: Bucket name
- Cloudflare
Endpoint string - Cloudflare: endpoint
- Cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- Description string
- Internal description for your reference
- Dropbox
Teams bool - Dropbox: If true, list Team folders in root?
- Enable
Dedicated boolIps trueif remote server only accepts connections from dedicated IPs- Filebase
Access stringKey - Filebase: Access Key.
- Filebase
Bucket string - Filebase: Bucket name
- Filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- Files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- Files
Agent stringRoot - Agent local root path
- Files
Agent stringVersion - Files Agent version
- Files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- Google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- Google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- Google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- Google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- Google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- Google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- Google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- Hostname string
- Hostname or IP address
- Linode
Access stringKey - Linode: Access Key
- Linode
Bucket string - Linode: Bucket name
- Linode
Region string - Linode: region
- Linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- Max
Connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- Name string
- Internal name for your reference
- One
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- Outbound
Agent intId - Route traffic to outbound on a files-agent
- Password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- Pin
To boolSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- Port int
- Port for remote server.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- Private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- Remote
Server intCredential Id - ID of Remote Server Credential, if applicable.
- Reset
Authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- S3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- S3Assume
Role intDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- S3Bucket string
- S3 bucket name
- S3Compatible
Access stringKey - S3-compatible: Access Key
- S3Compatible
Bucket string - S3-compatible: Bucket name
- S3Compatible
Endpoint string - S3-compatible: endpoint
- S3Compatible
Region string - S3-compatible: region
- S3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- S3Compatible
Virtual boolHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- S3Region string
- S3 region
- Server
Certificate string - Remote server certificate
- Server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- Server
Type string - Remote server type.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- Ssl string
- Should we require SSL?
- Ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- Upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- User
Id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - Username string
- Remote server username.
- Wasabi
Access stringKey - Wasabi: Access Key.
- Wasabi
Bucket string - Wasabi: Bucket name
- Wasabi
Region string - Wasabi: Region
- Wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- Workspace
Id int - Workspace ID (0 for default workspace)
- Allow
Relative boolPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- Aws
Access stringKey - AWS Access Key.
- Aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- Azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- Azure
Blob stringStorage Account - Azure Blob Storage: Account name
- Azure
Blob stringStorage Container - Azure Blob Storage: Container name
- Azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- Azure
Blob boolStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- Azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- Azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- Azure
Files stringStorage Account - Azure Files: Storage Account name
- Azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- Azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- Backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- Backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- Backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- Backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- Buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- Cloudflare
Access stringKey - Cloudflare: Access Key.
- Cloudflare
Bucket string - Cloudflare: Bucket name
- Cloudflare
Endpoint string - Cloudflare: endpoint
- Cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- Description string
- Internal description for your reference
- Dropbox
Teams bool - Dropbox: If true, list Team folders in root?
- Enable
Dedicated boolIps trueif remote server only accepts connections from dedicated IPs- Filebase
Access stringKey - Filebase: Access Key.
- Filebase
Bucket string - Filebase: Bucket name
- Filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- Files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- Files
Agent stringRoot - Agent local root path
- Files
Agent stringVersion - Files Agent version
- Files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- Google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- Google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- Google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- Google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- Google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- Google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- Google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- Hostname string
- Hostname or IP address
- Linode
Access stringKey - Linode: Access Key
- Linode
Bucket string - Linode: Bucket name
- Linode
Region string - Linode: region
- Linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- Max
Connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- Name string
- Internal name for your reference
- One
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- Outbound
Agent intId - Route traffic to outbound on a files-agent
- Password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- Pin
To boolSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- Port int
- Port for remote server.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- Private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- Remote
Server intCredential Id - ID of Remote Server Credential, if applicable.
- Reset
Authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- S3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- S3Assume
Role intDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- S3Bucket string
- S3 bucket name
- S3Compatible
Access stringKey - S3-compatible: Access Key
- S3Compatible
Bucket string - S3-compatible: Bucket name
- S3Compatible
Endpoint string - S3-compatible: endpoint
- S3Compatible
Region string - S3-compatible: region
- S3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- S3Compatible
Virtual boolHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- S3Region string
- S3 region
- Server
Certificate string - Remote server certificate
- Server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- Server
Type string - Remote server type.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- Ssl string
- Should we require SSL?
- Ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- Upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- User
Id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - Username string
- Remote server username.
- Wasabi
Access stringKey - Wasabi: Access Key.
- Wasabi
Bucket string - Wasabi: Bucket name
- Wasabi
Region string - Wasabi: Region
- Wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- Workspace
Id int - Workspace ID (0 for default workspace)
- allow_
relative_ boolpaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- aws_
access_ stringkey - AWS Access Key.
- aws_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure_
blob_ stringstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure_
blob_ stringstorage_ account - Azure Blob Storage: Account name
- azure_
blob_ stringstorage_ container - Azure Blob Storage: Container name
- azure_
blob_ stringstorage_ dns_ suffix - Azure Blob Storage: Custom DNS suffix
- azure_
blob_ boolstorage_ hierarchical_ namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure_
blob_ stringstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure_
files_ stringstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure_
files_ stringstorage_ account - Azure Files: Storage Account name
- azure_
files_ stringstorage_ dns_ suffix - Azure Files: Custom DNS suffix
- azure_
files_ stringstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- backblaze_
b2_ stringapplication_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze_
b2_ stringbucket - Backblaze B2 Cloud Storage: Bucket name
- backblaze_
b2_ stringkey_ id - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze_
b2_ strings3_ endpoint - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer_
uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare_
access_ stringkey - Cloudflare: Access Key.
- cloudflare_
bucket string - Cloudflare: Bucket name
- cloudflare_
endpoint string - Cloudflare: endpoint
- cloudflare_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description string
- Internal description for your reference
- dropbox_
teams bool - Dropbox: If true, list Team folders in root?
- enable_
dedicated_ boolips trueif remote server only accepts connections from dedicated IPs- filebase_
access_ stringkey - Filebase: Access Key.
- filebase_
bucket string - Filebase: Bucket name
- filebase_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files_
agent_ stringpermission_ set - Local permissions for files agent. read_only, write_only, or read_write
- files_
agent_ stringroot - Agent local root path
- files_
agent_ stringversion - Files Agent version
- files_
api_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- google_
cloud_ stringstorage_ authentication_ method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google_
cloud_ stringstorage_ bucket - Google Cloud Storage: Bucket Name
- google_
cloud_ stringstorage_ credentials_ json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google_
cloud_ stringstorage_ oauth_ scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google_
cloud_ stringstorage_ project_ id - Google Cloud Storage: Project ID
- google_
cloud_ stringstorage_ s3_ compatible_ access_ key - Google Cloud Storage: S3-compatible Access Key.
- google_
cloud_ stringstorage_ s3_ compatible_ secret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname string
- Hostname or IP address
- linode_
access_ stringkey - Linode: Access Key
- linode_
bucket string - Linode: Bucket name
- linode_
region string - Linode: region
- linode_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max_
connections number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name string
- Internal name for your reference
- one_
drive_ stringaccount_ type - OneDrive: Either personal or businessOther account types
- outbound_
agent_ numberid - Route traffic to outbound on a files-agent
- password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin_
to_ boolsite_ region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- port number
- Port for remote server.
- private_
key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private_
key_ stringpassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote_
server_ numbercredential_ id - ID of Remote Server Credential, if applicable.
- reset_
authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3_
assume_ stringrole_ arn - AWS IAM Role ARN for AssumeRole authentication.
- s3_
assume_ numberrole_ duration_ seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3_
bucket string - S3 bucket name
- s3_
compatible_ stringaccess_ key - S3-compatible: Access Key
- s3_
compatible_ stringbucket - S3-compatible: Bucket name
- s3_
compatible_ stringendpoint - S3-compatible: endpoint
- s3_
compatible_ stringregion - S3-compatible: region
- s3_
compatible_ stringsecret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3_
compatible_ boolvirtual_ hosted_ style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3_
region string - S3 region
- server_
certificate string - Remote server certificate
- server_
host_ stringkey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server_
type string - Remote server type.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl string
- Should we require SSL?
- ssl_
certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- upload_
staging_ stringpath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user_
id number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username string
- Remote server username.
- wasabi_
access_ stringkey - Wasabi: Access Key.
- wasabi_
bucket string - Wasabi: Bucket name
- wasabi_
region string - Wasabi: Region
- wasabi_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace_
id number - Workspace ID (0 for default workspace)
- allow
Relative BooleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- aws
Access StringKey - AWS Access Key.
- aws
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob StringStorage Account - Azure Blob Storage: Account name
- azure
Blob StringStorage Container - Azure Blob Storage: Container name
- azure
Blob StringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob BooleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files StringStorage Account - Azure Files: Storage Account name
- azure
Files StringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- String
- Azure Files: Storage Share name
- backblaze
B2Application StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket String - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key StringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint String - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads String - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access StringKey - Cloudflare: Access Key.
- cloudflare
Bucket String - Cloudflare: Bucket name
- cloudflare
Endpoint String - Cloudflare: endpoint
- cloudflare
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description String
- Internal description for your reference
- dropbox
Teams Boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated BooleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access StringKey - Filebase: Access Key.
- filebase
Bucket String - Filebase: Bucket name
- filebase
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent StringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent StringRoot - Agent local root path
- files
Agent StringVersion - Files Agent version
- files
Api StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- google
Cloud StringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud StringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud StringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud StringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud StringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud StringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud StringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname String
- Hostname or IP address
- linode
Access StringKey - Linode: Access Key
- linode
Bucket String - Linode: Bucket name
- linode
Region String - Linode: region
- linode
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections Integer - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name String
- Internal name for your reference
- one
Drive StringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent IntegerId - Route traffic to outbound on a files-agent
- password String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To BooleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- port Integer
- Port for remote server.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key StringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Server IntegerCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication Boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role StringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role IntegerDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Bucket String
- S3 bucket name
- s3Compatible
Access StringKey - S3-compatible: Access Key
- s3Compatible
Bucket String - S3-compatible: Bucket name
- s3Compatible
Endpoint String - S3-compatible: endpoint
- s3Compatible
Region String - S3-compatible: region
- s3Compatible
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual BooleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region String
- S3 region
- server
Certificate String - Remote server certificate
- server
Host StringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type String - Remote server type.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- String
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- String
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- String
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl String
- Should we require SSL?
- ssl
Certificate String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- upload
Staging StringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id Integer - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username String
- Remote server username.
- wasabi
Access StringKey - Wasabi: Access Key.
- wasabi
Bucket String - Wasabi: Bucket name
- wasabi
Region String - Wasabi: Region
- wasabi
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id Integer - Workspace ID (0 for default workspace)
- allow
Relative booleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- aws
Access stringKey - AWS Access Key.
- aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob stringStorage Account - Azure Blob Storage: Account name
- azure
Blob stringStorage Container - Azure Blob Storage: Container name
- azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob booleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files stringStorage Account - Azure Files: Storage Account name
- azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access stringKey - Cloudflare: Access Key.
- cloudflare
Bucket string - Cloudflare: Bucket name
- cloudflare
Endpoint string - Cloudflare: endpoint
- cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description string
- Internal description for your reference
- dropbox
Teams boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated booleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access stringKey - Filebase: Access Key.
- filebase
Bucket string - Filebase: Bucket name
- filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent stringRoot - Agent local root path
- files
Agent stringVersion - Files Agent version
- files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname string
- Hostname or IP address
- linode
Access stringKey - Linode: Access Key
- linode
Bucket string - Linode: Bucket name
- linode
Region string - Linode: region
- linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name string
- Internal name for your reference
- one
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent numberId - Route traffic to outbound on a files-agent
- password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To booleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- port number
- Port for remote server.
- private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Server numberCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role numberDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Bucket string
- S3 bucket name
- s3Compatible
Access stringKey - S3-compatible: Access Key
- s3Compatible
Bucket string - S3-compatible: Bucket name
- s3Compatible
Endpoint string - S3-compatible: endpoint
- s3Compatible
Region string - S3-compatible: region
- s3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual booleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region string
- S3 region
- server
Certificate string - Remote server certificate
- server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type string - Remote server type.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl string
- Should we require SSL?
- ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username string
- Remote server username.
- wasabi
Access stringKey - Wasabi: Access Key.
- wasabi
Bucket string - Wasabi: Bucket name
- wasabi
Region string - Wasabi: Region
- wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id number - Workspace ID (0 for default workspace)
- allow_
relative_ boolpaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- aws_
access_ strkey - AWS Access Key.
- aws_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure_
blob_ strstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure_
blob_ strstorage_ account - Azure Blob Storage: Account name
- azure_
blob_ strstorage_ container - Azure Blob Storage: Container name
- azure_
blob_ strstorage_ dns_ suffix - Azure Blob Storage: Custom DNS suffix
- azure_
blob_ boolstorage_ hierarchical_ namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure_
blob_ strstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure_
files_ strstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure_
files_ strstorage_ account - Azure Files: Storage Account name
- azure_
files_ strstorage_ dns_ suffix - Azure Files: Custom DNS suffix
- azure_
files_ strstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- str
- Azure Files: Storage Share name
- backblaze_
b2_ strapplication_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze_
b2_ strbucket - Backblaze B2 Cloud Storage: Bucket name
- backblaze_
b2_ strkey_ id - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze_
b2_ strs3_ endpoint - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer_
uploads str - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare_
access_ strkey - Cloudflare: Access Key.
- cloudflare_
bucket str - Cloudflare: Bucket name
- cloudflare_
endpoint str - Cloudflare: endpoint
- cloudflare_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description str
- Internal description for your reference
- dropbox_
teams bool - Dropbox: If true, list Team folders in root?
- enable_
dedicated_ boolips trueif remote server only accepts connections from dedicated IPs- filebase_
access_ strkey - Filebase: Access Key.
- filebase_
bucket str - Filebase: Bucket name
- filebase_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files_
agent_ strpermission_ set - Local permissions for files agent. read_only, write_only, or read_write
- files_
agent_ strroot - Agent local root path
- files_
agent_ strversion - Files Agent version
- files_
api_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- google_
cloud_ strstorage_ authentication_ method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google_
cloud_ strstorage_ bucket - Google Cloud Storage: Bucket Name
- google_
cloud_ strstorage_ credentials_ json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google_
cloud_ strstorage_ oauth_ scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google_
cloud_ strstorage_ project_ id - Google Cloud Storage: Project ID
- google_
cloud_ strstorage_ s3_ compatible_ access_ key - Google Cloud Storage: S3-compatible Access Key.
- google_
cloud_ strstorage_ s3_ compatible_ secret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname str
- Hostname or IP address
- linode_
access_ strkey - Linode: Access Key
- linode_
bucket str - Linode: Bucket name
- linode_
region str - Linode: region
- linode_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max_
connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name str
- Internal name for your reference
- one_
drive_ straccount_ type - OneDrive: Either personal or businessOther account types
- outbound_
agent_ intid - Route traffic to outbound on a files-agent
- password str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin_
to_ boolsite_ region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- port int
- Port for remote server.
- private_
key str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private_
key_ strpassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote_
server_ intcredential_ id - ID of Remote Server Credential, if applicable.
- reset_
authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3_
assume_ strrole_ arn - AWS IAM Role ARN for AssumeRole authentication.
- s3_
assume_ introle_ duration_ seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3_
bucket str - S3 bucket name
- s3_
compatible_ straccess_ key - S3-compatible: Access Key
- s3_
compatible_ strbucket - S3-compatible: Bucket name
- s3_
compatible_ strendpoint - S3-compatible: endpoint
- s3_
compatible_ strregion - S3-compatible: region
- s3_
compatible_ strsecret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3_
compatible_ boolvirtual_ hosted_ style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3_
region str - S3 region
- server_
certificate str - Remote server certificate
- server_
host_ strkey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server_
type str - Remote server type.
- str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- str
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- str
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- str
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl str
- Should we require SSL?
- ssl_
certificate str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- upload_
staging_ strpath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user_
id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username str
- Remote server username.
- wasabi_
access_ strkey - Wasabi: Access Key.
- wasabi_
bucket str - Wasabi: Bucket name
- wasabi_
region str - Wasabi: Region
- wasabi_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace_
id int - Workspace ID (0 for default workspace)
- allow
Relative BooleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- aws
Access StringKey - AWS Access Key.
- aws
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob StringStorage Account - Azure Blob Storage: Account name
- azure
Blob StringStorage Container - Azure Blob Storage: Container name
- azure
Blob StringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob BooleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files StringStorage Account - Azure Files: Storage Account name
- azure
Files StringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- String
- Azure Files: Storage Share name
- backblaze
B2Application StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket String - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key StringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint String - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads String - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access StringKey - Cloudflare: Access Key.
- cloudflare
Bucket String - Cloudflare: Bucket name
- cloudflare
Endpoint String - Cloudflare: endpoint
- cloudflare
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description String
- Internal description for your reference
- dropbox
Teams Boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated BooleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access StringKey - Filebase: Access Key.
- filebase
Bucket String - Filebase: Bucket name
- filebase
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent StringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent StringRoot - Agent local root path
- files
Agent StringVersion - Files Agent version
- files
Api StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- google
Cloud StringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud StringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud StringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud StringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud StringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud StringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud StringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname String
- Hostname or IP address
- linode
Access StringKey - Linode: Access Key
- linode
Bucket String - Linode: Bucket name
- linode
Region String - Linode: region
- linode
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections Number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name String
- Internal name for your reference
- one
Drive StringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent NumberId - Route traffic to outbound on a files-agent
- password String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To BooleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- port Number
- Port for remote server.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key StringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Server NumberCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication Boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role StringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role NumberDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Bucket String
- S3 bucket name
- s3Compatible
Access StringKey - S3-compatible: Access Key
- s3Compatible
Bucket String - S3-compatible: Bucket name
- s3Compatible
Endpoint String - S3-compatible: endpoint
- s3Compatible
Region String - S3-compatible: region
- s3Compatible
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual BooleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region String
- S3 region
- server
Certificate String - Remote server certificate
- server
Host StringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type String - Remote server type.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- String
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- String
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- String
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl String
- Should we require SSL?
- ssl
Certificate String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- upload
Staging StringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id Number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username String
- Remote server username.
- wasabi
Access StringKey - Wasabi: Access Key.
- wasabi
Bucket String - Wasabi: Bucket name
- wasabi
Region String - Wasabi: Region
- wasabi
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id Number - Workspace ID (0 for default workspace)
Outputs
All input properties are implicitly available as output properties. Additionally, the RemoteServer resource produces the following output properties:
- Auth
Account stringName - Describes the authorized account
- Auth
Status string - Either
inSetuporcomplete - Authentication
Method string - Type of authentication method to use
- Direct
Transfer boolAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - Disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- Files
Agent stringApi Token - Files Agent API Token
- Files
Agent stringLatest Version - Latest available Files Agent version
- Files
Agent boolSupports Push Updates - Files Agent supports receiving push updates
- Files
Agent boolUp To Date - If true, the Files Agent is up to date.
- Files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pinned
Region string - If set, all communications with this remote server are made through the provided region.
- Remote
Home stringPath - Initial home folder on remote server
- S3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- Supports
Versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- Auth
Account stringName - Describes the authorized account
- Auth
Status string - Either
inSetuporcomplete - Authentication
Method string - Type of authentication method to use
- Direct
Transfer boolAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - Disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- Files
Agent stringApi Token - Files Agent API Token
- Files
Agent stringLatest Version - Latest available Files Agent version
- Files
Agent boolSupports Push Updates - Files Agent supports receiving push updates
- Files
Agent boolUp To Date - If true, the Files Agent is up to date.
- Files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pinned
Region string - If set, all communications with this remote server are made through the provided region.
- Remote
Home stringPath - Initial home folder on remote server
- S3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- Supports
Versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- auth_
account_ stringname - Describes the authorized account
- auth_
status string - Either
inSetuporcomplete - authentication_
method string - Type of authentication method to use
- direct_
transfer_ boolavailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- files_
agent_ stringapi_ token - Files Agent API Token
- files_
agent_ stringlatest_ version - Latest available Files Agent version
- files_
agent_ boolsupports_ push_ updates - Files Agent supports receiving push updates
- files_
agent_ boolup_ to_ date - If true, the Files Agent is up to date.
- files_
api_ stringkey_ prefix - Files.com direct link: paired API key prefix.
- id string
- The provider-assigned unique ID for this managed resource.
- pinned_
region string - If set, all communications with this remote server are made through the provided region.
- remote_
home_ stringpath - Initial home folder on remote server
- s3_
assume_ stringrole_ external_ id - External ID for AssumeRole authentication.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- supports_
versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- auth
Account StringName - Describes the authorized account
- auth
Status String - Either
inSetuporcomplete - authentication
Method String - Type of authentication method to use
- direct
Transfer BooleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled Boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- files
Agent StringApi Token - Files Agent API Token
- files
Agent StringLatest Version - Latest available Files Agent version
- files
Agent BooleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent BooleanUp To Date - If true, the Files Agent is up to date.
- files
Api StringKey Prefix - Files.com direct link: paired API key prefix.
- id String
- The provider-assigned unique ID for this managed resource.
- pinned
Region String - If set, all communications with this remote server are made through the provided region.
- remote
Home StringPath - Initial home folder on remote server
- s3Assume
Role StringExternal Id - External ID for AssumeRole authentication.
- Boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- String
- SharePoint: App-only credential type. Either secret or certificate.
- supports
Versioning Boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- auth
Account stringName - Describes the authorized account
- auth
Status string - Either
inSetuporcomplete - authentication
Method string - Type of authentication method to use
- direct
Transfer booleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- files
Agent stringApi Token - Files Agent API Token
- files
Agent stringLatest Version - Latest available Files Agent version
- files
Agent booleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent booleanUp To Date - If true, the Files Agent is up to date.
- files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- id string
- The provider-assigned unique ID for this managed resource.
- pinned
Region string - If set, all communications with this remote server are made through the provided region.
- remote
Home stringPath - Initial home folder on remote server
- s3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- supports
Versioning boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- auth_
account_ strname - Describes the authorized account
- auth_
status str - Either
inSetuporcomplete - authentication_
method str - Type of authentication method to use
- direct_
transfer_ boolavailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- files_
agent_ strapi_ token - Files Agent API Token
- files_
agent_ strlatest_ version - Latest available Files Agent version
- files_
agent_ boolsupports_ push_ updates - Files Agent supports receiving push updates
- files_
agent_ boolup_ to_ date - If true, the Files Agent is up to date.
- files_
api_ strkey_ prefix - Files.com direct link: paired API key prefix.
- id str
- The provider-assigned unique ID for this managed resource.
- pinned_
region str - If set, all communications with this remote server are made through the provided region.
- remote_
home_ strpath - Initial home folder on remote server
- s3_
assume_ strrole_ external_ id - External ID for AssumeRole authentication.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- str
- SharePoint: App-only credential type. Either secret or certificate.
- supports_
versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- auth
Account StringName - Describes the authorized account
- auth
Status String - Either
inSetuporcomplete - authentication
Method String - Type of authentication method to use
- direct
Transfer BooleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled Boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- files
Agent StringApi Token - Files Agent API Token
- files
Agent StringLatest Version - Latest available Files Agent version
- files
Agent BooleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent BooleanUp To Date - If true, the Files Agent is up to date.
- files
Api StringKey Prefix - Files.com direct link: paired API key prefix.
- id String
- The provider-assigned unique ID for this managed resource.
- pinned
Region String - If set, all communications with this remote server are made through the provided region.
- remote
Home StringPath - Initial home folder on remote server
- s3Assume
Role StringExternal Id - External ID for AssumeRole authentication.
- Boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- String
- SharePoint: App-only credential type. Either secret or certificate.
- supports
Versioning Boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
Look up Existing RemoteServer Resource
Get an existing RemoteServer 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?: RemoteServerState, opts?: CustomResourceOptions): RemoteServer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_relative_paths: Optional[bool] = None,
auth_account_name: Optional[str] = None,
auth_status: Optional[str] = None,
authentication_method: Optional[str] = None,
aws_access_key: Optional[str] = None,
aws_secret_key: Optional[str] = None,
azure_blob_storage_access_key: Optional[str] = None,
azure_blob_storage_account: Optional[str] = None,
azure_blob_storage_container: Optional[str] = None,
azure_blob_storage_dns_suffix: Optional[str] = None,
azure_blob_storage_hierarchical_namespace: Optional[bool] = None,
azure_blob_storage_sas_token: Optional[str] = None,
azure_files_storage_access_key: Optional[str] = None,
azure_files_storage_account: Optional[str] = None,
azure_files_storage_dns_suffix: Optional[str] = None,
azure_files_storage_sas_token: Optional[str] = None,
azure_files_storage_share_name: Optional[str] = None,
backblaze_b2_application_key: Optional[str] = None,
backblaze_b2_bucket: Optional[str] = None,
backblaze_b2_key_id: Optional[str] = None,
backblaze_b2_s3_endpoint: Optional[str] = None,
buffer_uploads: Optional[str] = None,
cloudflare_access_key: Optional[str] = None,
cloudflare_bucket: Optional[str] = None,
cloudflare_endpoint: Optional[str] = None,
cloudflare_secret_key: Optional[str] = None,
description: Optional[str] = None,
direct_transfer_available: Optional[bool] = None,
disabled: Optional[bool] = None,
dropbox_teams: Optional[bool] = None,
enable_dedicated_ips: Optional[bool] = None,
filebase_access_key: Optional[str] = None,
filebase_bucket: Optional[str] = None,
filebase_secret_key: Optional[str] = None,
files_agent_api_token: Optional[str] = None,
files_agent_latest_version: Optional[str] = None,
files_agent_permission_set: Optional[str] = None,
files_agent_root: Optional[str] = None,
files_agent_supports_push_updates: Optional[bool] = None,
files_agent_up_to_date: Optional[bool] = None,
files_agent_version: Optional[str] = None,
files_api_key: Optional[str] = None,
files_api_key_prefix: Optional[str] = None,
google_cloud_storage_authentication_method: Optional[str] = None,
google_cloud_storage_bucket: Optional[str] = None,
google_cloud_storage_credentials_json: Optional[str] = None,
google_cloud_storage_oauth_scope: Optional[str] = None,
google_cloud_storage_project_id: Optional[str] = None,
google_cloud_storage_s3_compatible_access_key: Optional[str] = None,
google_cloud_storage_s3_compatible_secret_key: Optional[str] = None,
hostname: Optional[str] = None,
linode_access_key: Optional[str] = None,
linode_bucket: Optional[str] = None,
linode_region: Optional[str] = None,
linode_secret_key: Optional[str] = None,
max_connections: Optional[int] = None,
name: Optional[str] = None,
one_drive_account_type: Optional[str] = None,
outbound_agent_id: Optional[int] = None,
password: Optional[str] = None,
pin_to_site_region: Optional[bool] = None,
pinned_region: Optional[str] = None,
port: Optional[int] = None,
private_key: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
remote_home_path: Optional[str] = None,
remote_server_credential_id: Optional[int] = None,
reset_authentication: Optional[bool] = None,
s3_assume_role_arn: Optional[str] = None,
s3_assume_role_duration_seconds: Optional[int] = None,
s3_assume_role_external_id: Optional[str] = None,
s3_bucket: Optional[str] = None,
s3_compatible_access_key: Optional[str] = None,
s3_compatible_bucket: Optional[str] = None,
s3_compatible_endpoint: Optional[str] = None,
s3_compatible_region: Optional[str] = None,
s3_compatible_secret_key: Optional[str] = None,
s3_compatible_virtual_hosted_style: Optional[bool] = None,
s3_region: Optional[str] = None,
server_certificate: Optional[str] = None,
server_host_key: Optional[str] = None,
server_type: Optional[str] = None,
sharepoint_app_authentication: Optional[bool] = None,
sharepoint_app_credential_type: Optional[str] = None,
sharepoint_client_certificate: Optional[str] = None,
sharepoint_client_id: Optional[str] = None,
sharepoint_client_secret: Optional[str] = None,
sharepoint_site_url: Optional[str] = None,
sharepoint_tenant_id: Optional[str] = None,
ssl: Optional[str] = None,
ssl_certificate: Optional[str] = None,
supports_versioning: Optional[bool] = None,
upload_staging_path: Optional[str] = None,
user_id: Optional[int] = None,
username: Optional[str] = None,
wasabi_access_key: Optional[str] = None,
wasabi_bucket: Optional[str] = None,
wasabi_region: Optional[str] = None,
wasabi_secret_key: Optional[str] = None,
workspace_id: Optional[int] = None) -> RemoteServerfunc GetRemoteServer(ctx *Context, name string, id IDInput, state *RemoteServerState, opts ...ResourceOption) (*RemoteServer, error)public static RemoteServer Get(string name, Input<string> id, RemoteServerState? state, CustomResourceOptions? opts = null)public static RemoteServer get(String name, Output<String> id, RemoteServerState state, CustomResourceOptions options)resources: _: type: filescom:RemoteServer get: id: ${id}import {
to = filescom_remote_server.example
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.
- Allow
Relative boolPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- Auth
Account stringName - Describes the authorized account
- Auth
Status string - Either
inSetuporcomplete - Authentication
Method string - Type of authentication method to use
- Aws
Access stringKey - AWS Access Key.
- Aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- Azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- Azure
Blob stringStorage Account - Azure Blob Storage: Account name
- Azure
Blob stringStorage Container - Azure Blob Storage: Container name
- Azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- Azure
Blob boolStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- Azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- Azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- Azure
Files stringStorage Account - Azure Files: Storage Account name
- Azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- Azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- Backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- Backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- Backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- Backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- Buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- Cloudflare
Access stringKey - Cloudflare: Access Key.
- Cloudflare
Bucket string - Cloudflare: Bucket name
- Cloudflare
Endpoint string - Cloudflare: endpoint
- Cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- Description string
- Internal description for your reference
- Direct
Transfer boolAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - Disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- Dropbox
Teams bool - Dropbox: If true, list Team folders in root?
- Enable
Dedicated boolIps trueif remote server only accepts connections from dedicated IPs- Filebase
Access stringKey - Filebase: Access Key.
- Filebase
Bucket string - Filebase: Bucket name
- Filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- Files
Agent stringApi Token - Files Agent API Token
- Files
Agent stringLatest Version - Latest available Files Agent version
- Files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- Files
Agent stringRoot - Agent local root path
- Files
Agent boolSupports Push Updates - Files Agent supports receiving push updates
- Files
Agent boolUp To Date - If true, the Files Agent is up to date.
- Files
Agent stringVersion - Files Agent version
- Files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- Files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- Google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- Google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- Google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- Google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- Google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- Google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- Google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- Hostname string
- Hostname or IP address
- Linode
Access stringKey - Linode: Access Key
- Linode
Bucket string - Linode: Bucket name
- Linode
Region string - Linode: region
- Linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- Max
Connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- Name string
- Internal name for your reference
- One
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- Outbound
Agent intId - Route traffic to outbound on a files-agent
- Password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- Pin
To boolSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- Pinned
Region string - If set, all communications with this remote server are made through the provided region.
- Port int
- Port for remote server.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- Private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- Remote
Home stringPath - Initial home folder on remote server
- Remote
Server intCredential Id - ID of Remote Server Credential, if applicable.
- Reset
Authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- S3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- S3Assume
Role intDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- S3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- S3Bucket string
- S3 bucket name
- S3Compatible
Access stringKey - S3-compatible: Access Key
- S3Compatible
Bucket string - S3-compatible: Bucket name
- S3Compatible
Endpoint string - S3-compatible: endpoint
- S3Compatible
Region string - S3-compatible: region
- S3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- S3Compatible
Virtual boolHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- S3Region string
- S3 region
- Server
Certificate string - Remote server certificate
- Server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- Server
Type string - Remote server type.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- Ssl string
- Should we require SSL?
- Ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- Supports
Versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- Upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- User
Id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - Username string
- Remote server username.
- Wasabi
Access stringKey - Wasabi: Access Key.
- Wasabi
Bucket string - Wasabi: Bucket name
- Wasabi
Region string - Wasabi: Region
- Wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- Workspace
Id int - Workspace ID (0 for default workspace)
- Allow
Relative boolPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- Auth
Account stringName - Describes the authorized account
- Auth
Status string - Either
inSetuporcomplete - Authentication
Method string - Type of authentication method to use
- Aws
Access stringKey - AWS Access Key.
- Aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- Azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- Azure
Blob stringStorage Account - Azure Blob Storage: Account name
- Azure
Blob stringStorage Container - Azure Blob Storage: Container name
- Azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- Azure
Blob boolStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- Azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- Azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- Azure
Files stringStorage Account - Azure Files: Storage Account name
- Azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- Azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- Backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- Backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- Backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- Backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- Buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- Cloudflare
Access stringKey - Cloudflare: Access Key.
- Cloudflare
Bucket string - Cloudflare: Bucket name
- Cloudflare
Endpoint string - Cloudflare: endpoint
- Cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- Description string
- Internal description for your reference
- Direct
Transfer boolAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - Disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- Dropbox
Teams bool - Dropbox: If true, list Team folders in root?
- Enable
Dedicated boolIps trueif remote server only accepts connections from dedicated IPs- Filebase
Access stringKey - Filebase: Access Key.
- Filebase
Bucket string - Filebase: Bucket name
- Filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- Files
Agent stringApi Token - Files Agent API Token
- Files
Agent stringLatest Version - Latest available Files Agent version
- Files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- Files
Agent stringRoot - Agent local root path
- Files
Agent boolSupports Push Updates - Files Agent supports receiving push updates
- Files
Agent boolUp To Date - If true, the Files Agent is up to date.
- Files
Agent stringVersion - Files Agent version
- Files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- Files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- Google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- Google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- Google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- Google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- Google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- Google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- Google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- Hostname string
- Hostname or IP address
- Linode
Access stringKey - Linode: Access Key
- Linode
Bucket string - Linode: Bucket name
- Linode
Region string - Linode: region
- Linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- Max
Connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- Name string
- Internal name for your reference
- One
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- Outbound
Agent intId - Route traffic to outbound on a files-agent
- Password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- Pin
To boolSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- Pinned
Region string - If set, all communications with this remote server are made through the provided region.
- Port int
- Port for remote server.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- Private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- Remote
Home stringPath - Initial home folder on remote server
- Remote
Server intCredential Id - ID of Remote Server Credential, if applicable.
- Reset
Authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- S3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- S3Assume
Role intDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- S3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- S3Bucket string
- S3 bucket name
- S3Compatible
Access stringKey - S3-compatible: Access Key
- S3Compatible
Bucket string - S3-compatible: Bucket name
- S3Compatible
Endpoint string - S3-compatible: endpoint
- S3Compatible
Region string - S3-compatible: region
- S3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- S3Compatible
Virtual boolHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- S3Region string
- S3 region
- Server
Certificate string - Remote server certificate
- Server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- Server
Type string - Remote server type.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- Ssl string
- Should we require SSL?
- Ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- Supports
Versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- Upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- User
Id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - Username string
- Remote server username.
- Wasabi
Access stringKey - Wasabi: Access Key.
- Wasabi
Bucket string - Wasabi: Bucket name
- Wasabi
Region string - Wasabi: Region
- Wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- Workspace
Id int - Workspace ID (0 for default workspace)
- allow_
relative_ boolpaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- auth_
account_ stringname - Describes the authorized account
- auth_
status string - Either
inSetuporcomplete - authentication_
method string - Type of authentication method to use
- aws_
access_ stringkey - AWS Access Key.
- aws_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure_
blob_ stringstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure_
blob_ stringstorage_ account - Azure Blob Storage: Account name
- azure_
blob_ stringstorage_ container - Azure Blob Storage: Container name
- azure_
blob_ stringstorage_ dns_ suffix - Azure Blob Storage: Custom DNS suffix
- azure_
blob_ boolstorage_ hierarchical_ namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure_
blob_ stringstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure_
files_ stringstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure_
files_ stringstorage_ account - Azure Files: Storage Account name
- azure_
files_ stringstorage_ dns_ suffix - Azure Files: Custom DNS suffix
- azure_
files_ stringstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- backblaze_
b2_ stringapplication_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze_
b2_ stringbucket - Backblaze B2 Cloud Storage: Bucket name
- backblaze_
b2_ stringkey_ id - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze_
b2_ strings3_ endpoint - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer_
uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare_
access_ stringkey - Cloudflare: Access Key.
- cloudflare_
bucket string - Cloudflare: Bucket name
- cloudflare_
endpoint string - Cloudflare: endpoint
- cloudflare_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description string
- Internal description for your reference
- direct_
transfer_ boolavailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- dropbox_
teams bool - Dropbox: If true, list Team folders in root?
- enable_
dedicated_ boolips trueif remote server only accepts connections from dedicated IPs- filebase_
access_ stringkey - Filebase: Access Key.
- filebase_
bucket string - Filebase: Bucket name
- filebase_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files_
agent_ stringapi_ token - Files Agent API Token
- files_
agent_ stringlatest_ version - Latest available Files Agent version
- files_
agent_ stringpermission_ set - Local permissions for files agent. read_only, write_only, or read_write
- files_
agent_ stringroot - Agent local root path
- files_
agent_ boolsupports_ push_ updates - Files Agent supports receiving push updates
- files_
agent_ boolup_ to_ date - If true, the Files Agent is up to date.
- files_
agent_ stringversion - Files Agent version
- files_
api_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- files_
api_ stringkey_ prefix - Files.com direct link: paired API key prefix.
- google_
cloud_ stringstorage_ authentication_ method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google_
cloud_ stringstorage_ bucket - Google Cloud Storage: Bucket Name
- google_
cloud_ stringstorage_ credentials_ json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google_
cloud_ stringstorage_ oauth_ scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google_
cloud_ stringstorage_ project_ id - Google Cloud Storage: Project ID
- google_
cloud_ stringstorage_ s3_ compatible_ access_ key - Google Cloud Storage: S3-compatible Access Key.
- google_
cloud_ stringstorage_ s3_ compatible_ secret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname string
- Hostname or IP address
- linode_
access_ stringkey - Linode: Access Key
- linode_
bucket string - Linode: Bucket name
- linode_
region string - Linode: region
- linode_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max_
connections number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name string
- Internal name for your reference
- one_
drive_ stringaccount_ type - OneDrive: Either personal or businessOther account types
- outbound_
agent_ numberid - Route traffic to outbound on a files-agent
- password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin_
to_ boolsite_ region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- pinned_
region string - If set, all communications with this remote server are made through the provided region.
- port number
- Port for remote server.
- private_
key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private_
key_ stringpassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote_
home_ stringpath - Initial home folder on remote server
- remote_
server_ numbercredential_ id - ID of Remote Server Credential, if applicable.
- reset_
authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3_
assume_ stringrole_ arn - AWS IAM Role ARN for AssumeRole authentication.
- s3_
assume_ numberrole_ duration_ seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3_
assume_ stringrole_ external_ id - External ID for AssumeRole authentication.
- s3_
bucket string - S3 bucket name
- s3_
compatible_ stringaccess_ key - S3-compatible: Access Key
- s3_
compatible_ stringbucket - S3-compatible: Bucket name
- s3_
compatible_ stringendpoint - S3-compatible: endpoint
- s3_
compatible_ stringregion - S3-compatible: region
- s3_
compatible_ stringsecret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3_
compatible_ boolvirtual_ hosted_ style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3_
region string - S3 region
- server_
certificate string - Remote server certificate
- server_
host_ stringkey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server_
type string - Remote server type.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl string
- Should we require SSL?
- ssl_
certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- supports_
versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- upload_
staging_ stringpath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user_
id number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username string
- Remote server username.
- wasabi_
access_ stringkey - Wasabi: Access Key.
- wasabi_
bucket string - Wasabi: Bucket name
- wasabi_
region string - Wasabi: Region
- wasabi_
secret_ stringkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace_
id number - Workspace ID (0 for default workspace)
- allow
Relative BooleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- auth
Account StringName - Describes the authorized account
- auth
Status String - Either
inSetuporcomplete - authentication
Method String - Type of authentication method to use
- aws
Access StringKey - AWS Access Key.
- aws
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob StringStorage Account - Azure Blob Storage: Account name
- azure
Blob StringStorage Container - Azure Blob Storage: Container name
- azure
Blob StringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob BooleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files StringStorage Account - Azure Files: Storage Account name
- azure
Files StringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- String
- Azure Files: Storage Share name
- backblaze
B2Application StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket String - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key StringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint String - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads String - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access StringKey - Cloudflare: Access Key.
- cloudflare
Bucket String - Cloudflare: Bucket name
- cloudflare
Endpoint String - Cloudflare: endpoint
- cloudflare
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description String
- Internal description for your reference
- direct
Transfer BooleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled Boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- dropbox
Teams Boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated BooleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access StringKey - Filebase: Access Key.
- filebase
Bucket String - Filebase: Bucket name
- filebase
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent StringApi Token - Files Agent API Token
- files
Agent StringLatest Version - Latest available Files Agent version
- files
Agent StringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent StringRoot - Agent local root path
- files
Agent BooleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent BooleanUp To Date - If true, the Files Agent is up to date.
- files
Agent StringVersion - Files Agent version
- files
Api StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- files
Api StringKey Prefix - Files.com direct link: paired API key prefix.
- google
Cloud StringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud StringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud StringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud StringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud StringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud StringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud StringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname String
- Hostname or IP address
- linode
Access StringKey - Linode: Access Key
- linode
Bucket String - Linode: Bucket name
- linode
Region String - Linode: region
- linode
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections Integer - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name String
- Internal name for your reference
- one
Drive StringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent IntegerId - Route traffic to outbound on a files-agent
- password String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To BooleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- pinned
Region String - If set, all communications with this remote server are made through the provided region.
- port Integer
- Port for remote server.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key StringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Home StringPath - Initial home folder on remote server
- remote
Server IntegerCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication Boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role StringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role IntegerDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Assume
Role StringExternal Id - External ID for AssumeRole authentication.
- s3Bucket String
- S3 bucket name
- s3Compatible
Access StringKey - S3-compatible: Access Key
- s3Compatible
Bucket String - S3-compatible: Bucket name
- s3Compatible
Endpoint String - S3-compatible: endpoint
- s3Compatible
Region String - S3-compatible: region
- s3Compatible
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual BooleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region String
- S3 region
- server
Certificate String - Remote server certificate
- server
Host StringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type String - Remote server type.
- Boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- String
- SharePoint: App-only credential type. Either secret or certificate.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- String
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- String
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- String
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl String
- Should we require SSL?
- ssl
Certificate String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- supports
Versioning Boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- upload
Staging StringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id Integer - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username String
- Remote server username.
- wasabi
Access StringKey - Wasabi: Access Key.
- wasabi
Bucket String - Wasabi: Bucket name
- wasabi
Region String - Wasabi: Region
- wasabi
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id Integer - Workspace ID (0 for default workspace)
- allow
Relative booleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- auth
Account stringName - Describes the authorized account
- auth
Status string - Either
inSetuporcomplete - authentication
Method string - Type of authentication method to use
- aws
Access stringKey - AWS Access Key.
- aws
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob stringStorage Account - Azure Blob Storage: Account name
- azure
Blob stringStorage Container - Azure Blob Storage: Container name
- azure
Blob stringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob booleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files stringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files stringStorage Account - Azure Files: Storage Account name
- azure
Files stringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files stringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- string
- Azure Files: Storage Share name
- backblaze
B2Application stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket string - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key stringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint string - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access stringKey - Cloudflare: Access Key.
- cloudflare
Bucket string - Cloudflare: Bucket name
- cloudflare
Endpoint string - Cloudflare: endpoint
- cloudflare
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description string
- Internal description for your reference
- direct
Transfer booleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- dropbox
Teams boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated booleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access stringKey - Filebase: Access Key.
- filebase
Bucket string - Filebase: Bucket name
- filebase
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent stringApi Token - Files Agent API Token
- files
Agent stringLatest Version - Latest available Files Agent version
- files
Agent stringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent stringRoot - Agent local root path
- files
Agent booleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent booleanUp To Date - If true, the Files Agent is up to date.
- files
Agent stringVersion - Files Agent version
- files
Api stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- files
Api stringKey Prefix - Files.com direct link: paired API key prefix.
- google
Cloud stringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud stringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud stringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud stringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud stringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud stringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud stringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname string
- Hostname or IP address
- linode
Access stringKey - Linode: Access Key
- linode
Bucket string - Linode: Bucket name
- linode
Region string - Linode: region
- linode
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name string
- Internal name for your reference
- one
Drive stringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent numberId - Route traffic to outbound on a files-agent
- password string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To booleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- pinned
Region string - If set, all communications with this remote server are made through the provided region.
- port number
- Port for remote server.
- private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key stringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Home stringPath - Initial home folder on remote server
- remote
Server numberCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role stringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role numberDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Assume
Role stringExternal Id - External ID for AssumeRole authentication.
- s3Bucket string
- S3 bucket name
- s3Compatible
Access stringKey - S3-compatible: Access Key
- s3Compatible
Bucket string - S3-compatible: Bucket name
- s3Compatible
Endpoint string - S3-compatible: endpoint
- s3Compatible
Region string - S3-compatible: region
- s3Compatible
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual booleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region string
- S3 region
- server
Certificate string - Remote server certificate
- server
Host stringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type string - Remote server type.
- boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- string
- SharePoint: App-only credential type. Either secret or certificate.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- string
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- string
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- string
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl string
- Should we require SSL?
- ssl
Certificate string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- supports
Versioning boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- upload
Staging stringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username string
- Remote server username.
- wasabi
Access stringKey - Wasabi: Access Key.
- wasabi
Bucket string - Wasabi: Bucket name
- wasabi
Region string - Wasabi: Region
- wasabi
Secret stringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id number - Workspace ID (0 for default workspace)
- allow_
relative_ boolpaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- auth_
account_ strname - Describes the authorized account
- auth_
status str - Either
inSetuporcomplete - authentication_
method str - Type of authentication method to use
- aws_
access_ strkey - AWS Access Key.
- aws_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure_
blob_ strstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure_
blob_ strstorage_ account - Azure Blob Storage: Account name
- azure_
blob_ strstorage_ container - Azure Blob Storage: Container name
- azure_
blob_ strstorage_ dns_ suffix - Azure Blob Storage: Custom DNS suffix
- azure_
blob_ boolstorage_ hierarchical_ namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure_
blob_ strstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure_
files_ strstorage_ access_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure_
files_ strstorage_ account - Azure Files: Storage Account name
- azure_
files_ strstorage_ dns_ suffix - Azure Files: Custom DNS suffix
- azure_
files_ strstorage_ sas_ token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- str
- Azure Files: Storage Share name
- backblaze_
b2_ strapplication_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze_
b2_ strbucket - Backblaze B2 Cloud Storage: Bucket name
- backblaze_
b2_ strkey_ id - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze_
b2_ strs3_ endpoint - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer_
uploads str - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare_
access_ strkey - Cloudflare: Access Key.
- cloudflare_
bucket str - Cloudflare: Bucket name
- cloudflare_
endpoint str - Cloudflare: endpoint
- cloudflare_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description str
- Internal description for your reference
- direct_
transfer_ boolavailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled bool
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- dropbox_
teams bool - Dropbox: If true, list Team folders in root?
- enable_
dedicated_ boolips trueif remote server only accepts connections from dedicated IPs- filebase_
access_ strkey - Filebase: Access Key.
- filebase_
bucket str - Filebase: Bucket name
- filebase_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files_
agent_ strapi_ token - Files Agent API Token
- files_
agent_ strlatest_ version - Latest available Files Agent version
- files_
agent_ strpermission_ set - Local permissions for files agent. read_only, write_only, or read_write
- files_
agent_ strroot - Agent local root path
- files_
agent_ boolsupports_ push_ updates - Files Agent supports receiving push updates
- files_
agent_ boolup_ to_ date - If true, the Files Agent is up to date.
- files_
agent_ strversion - Files Agent version
- files_
api_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- files_
api_ strkey_ prefix - Files.com direct link: paired API key prefix.
- google_
cloud_ strstorage_ authentication_ method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google_
cloud_ strstorage_ bucket - Google Cloud Storage: Bucket Name
- google_
cloud_ strstorage_ credentials_ json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google_
cloud_ strstorage_ oauth_ scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google_
cloud_ strstorage_ project_ id - Google Cloud Storage: Project ID
- google_
cloud_ strstorage_ s3_ compatible_ access_ key - Google Cloud Storage: S3-compatible Access Key.
- google_
cloud_ strstorage_ s3_ compatible_ secret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname str
- Hostname or IP address
- linode_
access_ strkey - Linode: Access Key
- linode_
bucket str - Linode: Bucket name
- linode_
region str - Linode: region
- linode_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max_
connections int - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name str
- Internal name for your reference
- one_
drive_ straccount_ type - OneDrive: Either personal or businessOther account types
- outbound_
agent_ intid - Route traffic to outbound on a files-agent
- password str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin_
to_ boolsite_ region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- pinned_
region str - If set, all communications with this remote server are made through the provided region.
- port int
- Port for remote server.
- private_
key str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private_
key_ strpassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote_
home_ strpath - Initial home folder on remote server
- remote_
server_ intcredential_ id - ID of Remote Server Credential, if applicable.
- reset_
authentication bool - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3_
assume_ strrole_ arn - AWS IAM Role ARN for AssumeRole authentication.
- s3_
assume_ introle_ duration_ seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3_
assume_ strrole_ external_ id - External ID for AssumeRole authentication.
- s3_
bucket str - S3 bucket name
- s3_
compatible_ straccess_ key - S3-compatible: Access Key
- s3_
compatible_ strbucket - S3-compatible: Bucket name
- s3_
compatible_ strendpoint - S3-compatible: endpoint
- s3_
compatible_ strregion - S3-compatible: region
- s3_
compatible_ strsecret_ key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3_
compatible_ boolvirtual_ hosted_ style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3_
region str - S3 region
- server_
certificate str - Remote server certificate
- server_
host_ strkey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server_
type str - Remote server type.
- bool
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- str
- SharePoint: App-only credential type. Either secret or certificate.
- str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- str
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- str
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- str
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl str
- Should we require SSL?
- ssl_
certificate str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- supports_
versioning bool - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- upload_
staging_ strpath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user_
id int - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username str
- Remote server username.
- wasabi_
access_ strkey - Wasabi: Access Key.
- wasabi_
bucket str - Wasabi: Bucket name
- wasabi_
region str - Wasabi: Region
- wasabi_
secret_ strkey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace_
id int - Workspace ID (0 for default workspace)
- allow
Relative BooleanPaths - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
- auth
Account StringName - Describes the authorized account
- auth
Status String - Either
inSetuporcomplete - authentication
Method String - Type of authentication method to use
- aws
Access StringKey - AWS Access Key.
- aws
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. AWS: secret key.
- azure
Blob StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Access Key
- azure
Blob StringStorage Account - Azure Blob Storage: Account name
- azure
Blob StringStorage Container - Azure Blob Storage: Container name
- azure
Blob StringStorage Dns Suffix - Azure Blob Storage: Custom DNS suffix
- azure
Blob BooleanStorage Hierarchical Namespace - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
- azure
Blob StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure Blob Storage: Shared Access Signature (SAS) token
- azure
Files StringStorage Access Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Access Key
- azure
Files StringStorage Account - Azure Files: Storage Account name
- azure
Files StringStorage Dns Suffix - Azure Files: Custom DNS suffix
- azure
Files StringStorage Sas Token - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Azure File Storage: Shared Access Signature (SAS) token
- String
- Azure Files: Storage Share name
- backblaze
B2Application StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: applicationKey
- backblaze
B2Bucket String - Backblaze B2 Cloud Storage: Bucket name
- backblaze
B2Key StringId - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Backblaze B2 Cloud Storage: keyID
- backblaze
B2S3Endpoint String - Backblaze B2 Cloud Storage: S3 Endpoint
- buffer
Uploads String - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
- cloudflare
Access StringKey - Cloudflare: Access Key.
- cloudflare
Bucket String - Cloudflare: Bucket name
- cloudflare
Endpoint String - Cloudflare: endpoint
- cloudflare
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Cloudflare: Secret Key
- description String
- Internal description for your reference
- direct
Transfer BooleanAvailable - Whether the Files Agent Proxy recently validated a direct transfer connection.
truemeans a direct connection was recently validated (actual availability can vary by client network),falsemeans direct transfers are enabled but not currently available, andnullmeans direct transfers are disabled or unsupported. Only provided for a connected Files Agent when showing a single Remote Server. - disabled Boolean
- If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
- dropbox
Teams Boolean - Dropbox: If true, list Team folders in root?
- enable
Dedicated BooleanIps trueif remote server only accepts connections from dedicated IPs- filebase
Access StringKey - Filebase: Access Key.
- filebase
Bucket String - Filebase: Bucket name
- filebase
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Filebase: Secret Key
- files
Agent StringApi Token - Files Agent API Token
- files
Agent StringLatest Version - Latest available Files Agent version
- files
Agent StringPermission Set - Local permissions for files agent. read_only, write_only, or read_write
- files
Agent StringRoot - Agent local root path
- files
Agent BooleanSupports Push Updates - Files Agent supports receiving push updates
- files
Agent BooleanUp To Date - If true, the Files Agent is up to date.
- files
Agent StringVersion - Files Agent version
- files
Api StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Files.com direct link: API key used once to pair the remote server.
- files
Api StringKey Prefix - Files.com direct link: paired API key prefix.
- google
Cloud StringStorage Authentication Method - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
- google
Cloud StringStorage Bucket - Google Cloud Storage: Bucket Name
- google
Cloud StringStorage Credentials Json - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
- google
Cloud StringStorage Oauth Scope - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
- google
Cloud StringStorage Project Id - Google Cloud Storage: Project ID
- google
Cloud StringStorage S3Compatible Access Key - Google Cloud Storage: S3-compatible Access Key.
- google
Cloud StringStorage S3Compatible Secret Key - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Google Cloud Storage: S3-compatible secret key
- hostname String
- Hostname or IP address
- linode
Access StringKey - Linode: Access Key
- linode
Bucket String - Linode: Bucket name
- linode
Region String - Linode: region
- linode
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Linode: Secret Key
- max
Connections Number - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
- name String
- Internal name for your reference
- one
Drive StringAccount Type - OneDrive: Either personal or businessOther account types
- outbound
Agent NumberId - Route traffic to outbound on a files-agent
- password String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password, if needed.
- pin
To BooleanSite Region - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
- pinned
Region String - If set, all communications with this remote server are made through the provided region.
- port Number
- Port for remote server.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Private key, if needed.
- private
Key StringPassphrase - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Passphrase for private key if needed.
- remote
Home StringPath - Initial home folder on remote server
- remote
Server NumberCredential Id - ID of Remote Server Credential, if applicable.
- reset
Authentication Boolean - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Reset authenticated account?
- s3Assume
Role StringArn - AWS IAM Role ARN for AssumeRole authentication.
- s3Assume
Role NumberDuration Seconds - Session duration in seconds for AssumeRole authentication (900-43200).
- s3Assume
Role StringExternal Id - External ID for AssumeRole authentication.
- s3Bucket String
- S3 bucket name
- s3Compatible
Access StringKey - S3-compatible: Access Key
- s3Compatible
Bucket String - S3-compatible: Bucket name
- s3Compatible
Endpoint String - S3-compatible: endpoint
- s3Compatible
Region String - S3-compatible: region
- s3Compatible
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. S3-compatible: Secret Key
- s3Compatible
Virtual BooleanHosted Style - S3-compatible: If true, use virtual-hosted-style URLs instead of path-style URLs
- s3Region String
- S3 region
- server
Certificate String - Remote server certificate
- server
Host StringKey - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
- server
Type String - Remote server type.
- Boolean
- SharePoint: If true, this remote server uses Microsoft Entra app-only authentication.
- String
- SharePoint: App-only credential type. Either secret or certificate.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
- String
- SharePoint: Microsoft Entra application client ID for app-only authentication.
- String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. SharePoint: Microsoft Entra application client secret for app-only authentication.
- String
- SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
- String
- SharePoint: Microsoft Entra tenant ID for app-only authentication.
- ssl String
- Should we require SSL?
- ssl
Certificate String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. SSL client certificate.
- supports
Versioning Boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.
- upload
Staging StringPath - Upload staging path. Applies to SFTP only. If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command. This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
- user
Id Number - NOTE: This field is write-only and its value will not be updated in state as part of read operations.
User ID. Provide a value of
0to operate the current session's user. - username String
- Remote server username.
- wasabi
Access StringKey - Wasabi: Access Key.
- wasabi
Bucket String - Wasabi: Bucket name
- wasabi
Region String - Wasabi: Region
- wasabi
Secret StringKey - NOTE: This field is write-only and its value will not be updated in state as part of read operations. Wasabi: Secret Key
- workspace
Id Number - Workspace ID (0 for default workspace)
Import
The pulumi import command can be used, for example:
Remote Servers can be imported by specifying the id.
$ pulumi import filescom:index/remoteServer:RemoteServer example_remote_server 1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- filescom jschady/pulumi-filescom
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
filescomTerraform Provider.
published on Thursday, Aug 20, 2026 by jschady