getSync

Files.com v0.1.1, Aug 20 26

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

Example Usage

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

const exampleSync = filescom.getSync({
    id: 1,
});

import pulumi
import pulumi_filescom as filescom

example_sync = filescom.get_sync(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.GetSync(ctx, &filescom.LookupSyncArgs{
			Id: 1,
		}, nil)
		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 = Filescom.GetSync.Invoke(new()
    {
        Id = 1,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetSyncArgs;
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) {
        final var exampleSync = FilescomFunctions.getSync(GetSyncArgs.builder()
            .id(1)
            .build());

    }
}

variables:
  exampleSync:
    fn::invoke:
      function: filescom:getSync
      arguments:
        id: 1

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

data "filescom_getsync" "exampleSync" {
  id = 1
}

Using getSync

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

function getSync(args: GetSyncArgs, opts?: InvokeOptions): Promise<GetSyncResult>
function getSyncOutput(args: GetSyncOutputArgs, opts?: InvokeOutputOptions): Output<GetSyncResult>

def get_sync(id: Optional[int] = None,
             opts: Optional[InvokeOptions] = None) -> GetSyncResult
def get_sync_output(id: pulumi.Input[Optional[int]] = None,
             opts: Optional[InvokeOutputOptions] = None) -> Output[GetSyncResult]

func LookupSync(ctx *Context, args *LookupSyncArgs, opts ...InvokeOption) (*LookupSyncResult, error)
func LookupSyncOutput(ctx *Context, args *LookupSyncOutputArgs, opts ...InvokeOption) LookupSyncResultOutput

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

public static class GetSync 
{
    public static Task<GetSyncResult> InvokeAsync(GetSyncArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncResult> Invoke(GetSyncInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncResult> Invoke(GetSyncInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetSyncResult> getSync(GetSyncArgs args, InvokeOptions options)
public static Output<GetSyncResult> getSync(GetSyncArgs args, InvokeOptions options)
public static Output<GetSyncResult> getSync(GetSyncArgs args, InvokeOutputOptions options)

fn::invoke:
  function: filescom:index/getSync:getSync
  arguments:
    # arguments dictionary

data "filescom_get_sync" "name" {
    # arguments
}

The following arguments are supported:

Id int: Sync ID

Id int: Sync ID

id number: Sync ID

id Integer: Sync ID

id number: Sync ID

id int: Sync ID

id Number: Sync ID

getSync Result

The following output properties are available:

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.
Id int: Sync ID
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.
Id int: Sync ID
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.
id number: Sync ID
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.
id Integer: Sync ID
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.
id number: Sync ID
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.
id int: Sync ID
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.
id Number: Sync ID
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

Package Details

Repository: filescom jschady/pulumi-filescom
License: Apache-2.0
Notes: This Pulumi package is based on the filescom Terraform Provider.

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

filescom.getSync

On this page

On this page

Example Usage

Using getSync

getSync Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

filescom.getSync

On this page

On this page

Example Usage

Using getSync

getSync Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.