Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. Sync
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.Sync

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Sync represents a file synchronization job between two locations (local-remote, remote-remote, local-child_site, etc).

    It can be scheduled, run manually, or triggered by custom logic.

    Syncs track their runs, status, and configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleSync = new filescom.Sync("example_sync", {
    deleteEmptyFolders: true,
    description: "example",
    destPath: "example",
    destRemoteServerId: 1,
    disabled: true,
    excludePatterns: ["example"],
    holidayRegion: "us_dc",
    includePatterns: ["example"],
    interval: "week",
    keepAfterCopy: true,
    name: "example",
    recurringDay: 25,
    recurringDays: [
        1,
        15,
    ],
    scheduleId: 1,
    scheduleDaysOfWeeks: [
        0,
        2,
        4,
    ],
    scheduleTimeZone: "Eastern Time (US & Canada)",
    scheduleTimesOfDays: [
        "06:30",
        "14:30",
    ],
    srcPath: "example",
    srcRemoteServerId: 1,
    syncIntervalMinutes: 1,
    trigger: "example",
    triggerFile: "example",
    alwaysWriteTriggerFile: true,
    workspaceId: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_sync = filescom.Sync("example_sync",
    delete_empty_folders=True,
    description="example",
    dest_path="example",
    dest_remote_server_id=1,
    disabled=True,
    exclude_patterns=["example"],
    holiday_region="us_dc",
    include_patterns=["example"],
    interval="week",
    keep_after_copy=True,
    name="example",
    recurring_day=25,
    recurring_days=[
        1,
        15,
    ],
    schedule_id=1,
    schedule_days_of_weeks=[
        0,
        2,
        4,
    ],
    schedule_time_zone="Eastern Time (US & Canada)",
    schedule_times_of_days=[
        "06:30",
        "14:30",
    ],
    src_path="example",
    src_remote_server_id=1,
    sync_interval_minutes=1,
    trigger="example",
    trigger_file="example",
    always_write_trigger_file=True,
    workspace_id=1)

    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.NewSync(ctx, "example_sync", &filescom.SyncArgs{
			DeleteEmptyFolders: pulumi.Bool(true),
			Description:        pulumi.String("example"),
			DestPath:           pulumi.String("example"),
			DestRemoteServerId: pulumi.Int(1),
			Disabled:           pulumi.Bool(true),
			ExcludePatterns: pulumi.StringArray{
				pulumi.String("example"),
			},
			HolidayRegion: pulumi.String("us_dc"),
			IncludePatterns: pulumi.StringArray{
				pulumi.String("example"),
			},
			Interval:      pulumi.String("week"),
			KeepAfterCopy: pulumi.Bool(true),
			Name:          pulumi.String("example"),
			RecurringDay:  pulumi.Int(25),
			RecurringDays: pulumi.IntArray{
				pulumi.Int(1),
				pulumi.Int(15),
			},
			ScheduleId: pulumi.Int(1),
			ScheduleDaysOfWeeks: pulumi.IntArray{
				pulumi.Int(0),
				pulumi.Int(2),
				pulumi.Int(4),
			},
			ScheduleTimeZone: pulumi.String("Eastern Time (US & Canada)"),
			ScheduleTimesOfDays: pulumi.StringArray{
				pulumi.String("06:30"),
				pulumi.String("14:30"),
			},
			SrcPath:                pulumi.String("example"),
			SrcRemoteServerId:      pulumi.Int(1),
			SyncIntervalMinutes:    pulumi.Int(1),
			Trigger:                pulumi.String("example"),
			TriggerFile:            pulumi.String("example"),
			AlwaysWriteTriggerFile: pulumi.Bool(true),
			WorkspaceId:            pulumi.Int(1),
		})
		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 exampleSync = new Filescom.Sync("example_sync", new()
    {
        DeleteEmptyFolders = true,
        Description = "example",
        DestPath = "example",
        DestRemoteServerId = 1,
        Disabled = true,
        ExcludePatterns = new[]
        {
            "example",
        },
        HolidayRegion = "us_dc",
        IncludePatterns = new[]
        {
            "example",
        },
        Interval = "week",
        KeepAfterCopy = true,
        Name = "example",
        RecurringDay = 25,
        RecurringDays = new[]
        {
            1,
            15,
        },
        ScheduleId = 1,
        ScheduleDaysOfWeeks = new[]
        {
            0,
            2,
            4,
        },
        ScheduleTimeZone = "Eastern Time (US & Canada)",
        ScheduleTimesOfDays = new[]
        {
            "06:30",
            "14:30",
        },
        SrcPath = "example",
        SrcRemoteServerId = 1,
        SyncIntervalMinutes = 1,
        Trigger = "example",
        TriggerFile = "example",
        AlwaysWriteTriggerFile = true,
        WorkspaceId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.Sync;
import com.pulumi.filescom.SyncArgs;
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 exampleSync = new Sync("exampleSync", SyncArgs.builder()
            .deleteEmptyFolders(true)
            .description("example")
            .destPath("example")
            .destRemoteServerId(1)
            .disabled(true)
            .excludePatterns("example")
            .holidayRegion("us_dc")
            .includePatterns("example")
            .interval("week")
            .keepAfterCopy(true)
            .name("example")
            .recurringDay(25)
            .recurringDays(            
                1,
                15)
            .scheduleId(1)
            .scheduleDaysOfWeeks(            
                0,
                2,
                4)
            .scheduleTimeZone("Eastern Time (US & Canada)")
            .scheduleTimesOfDays(            
                "06:30",
                "14:30")
            .srcPath("example")
            .srcRemoteServerId(1)
            .syncIntervalMinutes(1)
            .trigger("example")
            .triggerFile("example")
            .alwaysWriteTriggerFile(true)
            .workspaceId(1)
            .build());

    }
}

    resources:
  exampleSync:
    type: filescom:Sync
    name: example_sync
    properties:
      deleteEmptyFolders: true
      description: example
      destPath: example
      destRemoteServerId: 1
      disabled: true
      excludePatterns:
        - example
      holidayRegion: us_dc
      includePatterns:
        - example
      interval: week
      keepAfterCopy: true
      name: example
      recurringDay: 25
      recurringDays:
        - 1
        - 15
      scheduleId: 1
      scheduleDaysOfWeeks:
        - 0
        - 2
        - 4
      scheduleTimeZone: Eastern Time (US & Canada)
      scheduleTimesOfDays:
        - 06:30
        - 14:30
      srcPath: example
      srcRemoteServerId: 1
      syncIntervalMinutes: 1
      trigger: example
      triggerFile: example
      alwaysWriteTriggerFile: true
      workspaceId: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_sync" "example_sync" {
  delete_empty_folders      = true
  description               = "example"
  dest_path                 = "example"
  dest_remote_server_id     = 1
  disabled                  = true
  exclude_patterns          = ["example"]
  holiday_region            = "us_dc"
  include_patterns          = ["example"]
  interval                  = "week"
  keep_after_copy           = true
  name                      = "example"
  recurring_day             = 25
  recurring_days            = [1, 15]
  schedule_id               = 1
  schedule_days_of_weeks    = [0, 2, 4]
  schedule_time_zone        = "Eastern Time (US & Canada)"
  schedule_times_of_days    = ["06:30", "14:30"]
  src_path                  = "example"
  src_remote_server_id      = 1
  sync_interval_minutes     = 1
  trigger                   = "example"
  trigger_file              = "example"
  always_write_trigger_file = true
  workspace_id              = 1
}

    Create Sync Resource

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

    Constructor syntax

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

@overload
def Sync(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         always_write_trigger_file: Optional[bool] = None,
         delete_empty_folders: Optional[bool] = None,
         description: Optional[str] = None,
         dest_path: Optional[str] = None,
         dest_remote_server_id: Optional[int] = None,
         disabled: Optional[bool] = None,
         exclude_patterns: Optional[Sequence[str]] = None,
         holiday_region: Optional[str] = None,
         include_patterns: Optional[Sequence[str]] = None,
         interval: Optional[str] = None,
         keep_after_copy: Optional[bool] = None,
         name: Optional[str] = None,
         recurring_day: Optional[int] = None,
         recurring_days: Optional[Sequence[int]] = None,
         schedule_days_of_weeks: Optional[Sequence[int]] = None,
         schedule_id: Optional[int] = None,
         schedule_time_zone: Optional[str] = None,
         schedule_times_of_days: Optional[Sequence[str]] = None,
         src_path: Optional[str] = None,
         src_remote_server_id: Optional[int] = None,
         sync_interval_minutes: Optional[int] = None,
         trigger: Optional[str] = None,
         trigger_file: Optional[str] = None,
         workspace_id: Optional[int] = None)
    func NewSync(ctx *Context, name string, args *SyncArgs, opts ...ResourceOption) (*Sync, error)
    public Sync(string name, SyncArgs? args = null, CustomResourceOptions? opts = null)
    public Sync(String name, SyncArgs args)
public Sync(String name, SyncArgs args, CustomResourceOptions options)

    type: filescom:Sync
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_sync" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SyncArgs
    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 SyncArgs
    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 SyncArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyncArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyncArgs
    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 syncResource = new Filescom.Sync("syncResource", new()
{
    AlwaysWriteTriggerFile = false,
    DeleteEmptyFolders = false,
    Description = "string",
    DestPath = "string",
    DestRemoteServerId = 0,
    Disabled = false,
    ExcludePatterns = new[]
    {
        "string",
    },
    HolidayRegion = "string",
    IncludePatterns = new[]
    {
        "string",
    },
    Interval = "string",
    KeepAfterCopy = false,
    Name = "string",
    RecurringDay = 0,
    RecurringDays = new[]
    {
        0,
    },
    ScheduleDaysOfWeeks = new[]
    {
        0,
    },
    ScheduleId = 0,
    ScheduleTimeZone = "string",
    ScheduleTimesOfDays = new[]
    {
        "string",
    },
    SrcPath = "string",
    SrcRemoteServerId = 0,
    SyncIntervalMinutes = 0,
    Trigger = "string",
    TriggerFile = "string",
    WorkspaceId = 0,
});

    example, err := filescom.NewSync(ctx, "syncResource", &filescom.SyncArgs{
	AlwaysWriteTriggerFile: pulumi.Bool(false),
	DeleteEmptyFolders:     pulumi.Bool(false),
	Description:            pulumi.String("string"),
	DestPath:               pulumi.String("string"),
	DestRemoteServerId:     pulumi.Int(0),
	Disabled:               pulumi.Bool(false),
	ExcludePatterns: pulumi.StringArray{
		pulumi.String("string"),
	},
	HolidayRegion: pulumi.String("string"),
	IncludePatterns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Interval:      pulumi.String("string"),
	KeepAfterCopy: pulumi.Bool(false),
	Name:          pulumi.String("string"),
	RecurringDay:  pulumi.Int(0),
	RecurringDays: pulumi.IntArray{
		pulumi.Int(0),
	},
	ScheduleDaysOfWeeks: pulumi.IntArray{
		pulumi.Int(0),
	},
	ScheduleId:       pulumi.Int(0),
	ScheduleTimeZone: pulumi.String("string"),
	ScheduleTimesOfDays: pulumi.StringArray{
		pulumi.String("string"),
	},
	SrcPath:             pulumi.String("string"),
	SrcRemoteServerId:   pulumi.Int(0),
	SyncIntervalMinutes: pulumi.Int(0),
	Trigger:             pulumi.String("string"),
	TriggerFile:         pulumi.String("string"),
	WorkspaceId:         pulumi.Int(0),
})

    resource "filescom_sync" "syncResource" {
  lifecycle {
    create_before_destroy = true
  }
  always_write_trigger_file = false
  delete_empty_folders      = false
  description               = "string"
  dest_path                 = "string"
  dest_remote_server_id     = 0
  disabled                  = false
  exclude_patterns          = ["string"]
  holiday_region            = "string"
  include_patterns          = ["string"]
  interval                  = "string"
  keep_after_copy           = false
  name                      = "string"
  recurring_day             = 0
  recurring_days            = [0]
  schedule_days_of_weeks    = [0]
  schedule_id               = 0
  schedule_time_zone        = "string"
  schedule_times_of_days    = ["string"]
  src_path                  = "string"
  src_remote_server_id      = 0
  sync_interval_minutes     = 0
  trigger                   = "string"
  trigger_file              = "string"
  workspace_id              = 0
}

    var syncResource = new Sync("syncResource", SyncArgs.builder()
    .alwaysWriteTriggerFile(false)
    .deleteEmptyFolders(false)
    .description("string")
    .destPath("string")
    .destRemoteServerId(0)
    .disabled(false)
    .excludePatterns("string")
    .holidayRegion("string")
    .includePatterns("string")
    .interval("string")
    .keepAfterCopy(false)
    .name("string")
    .recurringDay(0)
    .recurringDays(0)
    .scheduleDaysOfWeeks(0)
    .scheduleId(0)
    .scheduleTimeZone("string")
    .scheduleTimesOfDays("string")
    .srcPath("string")
    .srcRemoteServerId(0)
    .syncIntervalMinutes(0)
    .trigger("string")
    .triggerFile("string")
    .workspaceId(0)
    .build());

    sync_resource = filescom.Sync("syncResource",
    always_write_trigger_file=False,
    delete_empty_folders=False,
    description="string",
    dest_path="string",
    dest_remote_server_id=0,
    disabled=False,
    exclude_patterns=["string"],
    holiday_region="string",
    include_patterns=["string"],
    interval="string",
    keep_after_copy=False,
    name="string",
    recurring_day=0,
    recurring_days=[0],
    schedule_days_of_weeks=[0],
    schedule_id=0,
    schedule_time_zone="string",
    schedule_times_of_days=["string"],
    src_path="string",
    src_remote_server_id=0,
    sync_interval_minutes=0,
    trigger="string",
    trigger_file="string",
    workspace_id=0)

    const syncResource = new filescom.Sync("syncResource", {
    alwaysWriteTriggerFile: false,
    deleteEmptyFolders: false,
    description: "string",
    destPath: "string",
    destRemoteServerId: 0,
    disabled: false,
    excludePatterns: ["string"],
    holidayRegion: "string",
    includePatterns: ["string"],
    interval: "string",
    keepAfterCopy: false,
    name: "string",
    recurringDay: 0,
    recurringDays: [0],
    scheduleDaysOfWeeks: [0],
    scheduleId: 0,
    scheduleTimeZone: "string",
    scheduleTimesOfDays: ["string"],
    srcPath: "string",
    srcRemoteServerId: 0,
    syncIntervalMinutes: 0,
    trigger: "string",
    triggerFile: "string",
    workspaceId: 0,
});

    type: filescom:Sync
properties:
    alwaysWriteTriggerFile: false
    deleteEmptyFolders: false
    description: string
    destPath: string
    destRemoteServerId: 0
    disabled: false
    excludePatterns:
        - string
    holidayRegion: string
    includePatterns:
        - string
    interval: string
    keepAfterCopy: false
    name: string
    recurringDay: 0
    recurringDays:
        - 0
    scheduleDaysOfWeeks:
        - 0
    scheduleId: 0
    scheduleTimeZone: string
    scheduleTimesOfDays:
        - string
    srcPath: string
    srcRemoteServerId: 0
    syncIntervalMinutes: 0
    trigger: string
    triggerFile: string
    workspaceId: 0

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

    AlwaysWriteTriggerFile bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    DeleteEmptyFolders bool
    Delete empty folders after sync?
    Description string
    Description for this sync job
    DestPath string
    Absolute destination path for the sync
    DestRemoteServerId int
    Remote server ID for the destination (if remote)
    Disabled bool
    Is this sync disabled?
    ExcludePatterns List<string>
    Array of glob patterns to exclude
    HolidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    IncludePatterns List<string>
    Array of glob patterns to include
    Interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    KeepAfterCopy bool
    Keep files after copying?
    Name string
    Name for this sync job
    RecurringDay int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    RecurringDays List<int>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    ScheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays List<string>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    SrcPath string
    Absolute source path for the sync
    SrcRemoteServerId int
    Remote server ID for the source (if remote)
    SyncIntervalMinutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    Trigger string
    Trigger type: daily, custom_schedule, or manual
    TriggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    WorkspaceId int
    Workspace ID this sync belongs to
    AlwaysWriteTriggerFile bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    DeleteEmptyFolders bool
    Delete empty folders after sync?
    Description string
    Description for this sync job
    DestPath string
    Absolute destination path for the sync
    DestRemoteServerId int
    Remote server ID for the destination (if remote)
    Disabled bool
    Is this sync disabled?
    ExcludePatterns []string
    Array of glob patterns to exclude
    HolidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    IncludePatterns []string
    Array of glob patterns to include
    Interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    KeepAfterCopy bool
    Keep files after copying?
    Name string
    Name for this sync job
    RecurringDay int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    RecurringDays []int
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    ScheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays []string
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    SrcPath string
    Absolute source path for the sync
    SrcRemoteServerId int
    Remote server ID for the source (if remote)
    SyncIntervalMinutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    Trigger string
    Trigger type: daily, custom_schedule, or manual
    TriggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    WorkspaceId int
    Workspace ID this sync belongs to
    always_write_trigger_file bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    delete_empty_folders bool
    Delete empty folders after sync?
    description string
    Description for this sync job
    dest_path string
    Absolute destination path for the sync
    dest_remote_server_id number
    Remote server ID for the destination (if remote)
    disabled bool
    Is this sync disabled?
    exclude_patterns list(string)
    Array of glob patterns to exclude
    holiday_region string
    Skip the sync if there is a formal, observed holiday for this region.
    include_patterns list(string)
    Array of glob patterns to include
    interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keep_after_copy bool
    Keep files after copying?
    name string
    Name for this sync job
    recurring_day number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurring_days list(number)
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    schedule_time_zone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    schedule_times_of_days list(string)
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    src_path string
    Absolute source path for the sync
    src_remote_server_id number
    Remote server ID for the source (if remote)
    sync_interval_minutes number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger string
    Trigger type: daily, custom_schedule, or manual
    trigger_file string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    workspace_id number
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile Boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    deleteEmptyFolders Boolean
    Delete empty folders after sync?
    description String
    Description for this sync job
    destPath String
    Absolute destination path for the sync
    destRemoteServerId Integer
    Remote server ID for the destination (if remote)
    disabled Boolean
    Is this sync disabled?
    excludePatterns List<String>
    Array of glob patterns to exclude
    holidayRegion String
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns List<String>
    Array of glob patterns to include
    interval String
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy Boolean
    Keep files after copying?
    name String
    Name for this sync job
    recurringDay Integer
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays List<Integer>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone String
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    srcPath String
    Absolute source path for the sync
    srcRemoteServerId Integer
    Remote server ID for the source (if remote)
    syncIntervalMinutes Integer
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger String
    Trigger type: daily, custom_schedule, or manual
    triggerFile String
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    workspaceId Integer
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    deleteEmptyFolders boolean
    Delete empty folders after sync?
    description string
    Description for this sync job
    destPath string
    Absolute destination path for the sync
    destRemoteServerId number
    Remote server ID for the destination (if remote)
    disabled boolean
    Is this sync disabled?
    excludePatterns string[]
    Array of glob patterns to exclude
    holidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns string[]
    Array of glob patterns to include
    interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy boolean
    Keep files after copying?
    name string
    Name for this sync job
    recurringDay number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays number[]
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays string[]
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    srcPath string
    Absolute source path for the sync
    srcRemoteServerId number
    Remote server ID for the source (if remote)
    syncIntervalMinutes number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger string
    Trigger type: daily, custom_schedule, or manual
    triggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    workspaceId number
    Workspace ID this sync belongs to
    always_write_trigger_file bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    delete_empty_folders bool
    Delete empty folders after sync?
    description str
    Description for this sync job
    dest_path str
    Absolute destination path for the sync
    dest_remote_server_id int
    Remote server ID for the destination (if remote)
    disabled bool
    Is this sync disabled?
    exclude_patterns Sequence[str]
    Array of glob patterns to exclude
    holiday_region str
    Skip the sync if there is a formal, observed holiday for this region.
    include_patterns Sequence[str]
    Array of glob patterns to include
    interval str
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keep_after_copy bool
    Keep files after copying?
    name str
    Name for this sync job
    recurring_day int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurring_days Sequence[int]
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    schedule_time_zone str
    Time zone for the schedule. If not set, times are interpreted as UTC.
    schedule_times_of_days Sequence[str]
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    src_path str
    Absolute source path for the sync
    src_remote_server_id int
    Remote server ID for the source (if remote)
    sync_interval_minutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger str
    Trigger type: daily, custom_schedule, or manual
    trigger_file str
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    workspace_id int
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile Boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    deleteEmptyFolders Boolean
    Delete empty folders after sync?
    description String
    Description for this sync job
    destPath String
    Absolute destination path for the sync
    destRemoteServerId Number
    Remote server ID for the destination (if remote)
    disabled Boolean
    Is this sync disabled?
    excludePatterns List<String>
    Array of glob patterns to exclude
    holidayRegion String
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns List<String>
    Array of glob patterns to include
    interval String
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy Boolean
    Keep files after copying?
    name String
    Name for this sync job
    recurringDay Number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays List<Number>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone String
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    srcPath String
    Absolute source path for the sync
    srcRemoteServerId Number
    Remote server ID for the source (if remote)
    syncIntervalMinutes Number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger String
    Trigger type: daily, custom_schedule, or manual
    triggerFile String
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    workspaceId Number
    Workspace ID this sync belongs to

    Outputs

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

    CreatedAt string
    When this sync was created
    DestSiteId int
    Destination site ID if syncing to a child or partner site
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestSyncRun string
    The latest run of this sync
    SiteId int
    Site ID this sync belongs to
    SrcSiteId int
    Source site ID if syncing from a child or partner site
    TwoWay bool
    Is this a two-way sync?
    UpdatedAt string
    When this sync was last updated
    UserId int
    User who created or owns this sync
    CreatedAt string
    When this sync was created
    DestSiteId int
    Destination site ID if syncing to a child or partner site
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestSyncRun string
    The latest run of this sync
    SiteId int
    Site ID this sync belongs to
    SrcSiteId int
    Source site ID if syncing from a child or partner site
    TwoWay bool
    Is this a two-way sync?
    UpdatedAt string
    When this sync was last updated
    UserId int
    User who created or owns this sync
    created_at string
    When this sync was created
    dest_site_id number
    Destination site ID if syncing to a child or partner site
    id string
    The provider-assigned unique ID for this managed resource.
    latest_sync_run string
    The latest run of this sync
    site_id number
    Site ID this sync belongs to
    src_site_id number
    Source site ID if syncing from a child or partner site
    two_way bool
    Is this a two-way sync?
    updated_at string
    When this sync was last updated
    user_id number
    User who created or owns this sync
    createdAt String
    When this sync was created
    destSiteId Integer
    Destination site ID if syncing to a child or partner site
    id String
    The provider-assigned unique ID for this managed resource.
    latestSyncRun String
    The latest run of this sync
    siteId Integer
    Site ID this sync belongs to
    srcSiteId Integer
    Source site ID if syncing from a child or partner site
    twoWay Boolean
    Is this a two-way sync?
    updatedAt String
    When this sync was last updated
    userId Integer
    User who created or owns this sync
    createdAt string
    When this sync was created
    destSiteId number
    Destination site ID if syncing to a child or partner site
    id string
    The provider-assigned unique ID for this managed resource.
    latestSyncRun string
    The latest run of this sync
    siteId number
    Site ID this sync belongs to
    srcSiteId number
    Source site ID if syncing from a child or partner site
    twoWay boolean
    Is this a two-way sync?
    updatedAt string
    When this sync was last updated
    userId number
    User who created or owns this sync
    created_at str
    When this sync was created
    dest_site_id int
    Destination site ID if syncing to a child or partner site
    id str
    The provider-assigned unique ID for this managed resource.
    latest_sync_run str
    The latest run of this sync
    site_id int
    Site ID this sync belongs to
    src_site_id int
    Source site ID if syncing from a child or partner site
    two_way bool
    Is this a two-way sync?
    updated_at str
    When this sync was last updated
    user_id int
    User who created or owns this sync
    createdAt String
    When this sync was created
    destSiteId Number
    Destination site ID if syncing to a child or partner site
    id String
    The provider-assigned unique ID for this managed resource.
    latestSyncRun String
    The latest run of this sync
    siteId Number
    Site ID this sync belongs to
    srcSiteId Number
    Source site ID if syncing from a child or partner site
    twoWay Boolean
    Is this a two-way sync?
    updatedAt String
    When this sync was last updated
    userId Number
    User who created or owns this sync

    Look up Existing Sync Resource

    Get an existing Sync 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?: SyncState, opts?: CustomResourceOptions): Sync
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        always_write_trigger_file: Optional[bool] = None,
        created_at: Optional[str] = None,
        delete_empty_folders: Optional[bool] = None,
        description: Optional[str] = None,
        dest_path: Optional[str] = None,
        dest_remote_server_id: Optional[int] = None,
        dest_site_id: Optional[int] = None,
        disabled: Optional[bool] = None,
        exclude_patterns: Optional[Sequence[str]] = None,
        holiday_region: Optional[str] = None,
        include_patterns: Optional[Sequence[str]] = None,
        interval: Optional[str] = None,
        keep_after_copy: Optional[bool] = None,
        latest_sync_run: Optional[str] = None,
        name: Optional[str] = None,
        recurring_day: Optional[int] = None,
        recurring_days: Optional[Sequence[int]] = None,
        schedule_days_of_weeks: Optional[Sequence[int]] = None,
        schedule_id: Optional[int] = None,
        schedule_time_zone: Optional[str] = None,
        schedule_times_of_days: Optional[Sequence[str]] = None,
        site_id: Optional[int] = None,
        src_path: Optional[str] = None,
        src_remote_server_id: Optional[int] = None,
        src_site_id: Optional[int] = None,
        sync_interval_minutes: Optional[int] = None,
        trigger: Optional[str] = None,
        trigger_file: Optional[str] = None,
        two_way: Optional[bool] = None,
        updated_at: Optional[str] = None,
        user_id: Optional[int] = None,
        workspace_id: Optional[int] = None) -> Sync
    func GetSync(ctx *Context, name string, id IDInput, state *SyncState, opts ...ResourceOption) (*Sync, error)
    public static Sync Get(string name, Input<string> id, SyncState? state, CustomResourceOptions? opts = null)
    public static Sync get(String name, Output<String> id, SyncState state, CustomResourceOptions options)
    resources:  _:    type: filescom:Sync    get:      id: ${id}
    import {
  to = filescom_sync.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.
    The following state arguments are supported:
    AlwaysWriteTriggerFile bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    CreatedAt string
    When this sync was created
    DeleteEmptyFolders bool
    Delete empty folders after sync?
    Description string
    Description for this sync job
    DestPath string
    Absolute destination path for the sync
    DestRemoteServerId int
    Remote server ID for the destination (if remote)
    DestSiteId int
    Destination site ID if syncing to a child or partner site
    Disabled bool
    Is this sync disabled?
    ExcludePatterns List<string>
    Array of glob patterns to exclude
    HolidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    IncludePatterns List<string>
    Array of glob patterns to include
    Interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    KeepAfterCopy bool
    Keep files after copying?
    LatestSyncRun string
    The latest run of this sync
    Name string
    Name for this sync job
    RecurringDay int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    RecurringDays List<int>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    ScheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays List<string>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    SiteId int
    Site ID this sync belongs to
    SrcPath string
    Absolute source path for the sync
    SrcRemoteServerId int
    Remote server ID for the source (if remote)
    SrcSiteId int
    Source site ID if syncing from a child or partner site
    SyncIntervalMinutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    Trigger string
    Trigger type: daily, custom_schedule, or manual
    TriggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    TwoWay bool
    Is this a two-way sync?
    UpdatedAt string
    When this sync was last updated
    UserId int
    User who created or owns this sync
    WorkspaceId int
    Workspace ID this sync belongs to
    AlwaysWriteTriggerFile bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    CreatedAt string
    When this sync was created
    DeleteEmptyFolders bool
    Delete empty folders after sync?
    Description string
    Description for this sync job
    DestPath string
    Absolute destination path for the sync
    DestRemoteServerId int
    Remote server ID for the destination (if remote)
    DestSiteId int
    Destination site ID if syncing to a child or partner site
    Disabled bool
    Is this sync disabled?
    ExcludePatterns []string
    Array of glob patterns to exclude
    HolidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    IncludePatterns []string
    Array of glob patterns to include
    Interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    KeepAfterCopy bool
    Keep files after copying?
    LatestSyncRun string
    The latest run of this sync
    Name string
    Name for this sync job
    RecurringDay int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    RecurringDays []int
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    ScheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays []string
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    SiteId int
    Site ID this sync belongs to
    SrcPath string
    Absolute source path for the sync
    SrcRemoteServerId int
    Remote server ID for the source (if remote)
    SrcSiteId int
    Source site ID if syncing from a child or partner site
    SyncIntervalMinutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    Trigger string
    Trigger type: daily, custom_schedule, or manual
    TriggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    TwoWay bool
    Is this a two-way sync?
    UpdatedAt string
    When this sync was last updated
    UserId int
    User who created or owns this sync
    WorkspaceId int
    Workspace ID this sync belongs to
    always_write_trigger_file bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    created_at string
    When this sync was created
    delete_empty_folders bool
    Delete empty folders after sync?
    description string
    Description for this sync job
    dest_path string
    Absolute destination path for the sync
    dest_remote_server_id number
    Remote server ID for the destination (if remote)
    dest_site_id number
    Destination site ID if syncing to a child or partner site
    disabled bool
    Is this sync disabled?
    exclude_patterns list(string)
    Array of glob patterns to exclude
    holiday_region string
    Skip the sync if there is a formal, observed holiday for this region.
    include_patterns list(string)
    Array of glob patterns to include
    interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keep_after_copy bool
    Keep files after copying?
    latest_sync_run string
    The latest run of this sync
    name string
    Name for this sync job
    recurring_day number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurring_days list(number)
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    schedule_time_zone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    schedule_times_of_days list(string)
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    site_id number
    Site ID this sync belongs to
    src_path string
    Absolute source path for the sync
    src_remote_server_id number
    Remote server ID for the source (if remote)
    src_site_id number
    Source site ID if syncing from a child or partner site
    sync_interval_minutes number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger string
    Trigger type: daily, custom_schedule, or manual
    trigger_file string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    two_way bool
    Is this a two-way sync?
    updated_at string
    When this sync was last updated
    user_id number
    User who created or owns this sync
    workspace_id number
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile Boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    createdAt String
    When this sync was created
    deleteEmptyFolders Boolean
    Delete empty folders after sync?
    description String
    Description for this sync job
    destPath String
    Absolute destination path for the sync
    destRemoteServerId Integer
    Remote server ID for the destination (if remote)
    destSiteId Integer
    Destination site ID if syncing to a child or partner site
    disabled Boolean
    Is this sync disabled?
    excludePatterns List<String>
    Array of glob patterns to exclude
    holidayRegion String
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns List<String>
    Array of glob patterns to include
    interval String
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy Boolean
    Keep files after copying?
    latestSyncRun String
    The latest run of this sync
    name String
    Name for this sync job
    recurringDay Integer
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays List<Integer>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone String
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    siteId Integer
    Site ID this sync belongs to
    srcPath String
    Absolute source path for the sync
    srcRemoteServerId Integer
    Remote server ID for the source (if remote)
    srcSiteId Integer
    Source site ID if syncing from a child or partner site
    syncIntervalMinutes Integer
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger String
    Trigger type: daily, custom_schedule, or manual
    triggerFile String
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    twoWay Boolean
    Is this a two-way sync?
    updatedAt String
    When this sync was last updated
    userId Integer
    User who created or owns this sync
    workspaceId Integer
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    createdAt string
    When this sync was created
    deleteEmptyFolders boolean
    Delete empty folders after sync?
    description string
    Description for this sync job
    destPath string
    Absolute destination path for the sync
    destRemoteServerId number
    Remote server ID for the destination (if remote)
    destSiteId number
    Destination site ID if syncing to a child or partner site
    disabled boolean
    Is this sync disabled?
    excludePatterns string[]
    Array of glob patterns to exclude
    holidayRegion string
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns string[]
    Array of glob patterns to include
    interval string
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy boolean
    Keep files after copying?
    latestSyncRun string
    The latest run of this sync
    name string
    Name for this sync job
    recurringDay number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays number[]
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone string
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays string[]
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    siteId number
    Site ID this sync belongs to
    srcPath string
    Absolute source path for the sync
    srcRemoteServerId number
    Remote server ID for the source (if remote)
    srcSiteId number
    Source site ID if syncing from a child or partner site
    syncIntervalMinutes number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger string
    Trigger type: daily, custom_schedule, or manual
    triggerFile string
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    twoWay boolean
    Is this a two-way sync?
    updatedAt string
    When this sync was last updated
    userId number
    User who created or owns this sync
    workspaceId number
    Workspace ID this sync belongs to
    always_write_trigger_file bool
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    created_at str
    When this sync was created
    delete_empty_folders bool
    Delete empty folders after sync?
    description str
    Description for this sync job
    dest_path str
    Absolute destination path for the sync
    dest_remote_server_id int
    Remote server ID for the destination (if remote)
    dest_site_id int
    Destination site ID if syncing to a child or partner site
    disabled bool
    Is this sync disabled?
    exclude_patterns Sequence[str]
    Array of glob patterns to exclude
    holiday_region str
    Skip the sync if there is a formal, observed holiday for this region.
    include_patterns Sequence[str]
    Array of glob patterns to include
    interval str
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keep_after_copy bool
    Keep files after copying?
    latest_sync_run str
    The latest run of this sync
    name str
    Name for this sync job
    recurring_day int
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurring_days Sequence[int]
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    schedule_time_zone str
    Time zone for the schedule. If not set, times are interpreted as UTC.
    schedule_times_of_days Sequence[str]
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    site_id int
    Site ID this sync belongs to
    src_path str
    Absolute source path for the sync
    src_remote_server_id int
    Remote server ID for the source (if remote)
    src_site_id int
    Source site ID if syncing from a child or partner site
    sync_interval_minutes int
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger str
    Trigger type: daily, custom_schedule, or manual
    trigger_file str
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    two_way bool
    Is this a two-way sync?
    updated_at str
    When this sync was last updated
    user_id int
    User who created or owns this sync
    workspace_id int
    Workspace ID this sync belongs to
    alwaysWriteTriggerFile Boolean
    If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.
    createdAt String
    When this sync was created
    deleteEmptyFolders Boolean
    Delete empty folders after sync?
    description String
    Description for this sync job
    destPath String
    Absolute destination path for the sync
    destRemoteServerId Number
    Remote server ID for the destination (if remote)
    destSiteId Number
    Destination site ID if syncing to a child or partner site
    disabled Boolean
    Is this sync disabled?
    excludePatterns List<String>
    Array of glob patterns to exclude
    holidayRegion String
    Skip the sync if there is a formal, observed holiday for this region.
    includePatterns List<String>
    Array of glob patterns to include
    interval String
    If trigger is daily, this specifies how often to run this sync. One of: day, week, weekEnd, month, monthEnd, quarter, quarterEnd, year, yearEnd
    keepAfterCopy Boolean
    Keep files after copying?
    latestSyncRun String
    The latest run of this sync
    name String
    Name for this sync job
    recurringDay Number
    If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.
    recurringDays List<Number>
    If trigger type is daily, this specifies one or more day numbers to run in one of the supported intervals: week, month, quarter, year.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the sync's schedule fields.
    scheduleTimeZone String
    Time zone for the schedule. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day to run in HH:MM format. For customSchedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.
    siteId Number
    Site ID this sync belongs to
    srcPath String
    Absolute source path for the sync
    srcRemoteServerId Number
    Remote server ID for the source (if remote)
    srcSiteId Number
    Source site ID if syncing from a child or partner site
    syncIntervalMinutes Number
    Frequency in minutes between syncs. If set, this value must be greater than or equal to the remoteSyncInterval value for the site's plan. If left blank, the plan's remoteSyncInterval will be used. This setting is only used if trigger is empty.
    trigger String
    Trigger type: daily, custom_schedule, or manual
    triggerFile String
    Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If triggerFile is set, a zero-byte file will be sent at the end of the sync.
    twoWay Boolean
    Is this a two-way sync?
    updatedAt String
    When this sync was last updated
    userId Number
    User who created or owns this sync
    workspaceId Number
    Workspace ID this sync belongs to

    Import

    The pulumi import command can be used, for example:

    Syncs can be imported by specifying the id.

    $ pulumi import filescom:index/sync:Sync example_sync 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 filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial