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

filescom.ScheduledExport

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

    A Scheduled Export defines a recurring schedule for generating one of the built-in CSV exports and e-mailing it to a Site Admin recipient.

    Example Usage

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

const exampleScheduledExport = new filescom.ScheduledExport("example_scheduled_export", {
    name: "Monthly access review",
    exportType: "permission_audit",
    exportOptions: {
        groupBy: "user",
    },
    userId: 1,
    disabled: true,
    trigger: "daily",
    interval: "month",
    recurringDay: 1,
    recurringDays: [
        1,
        15,
    ],
    scheduleId: 1,
    scheduleDaysOfWeeks: [
        1,
        3,
        5,
    ],
    scheduleTimesOfDays: ["06:30"],
    scheduleTimeZone: "Eastern Time (US & Canada)",
    holidayRegion: "us",
});

    import pulumi
import pulumi_filescom as filescom

example_scheduled_export = filescom.ScheduledExport("example_scheduled_export",
    name="Monthly access review",
    export_type="permission_audit",
    export_options={
        "groupBy": "user",
    },
    user_id=1,
    disabled=True,
    trigger="daily",
    interval="month",
    recurring_day=1,
    recurring_days=[
        1,
        15,
    ],
    schedule_id=1,
    schedule_days_of_weeks=[
        1,
        3,
        5,
    ],
    schedule_times_of_days=["06:30"],
    schedule_time_zone="Eastern Time (US & Canada)",
    holiday_region="us")

    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.NewScheduledExport(ctx, "example_scheduled_export", &filescom.ScheduledExportArgs{
			Name:       pulumi.String("Monthly access review"),
			ExportType: pulumi.String("permission_audit"),
			ExportOptions: pulumi.Any(map[string]interface{}{
				"groupBy": "user",
			}),
			UserId:       pulumi.Int(1),
			Disabled:     pulumi.Bool(true),
			Trigger:      pulumi.String("daily"),
			Interval:     pulumi.String("month"),
			RecurringDay: pulumi.Int(1),
			RecurringDays: pulumi.IntArray{
				pulumi.Int(1),
				pulumi.Int(15),
			},
			ScheduleId: pulumi.Int(1),
			ScheduleDaysOfWeeks: pulumi.IntArray{
				pulumi.Int(1),
				pulumi.Int(3),
				pulumi.Int(5),
			},
			ScheduleTimesOfDays: pulumi.StringArray{
				pulumi.String("06:30"),
			},
			ScheduleTimeZone: pulumi.String("Eastern Time (US & Canada)"),
			HolidayRegion:    pulumi.String("us"),
		})
		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 exampleScheduledExport = new Filescom.ScheduledExport("example_scheduled_export", new()
    {
        Name = "Monthly access review",
        ExportType = "permission_audit",
        ExportOptions = new Dictionary<string, object?>
        {
            ["groupBy"] = "user",
        },
        UserId = 1,
        Disabled = true,
        Trigger = "daily",
        Interval = "month",
        RecurringDay = 1,
        RecurringDays = new[]
        {
            1,
            15,
        },
        ScheduleId = 1,
        ScheduleDaysOfWeeks = new[]
        {
            1,
            3,
            5,
        },
        ScheduleTimesOfDays = new[]
        {
            "06:30",
        },
        ScheduleTimeZone = "Eastern Time (US & Canada)",
        HolidayRegion = "us",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.ScheduledExport;
import com.pulumi.filescom.ScheduledExportArgs;
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 exampleScheduledExport = new ScheduledExport("exampleScheduledExport", ScheduledExportArgs.builder()
            .name("Monthly access review")
            .exportType("permission_audit")
            .exportOptions(Map.of("groupBy", "user"))
            .userId(1)
            .disabled(true)
            .trigger("daily")
            .interval("month")
            .recurringDay(1)
            .recurringDays(            
                1,
                15)
            .scheduleId(1)
            .scheduleDaysOfWeeks(            
                1,
                3,
                5)
            .scheduleTimesOfDays("06:30")
            .scheduleTimeZone("Eastern Time (US & Canada)")
            .holidayRegion("us")
            .build());

    }
}

    resources:
  exampleScheduledExport:
    type: filescom:ScheduledExport
    name: example_scheduled_export
    properties:
      name: Monthly access review
      exportType: permission_audit
      exportOptions:
        groupBy: user
      userId: 1
      disabled: true
      trigger: daily
      interval: month
      recurringDay: 1
      recurringDays:
        - 1
        - 15
      scheduleId: 1
      scheduleDaysOfWeeks:
        - 1
        - 3
        - 5
      scheduleTimesOfDays:
        - 06:30
      scheduleTimeZone: Eastern Time (US & Canada)
      holidayRegion: us

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

resource "filescom_scheduledexport" "example_scheduled_export" {
  name        = "Monthly access review"
  export_type = "permission_audit"
  export_options = {
    "groupBy" = "user"
  }
  user_id                = 1
  disabled               = true
  trigger                = "daily"
  interval               = "month"
  recurring_day          = 1
  recurring_days         = [1, 15]
  schedule_id            = 1
  schedule_days_of_weeks = [1, 3, 5]
  schedule_times_of_days = ["06:30"]
  schedule_time_zone     = "Eastern Time (US & Canada)"
  holiday_region         = "us"
}

    Create ScheduledExport Resource

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

    Constructor syntax

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

@overload
def ScheduledExport(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    export_type: Optional[str] = None,
                    recurring_day: Optional[int] = None,
                    export_options: Optional[Any] = None,
                    holiday_region: Optional[str] = None,
                    interval: Optional[str] = None,
                    name: Optional[str] = None,
                    disabled: Optional[bool] = 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,
                    trigger: Optional[str] = None,
                    user_id: Optional[int] = None)
    func NewScheduledExport(ctx *Context, name string, args ScheduledExportArgs, opts ...ResourceOption) (*ScheduledExport, error)
    public ScheduledExport(string name, ScheduledExportArgs args, CustomResourceOptions? opts = null)
    public ScheduledExport(String name, ScheduledExportArgs args)
public ScheduledExport(String name, ScheduledExportArgs args, CustomResourceOptions options)

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


    resource "filescom_scheduled_export" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScheduledExportArgs
    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 ScheduledExportArgs
    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 ScheduledExportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledExportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledExportArgs
    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 scheduledExportResource = new Filescom.ScheduledExport("scheduledExportResource", new()
{
    ExportType = "string",
    RecurringDay = 0,
    ExportOptions = "any",
    HolidayRegion = "string",
    Interval = "string",
    Name = "string",
    Disabled = false,
    RecurringDays = new[]
    {
        0,
    },
    ScheduleDaysOfWeeks = new[]
    {
        0,
    },
    ScheduleId = 0,
    ScheduleTimeZone = "string",
    ScheduleTimesOfDays = new[]
    {
        "string",
    },
    Trigger = "string",
    UserId = 0,
});

    example, err := filescom.NewScheduledExport(ctx, "scheduledExportResource", &filescom.ScheduledExportArgs{
	ExportType:    pulumi.String("string"),
	RecurringDay:  pulumi.Int(0),
	ExportOptions: pulumi.Any("any"),
	HolidayRegion: pulumi.String("string"),
	Interval:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	Disabled:      pulumi.Bool(false),
	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"),
	},
	Trigger: pulumi.String("string"),
	UserId:  pulumi.Int(0),
})

    resource "filescom_scheduled_export" "scheduledExportResource" {
  lifecycle {
    create_before_destroy = true
  }
  export_type            = "string"
  recurring_day          = 0
  export_options         = "any"
  holiday_region         = "string"
  interval               = "string"
  name                   = "string"
  disabled               = false
  recurring_days         = [0]
  schedule_days_of_weeks = [0]
  schedule_id            = 0
  schedule_time_zone     = "string"
  schedule_times_of_days = ["string"]
  trigger                = "string"
  user_id                = 0
}

    var scheduledExportResource = new ScheduledExport("scheduledExportResource", ScheduledExportArgs.builder()
    .exportType("string")
    .recurringDay(0)
    .exportOptions("any")
    .holidayRegion("string")
    .interval("string")
    .name("string")
    .disabled(false)
    .recurringDays(0)
    .scheduleDaysOfWeeks(0)
    .scheduleId(0)
    .scheduleTimeZone("string")
    .scheduleTimesOfDays("string")
    .trigger("string")
    .userId(0)
    .build());

    scheduled_export_resource = filescom.ScheduledExport("scheduledExportResource",
    export_type="string",
    recurring_day=0,
    export_options="any",
    holiday_region="string",
    interval="string",
    name="string",
    disabled=False,
    recurring_days=[0],
    schedule_days_of_weeks=[0],
    schedule_id=0,
    schedule_time_zone="string",
    schedule_times_of_days=["string"],
    trigger="string",
    user_id=0)

    const scheduledExportResource = new filescom.ScheduledExport("scheduledExportResource", {
    exportType: "string",
    recurringDay: 0,
    exportOptions: "any",
    holidayRegion: "string",
    interval: "string",
    name: "string",
    disabled: false,
    recurringDays: [0],
    scheduleDaysOfWeeks: [0],
    scheduleId: 0,
    scheduleTimeZone: "string",
    scheduleTimesOfDays: ["string"],
    trigger: "string",
    userId: 0,
});

    type: filescom:ScheduledExport
properties:
    disabled: false
    exportOptions: any
    exportType: string
    holidayRegion: string
    interval: string
    name: string
    recurringDay: 0
    recurringDays:
        - 0
    scheduleDaysOfWeeks:
        - 0
    scheduleId: 0
    scheduleTimeZone: string
    scheduleTimesOfDays:
        - string
    trigger: string
    userId: 0

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

    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions object
    Report-specific options. permissionAudit supports groupBy with user or path.
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays List<int>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UserId int
    Site Admin user who receives the completed export e-mail.
    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions interface{}
    Report-specific options. permissionAudit supports groupBy with user or path.
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays []int
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UserId int
    Site Admin user who receives the completed export e-mail.
    export_type string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    disabled bool
    If true, this scheduled export will not run.
    export_options any
    Report-specific options. permissionAudit supports groupBy with user or path.
    holiday_region string
    Optional holiday region used by the scheduled export schedule.
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    name string
    Name for this scheduled export.
    recurring_day number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days list(number)
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone string
    Time zone used by the scheduled export schedule.
    schedule_times_of_days list(string)
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    user_id number
    Site Admin user who receives the completed export e-mail.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Object
    Report-specific options. permissionAudit supports groupBy with user or path.
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    name String
    Name for this scheduled export.
    recurringDay Integer
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Integer>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    userId Integer
    Site Admin user who receives the completed export e-mail.
    exportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    disabled boolean
    If true, this scheduled export will not run.
    exportOptions any
    Report-specific options. permissionAudit supports groupBy with user or path.
    holidayRegion string
    Optional holiday region used by the scheduled export schedule.
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    name string
    Name for this scheduled export.
    recurringDay number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays number[]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone string
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    userId number
    Site Admin user who receives the completed export e-mail.
    export_type str
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    disabled bool
    If true, this scheduled export will not run.
    export_options Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    holiday_region str
    Optional holiday region used by the scheduled export schedule.
    interval str
    If trigger is daily, this specifies how often to run the scheduled export.
    name str
    Name for this scheduled export.
    recurring_day int
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days Sequence[int]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone str
    Time zone used by the scheduled export schedule.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger str
    Schedule trigger type: daily or customSchedule.
    user_id int
    Site Admin user who receives the completed export e-mail.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    name String
    Name for this scheduled export.
    recurringDay Number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Number>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    userId Number
    Site Admin user who receives the completed export e-mail.

    Outputs

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

    CreatedAt string
    Creation time.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    ReportName string
    Human-readable report name.
    UpdatedAt string
    Last update time.
    CreatedAt string
    Creation time.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    ReportName string
    Human-readable report name.
    UpdatedAt string
    Last update time.
    created_at string
    Creation time.
    human_readable_schedule string
    Human-readable schedule description.
    id string
    The provider-assigned unique ID for this managed resource.
    last_export_id number
    Most recent Export ID created by this schedule.
    last_run_at string
    Most recent scheduled run time.
    report_name string
    Human-readable report name.
    updated_at string
    Last update time.
    createdAt String
    Creation time.
    humanReadableSchedule String
    Human-readable schedule description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastExportId Integer
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    reportName String
    Human-readable report name.
    updatedAt String
    Last update time.
    createdAt string
    Creation time.
    humanReadableSchedule string
    Human-readable schedule description.
    id string
    The provider-assigned unique ID for this managed resource.
    lastExportId number
    Most recent Export ID created by this schedule.
    lastRunAt string
    Most recent scheduled run time.
    reportName string
    Human-readable report name.
    updatedAt string
    Last update time.
    created_at str
    Creation time.
    human_readable_schedule str
    Human-readable schedule description.
    id str
    The provider-assigned unique ID for this managed resource.
    last_export_id int
    Most recent Export ID created by this schedule.
    last_run_at str
    Most recent scheduled run time.
    report_name str
    Human-readable report name.
    updated_at str
    Last update time.
    createdAt String
    Creation time.
    humanReadableSchedule String
    Human-readable schedule description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastExportId Number
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    reportName String
    Human-readable report name.
    updatedAt String
    Last update time.

    Look up Existing ScheduledExport Resource

    Get an existing ScheduledExport 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?: ScheduledExportState, opts?: CustomResourceOptions): ScheduledExport
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        disabled: Optional[bool] = None,
        export_options: Optional[Any] = None,
        export_type: Optional[str] = None,
        holiday_region: Optional[str] = None,
        human_readable_schedule: Optional[str] = None,
        interval: Optional[str] = None,
        last_export_id: Optional[int] = None,
        last_run_at: Optional[str] = None,
        name: Optional[str] = None,
        recurring_day: Optional[int] = None,
        recurring_days: Optional[Sequence[int]] = None,
        report_name: Optional[str] = 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,
        trigger: Optional[str] = None,
        updated_at: Optional[str] = None,
        user_id: Optional[int] = None) -> ScheduledExport
    func GetScheduledExport(ctx *Context, name string, id IDInput, state *ScheduledExportState, opts ...ResourceOption) (*ScheduledExport, error)
    public static ScheduledExport Get(string name, Input<string> id, ScheduledExportState? state, CustomResourceOptions? opts = null)
    public static ScheduledExport get(String name, Output<String> id, ScheduledExportState state, CustomResourceOptions options)
    resources:  _:    type: filescom:ScheduledExport    get:      id: ${id}
    import {
  to = filescom_scheduled_export.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:
    CreatedAt string
    Creation time.
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions object
    Report-specific options. permissionAudit supports groupBy with user or path.
    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays List<int>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ReportName string
    Human-readable report name.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UpdatedAt string
    Last update time.
    UserId int
    Site Admin user who receives the completed export e-mail.
    CreatedAt string
    Creation time.
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions interface{}
    Report-specific options. permissionAudit supports groupBy with user or path.
    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays []int
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ReportName string
    Human-readable report name.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UpdatedAt string
    Last update time.
    UserId int
    Site Admin user who receives the completed export e-mail.
    created_at string
    Creation time.
    disabled bool
    If true, this scheduled export will not run.
    export_options any
    Report-specific options. permissionAudit supports groupBy with user or path.
    export_type string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holiday_region string
    Optional holiday region used by the scheduled export schedule.
    human_readable_schedule string
    Human-readable schedule description.
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    last_export_id number
    Most recent Export ID created by this schedule.
    last_run_at string
    Most recent scheduled run time.
    name string
    Name for this scheduled export.
    recurring_day number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days list(number)
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    report_name string
    Human-readable report name.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone string
    Time zone used by the scheduled export schedule.
    schedule_times_of_days list(string)
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    updated_at string
    Last update time.
    user_id number
    Site Admin user who receives the completed export e-mail.
    createdAt String
    Creation time.
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Object
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId Integer
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    name String
    Name for this scheduled export.
    recurringDay Integer
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Integer>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName String
    Human-readable report name.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    updatedAt String
    Last update time.
    userId Integer
    Site Admin user who receives the completed export e-mail.
    createdAt string
    Creation time.
    disabled boolean
    If true, this scheduled export will not run.
    exportOptions any
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion string
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule string
    Human-readable schedule description.
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId number
    Most recent Export ID created by this schedule.
    lastRunAt string
    Most recent scheduled run time.
    name string
    Name for this scheduled export.
    recurringDay number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays number[]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName string
    Human-readable report name.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone string
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    updatedAt string
    Last update time.
    userId number
    Site Admin user who receives the completed export e-mail.
    created_at str
    Creation time.
    disabled bool
    If true, this scheduled export will not run.
    export_options Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    export_type str
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holiday_region str
    Optional holiday region used by the scheduled export schedule.
    human_readable_schedule str
    Human-readable schedule description.
    interval str
    If trigger is daily, this specifies how often to run the scheduled export.
    last_export_id int
    Most recent Export ID created by this schedule.
    last_run_at str
    Most recent scheduled run time.
    name str
    Name for this scheduled export.
    recurring_day int
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days Sequence[int]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    report_name str
    Human-readable report name.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone str
    Time zone used by the scheduled export schedule.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger str
    Schedule trigger type: daily or customSchedule.
    updated_at str
    Last update time.
    user_id int
    Site Admin user who receives the completed export e-mail.
    createdAt String
    Creation time.
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId Number
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    name String
    Name for this scheduled export.
    recurringDay Number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Number>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName String
    Human-readable report name.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    updatedAt String
    Last update time.
    userId Number
    Site Admin user who receives the completed export e-mail.

    Import

    The pulumi import command can be used, for example:

    Scheduled Exports can be imported by specifying the id.

    $ pulumi import filescom:index/scheduledExport:ScheduledExport example_scheduled_export 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