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

filescom.Bundle

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

    A Bundle is the API/SDK term for the feature called Share Links in the web interface.

    The API provides the full set of actions related to Share Links, including sending them via E-Mail.

    Please note that we very closely monitor the E-Mailing feature and any abuse will result in disabling of your site.

    Example Usage

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

const exampleBundle = new filescom.Bundle("example_bundle", {
    userId: 1,
    paths: ["file.txt"],
    password: "Password",
    bypassesSiteExpirationRules: true,
    formFieldSetId: 1,
    createSnapshot: false,
    dontSeparateSubmissionsByFolder: true,
    expiresAt: "2000-01-01T01:00:00Z",
    finalizeSnapshot: false,
    maxUses: 1,
    groupId: 1,
    internalName: "Quarterly reports",
    description: "The public description of the bundle.",
    note: "The internal note on the bundle.",
    code: "abc123",
    pathTemplate: "{{name}}_{{ip}}",
    pathTemplateTimeZone: "Eastern Time (US & Canada)",
    permissions: "read",
    requireRegistration: false,
    clickwrapId: 1,
    inboxId: 1,
    requireShareRecipient: false,
    sendOneTimePasswordToRecipientAtRegistration: true,
    sendEmailReceiptToUploader: true,
    skipEmail: true,
    skipName: true,
    skipCompany: true,
    startAccessOnDate: "2000-01-01T01:00:00Z",
    snapshotId: 1,
    workspaceId: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_bundle = filescom.Bundle("example_bundle",
    user_id=1,
    paths=["file.txt"],
    password="Password",
    bypasses_site_expiration_rules=True,
    form_field_set_id=1,
    create_snapshot=False,
    dont_separate_submissions_by_folder=True,
    expires_at="2000-01-01T01:00:00Z",
    finalize_snapshot=False,
    max_uses=1,
    group_id=1,
    internal_name="Quarterly reports",
    description="The public description of the bundle.",
    note="The internal note on the bundle.",
    code="abc123",
    path_template="{{name}}_{{ip}}",
    path_template_time_zone="Eastern Time (US & Canada)",
    permissions="read",
    require_registration=False,
    clickwrap_id=1,
    inbox_id=1,
    require_share_recipient=False,
    send_one_time_password_to_recipient_at_registration=True,
    send_email_receipt_to_uploader=True,
    skip_email=True,
    skip_name=True,
    skip_company=True,
    start_access_on_date="2000-01-01T01:00:00Z",
    snapshot_id=1,
    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.NewBundle(ctx, "example_bundle", &filescom.BundleArgs{
			UserId: pulumi.Int(1),
			Paths: pulumi.StringArray{
				pulumi.String("file.txt"),
			},
			Password:                        pulumi.String("Password"),
			BypassesSiteExpirationRules:     pulumi.Bool(true),
			FormFieldSetId:                  pulumi.Int(1),
			CreateSnapshot:                  pulumi.Bool(false),
			DontSeparateSubmissionsByFolder: pulumi.Bool(true),
			ExpiresAt:                       pulumi.String("2000-01-01T01:00:00Z"),
			FinalizeSnapshot:                pulumi.Bool(false),
			MaxUses:                         pulumi.Int(1),
			GroupId:                         pulumi.Int(1),
			InternalName:                    pulumi.String("Quarterly reports"),
			Description:                     pulumi.String("The public description of the bundle."),
			Note:                            pulumi.String("The internal note on the bundle."),
			Code:                            pulumi.String("abc123"),
			PathTemplate:                    pulumi.String("{{name}}_{{ip}}"),
			PathTemplateTimeZone:            pulumi.String("Eastern Time (US & Canada)"),
			Permissions:                     pulumi.String("read"),
			RequireRegistration:             pulumi.Bool(false),
			ClickwrapId:                     pulumi.Int(1),
			InboxId:                         pulumi.Int(1),
			RequireShareRecipient:           pulumi.Bool(false),
			SendOneTimePasswordToRecipientAtRegistration: pulumi.Bool(true),
			SendEmailReceiptToUploader:                   pulumi.Bool(true),
			SkipEmail:                                    pulumi.Bool(true),
			SkipName:                                     pulumi.Bool(true),
			SkipCompany:                                  pulumi.Bool(true),
			StartAccessOnDate:                            pulumi.String("2000-01-01T01:00:00Z"),
			SnapshotId:                                   pulumi.Int(1),
			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 exampleBundle = new Filescom.Bundle("example_bundle", new()
    {
        UserId = 1,
        Paths = new[]
        {
            "file.txt",
        },
        Password = "Password",
        BypassesSiteExpirationRules = true,
        FormFieldSetId = 1,
        CreateSnapshot = false,
        DontSeparateSubmissionsByFolder = true,
        ExpiresAt = "2000-01-01T01:00:00Z",
        FinalizeSnapshot = false,
        MaxUses = 1,
        GroupId = 1,
        InternalName = "Quarterly reports",
        Description = "The public description of the bundle.",
        Note = "The internal note on the bundle.",
        Code = "abc123",
        PathTemplate = "{{name}}_{{ip}}",
        PathTemplateTimeZone = "Eastern Time (US & Canada)",
        Permissions = "read",
        RequireRegistration = false,
        ClickwrapId = 1,
        InboxId = 1,
        RequireShareRecipient = false,
        SendOneTimePasswordToRecipientAtRegistration = true,
        SendEmailReceiptToUploader = true,
        SkipEmail = true,
        SkipName = true,
        SkipCompany = true,
        StartAccessOnDate = "2000-01-01T01:00:00Z",
        SnapshotId = 1,
        WorkspaceId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.Bundle;
import com.pulumi.filescom.BundleArgs;
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 exampleBundle = new Bundle("exampleBundle", BundleArgs.builder()
            .userId(1)
            .paths("file.txt")
            .password("Password")
            .bypassesSiteExpirationRules(true)
            .formFieldSetId(1)
            .createSnapshot(false)
            .dontSeparateSubmissionsByFolder(true)
            .expiresAt("2000-01-01T01:00:00Z")
            .finalizeSnapshot(false)
            .maxUses(1)
            .groupId(1)
            .internalName("Quarterly reports")
            .description("The public description of the bundle.")
            .note("The internal note on the bundle.")
            .code("abc123")
            .pathTemplate("{{name}}_{{ip}}")
            .pathTemplateTimeZone("Eastern Time (US & Canada)")
            .permissions("read")
            .requireRegistration(false)
            .clickwrapId(1)
            .inboxId(1)
            .requireShareRecipient(false)
            .sendOneTimePasswordToRecipientAtRegistration(true)
            .sendEmailReceiptToUploader(true)
            .skipEmail(true)
            .skipName(true)
            .skipCompany(true)
            .startAccessOnDate("2000-01-01T01:00:00Z")
            .snapshotId(1)
            .workspaceId(1)
            .build());

    }
}

    resources:
  exampleBundle:
    type: filescom:Bundle
    name: example_bundle
    properties:
      userId: 1
      paths:
        - file.txt
      password: Password
      bypassesSiteExpirationRules: true
      formFieldSetId: 1
      createSnapshot: false
      dontSeparateSubmissionsByFolder: true
      expiresAt: 2000-01-01T01:00:00Z
      finalizeSnapshot: false
      maxUses: 1
      groupId: 1
      internalName: Quarterly reports
      description: The public description of the bundle.
      note: The internal note on the bundle.
      code: abc123
      pathTemplate: '{{name}}_{{ip}}'
      pathTemplateTimeZone: Eastern Time (US & Canada)
      permissions: read
      requireRegistration: false
      clickwrapId: 1
      inboxId: 1
      requireShareRecipient: false
      sendOneTimePasswordToRecipientAtRegistration: true
      sendEmailReceiptToUploader: true
      skipEmail: true
      skipName: true
      skipCompany: true
      startAccessOnDate: 2000-01-01T01:00:00Z
      snapshotId: 1
      workspaceId: 1

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

resource "filescom_bundle" "example_bundle" {
  user_id                                             = 1
  paths                                               = ["file.txt"]
  password                                            = "Password"
  bypasses_site_expiration_rules                      = true
  form_field_set_id                                   = 1
  create_snapshot                                     = false
  dont_separate_submissions_by_folder                 = true
  expires_at                                          = "2000-01-01T01:00:00Z"
  finalize_snapshot                                   = false
  max_uses                                            = 1
  group_id                                            = 1
  internal_name                                       = "Quarterly reports"
  description                                         = "The public description of the bundle."
  note                                                = "The internal note on the bundle."
  code                                                = "abc123"
  path_template                                       = "{{name}}_{{ip}}"
  path_template_time_zone                             = "Eastern Time (US & Canada)"
  permissions                                         = "read"
  require_registration                                = false
  clickwrap_id                                        = 1
  inbox_id                                            = 1
  require_share_recipient                             = false
  send_one_time_password_to_recipient_at_registration = true
  send_email_receipt_to_uploader                      = true
  skip_email                                          = true
  skip_name                                           = true
  skip_company                                        = true
  start_access_on_date                                = "2000-01-01T01:00:00Z"
  snapshot_id                                         = 1
  workspace_id                                        = 1
}

    Create Bundle Resource

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

    Constructor syntax

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

@overload
def Bundle(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           paths: Optional[Sequence[str]] = None,
           password: Optional[str] = None,
           require_share_recipient: Optional[bool] = None,
           create_snapshot: Optional[bool] = None,
           description: Optional[str] = None,
           dont_separate_submissions_by_folder: Optional[bool] = None,
           expires_at: Optional[str] = None,
           finalize_snapshot: Optional[bool] = None,
           form_field_set_id: Optional[int] = None,
           group_id: Optional[int] = None,
           inbox_id: Optional[int] = None,
           internal_name: Optional[str] = None,
           max_uses: Optional[int] = None,
           note: Optional[str] = None,
           bypasses_site_expiration_rules: Optional[bool] = None,
           code: Optional[str] = None,
           clickwrap_id: Optional[int] = None,
           path_template: Optional[str] = None,
           permissions: Optional[str] = None,
           require_registration: Optional[bool] = None,
           path_template_time_zone: Optional[str] = None,
           send_email_receipt_to_uploader: Optional[bool] = None,
           send_one_time_password_to_recipient_at_registration: Optional[bool] = None,
           skip_company: Optional[bool] = None,
           skip_email: Optional[bool] = None,
           skip_name: Optional[bool] = None,
           snapshot_id: Optional[int] = None,
           start_access_on_date: Optional[str] = None,
           user_id: Optional[int] = None,
           workspace_id: Optional[int] = None)
    func NewBundle(ctx *Context, name string, args BundleArgs, opts ...ResourceOption) (*Bundle, error)
    public Bundle(string name, BundleArgs args, CustomResourceOptions? opts = null)
    public Bundle(String name, BundleArgs args)
public Bundle(String name, BundleArgs args, CustomResourceOptions options)

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


    resource "filescom_bundle" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BundleArgs
    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 BundleArgs
    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 BundleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BundleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BundleArgs
    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 bundleResource = new Filescom.Bundle("bundleResource", new()
{
    Paths = new[]
    {
        "string",
    },
    Password = "string",
    RequireShareRecipient = false,
    CreateSnapshot = false,
    Description = "string",
    DontSeparateSubmissionsByFolder = false,
    ExpiresAt = "string",
    FinalizeSnapshot = false,
    FormFieldSetId = 0,
    GroupId = 0,
    InboxId = 0,
    InternalName = "string",
    MaxUses = 0,
    Note = "string",
    BypassesSiteExpirationRules = false,
    Code = "string",
    ClickwrapId = 0,
    PathTemplate = "string",
    Permissions = "string",
    RequireRegistration = false,
    PathTemplateTimeZone = "string",
    SendEmailReceiptToUploader = false,
    SendOneTimePasswordToRecipientAtRegistration = false,
    SkipCompany = false,
    SkipEmail = false,
    SkipName = false,
    SnapshotId = 0,
    StartAccessOnDate = "string",
    UserId = 0,
    WorkspaceId = 0,
});

    example, err := filescom.NewBundle(ctx, "bundleResource", &filescom.BundleArgs{
	Paths: pulumi.StringArray{
		pulumi.String("string"),
	},
	Password:                        pulumi.String("string"),
	RequireShareRecipient:           pulumi.Bool(false),
	CreateSnapshot:                  pulumi.Bool(false),
	Description:                     pulumi.String("string"),
	DontSeparateSubmissionsByFolder: pulumi.Bool(false),
	ExpiresAt:                       pulumi.String("string"),
	FinalizeSnapshot:                pulumi.Bool(false),
	FormFieldSetId:                  pulumi.Int(0),
	GroupId:                         pulumi.Int(0),
	InboxId:                         pulumi.Int(0),
	InternalName:                    pulumi.String("string"),
	MaxUses:                         pulumi.Int(0),
	Note:                            pulumi.String("string"),
	BypassesSiteExpirationRules:     pulumi.Bool(false),
	Code:                            pulumi.String("string"),
	ClickwrapId:                     pulumi.Int(0),
	PathTemplate:                    pulumi.String("string"),
	Permissions:                     pulumi.String("string"),
	RequireRegistration:             pulumi.Bool(false),
	PathTemplateTimeZone:            pulumi.String("string"),
	SendEmailReceiptToUploader:      pulumi.Bool(false),
	SendOneTimePasswordToRecipientAtRegistration: pulumi.Bool(false),
	SkipCompany:       pulumi.Bool(false),
	SkipEmail:         pulumi.Bool(false),
	SkipName:          pulumi.Bool(false),
	SnapshotId:        pulumi.Int(0),
	StartAccessOnDate: pulumi.String("string"),
	UserId:            pulumi.Int(0),
	WorkspaceId:       pulumi.Int(0),
})

    resource "filescom_bundle" "bundleResource" {
  lifecycle {
    create_before_destroy = true
  }
  paths                                               = ["string"]
  password                                            = "string"
  require_share_recipient                             = false
  create_snapshot                                     = false
  description                                         = "string"
  dont_separate_submissions_by_folder                 = false
  expires_at                                          = "string"
  finalize_snapshot                                   = false
  form_field_set_id                                   = 0
  group_id                                            = 0
  inbox_id                                            = 0
  internal_name                                       = "string"
  max_uses                                            = 0
  note                                                = "string"
  bypasses_site_expiration_rules                      = false
  code                                                = "string"
  clickwrap_id                                        = 0
  path_template                                       = "string"
  permissions                                         = "string"
  require_registration                                = false
  path_template_time_zone                             = "string"
  send_email_receipt_to_uploader                      = false
  send_one_time_password_to_recipient_at_registration = false
  skip_company                                        = false
  skip_email                                          = false
  skip_name                                           = false
  snapshot_id                                         = 0
  start_access_on_date                                = "string"
  user_id                                             = 0
  workspace_id                                        = 0
}

    var bundleResource = new Bundle("bundleResource", BundleArgs.builder()
    .paths("string")
    .password("string")
    .requireShareRecipient(false)
    .createSnapshot(false)
    .description("string")
    .dontSeparateSubmissionsByFolder(false)
    .expiresAt("string")
    .finalizeSnapshot(false)
    .formFieldSetId(0)
    .groupId(0)
    .inboxId(0)
    .internalName("string")
    .maxUses(0)
    .note("string")
    .bypassesSiteExpirationRules(false)
    .code("string")
    .clickwrapId(0)
    .pathTemplate("string")
    .permissions("string")
    .requireRegistration(false)
    .pathTemplateTimeZone("string")
    .sendEmailReceiptToUploader(false)
    .sendOneTimePasswordToRecipientAtRegistration(false)
    .skipCompany(false)
    .skipEmail(false)
    .skipName(false)
    .snapshotId(0)
    .startAccessOnDate("string")
    .userId(0)
    .workspaceId(0)
    .build());

    bundle_resource = filescom.Bundle("bundleResource",
    paths=["string"],
    password="string",
    require_share_recipient=False,
    create_snapshot=False,
    description="string",
    dont_separate_submissions_by_folder=False,
    expires_at="string",
    finalize_snapshot=False,
    form_field_set_id=0,
    group_id=0,
    inbox_id=0,
    internal_name="string",
    max_uses=0,
    note="string",
    bypasses_site_expiration_rules=False,
    code="string",
    clickwrap_id=0,
    path_template="string",
    permissions="string",
    require_registration=False,
    path_template_time_zone="string",
    send_email_receipt_to_uploader=False,
    send_one_time_password_to_recipient_at_registration=False,
    skip_company=False,
    skip_email=False,
    skip_name=False,
    snapshot_id=0,
    start_access_on_date="string",
    user_id=0,
    workspace_id=0)

    const bundleResource = new filescom.Bundle("bundleResource", {
    paths: ["string"],
    password: "string",
    requireShareRecipient: false,
    createSnapshot: false,
    description: "string",
    dontSeparateSubmissionsByFolder: false,
    expiresAt: "string",
    finalizeSnapshot: false,
    formFieldSetId: 0,
    groupId: 0,
    inboxId: 0,
    internalName: "string",
    maxUses: 0,
    note: "string",
    bypassesSiteExpirationRules: false,
    code: "string",
    clickwrapId: 0,
    pathTemplate: "string",
    permissions: "string",
    requireRegistration: false,
    pathTemplateTimeZone: "string",
    sendEmailReceiptToUploader: false,
    sendOneTimePasswordToRecipientAtRegistration: false,
    skipCompany: false,
    skipEmail: false,
    skipName: false,
    snapshotId: 0,
    startAccessOnDate: "string",
    userId: 0,
    workspaceId: 0,
});

    type: filescom:Bundle
properties:
    bypassesSiteExpirationRules: false
    clickwrapId: 0
    code: string
    createSnapshot: false
    description: string
    dontSeparateSubmissionsByFolder: false
    expiresAt: string
    finalizeSnapshot: false
    formFieldSetId: 0
    groupId: 0
    inboxId: 0
    internalName: string
    maxUses: 0
    note: string
    password: string
    pathTemplate: string
    pathTemplateTimeZone: string
    paths:
        - string
    permissions: string
    requireRegistration: false
    requireShareRecipient: false
    sendEmailReceiptToUploader: false
    sendOneTimePasswordToRecipientAtRegistration: false
    skipCompany: false
    skipEmail: false
    skipName: false
    snapshotId: 0
    startAccessOnDate: string
    userId: 0
    workspaceId: 0

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

    Paths List<string>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    CreateSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    Description string
    Public description
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FinalizeSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    FormFieldSetId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    UserId int
    Bundle creator user ID
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Paths []string
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    CreateSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    Description string
    Public description
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FinalizeSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    FormFieldSetId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    UserId int
    Bundle creator user ID
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    paths list(string)
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_id number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    create_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    description string
    Public description
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at string
    Bundle expiration date/time
    finalize_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    form_field_set_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    group_id number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    inbox_id number
    ID of the associated inbox, if available.
    internal_name string
    Internal name for identifying this Share Link.
    max_uses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    path_template string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone string
    Timezone to use when rendering timestamps in path templates.
    permissions string
    Permissions that apply to Folders in this Share Link.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id number
    ID of the snapshot containing this bundle's contents.
    start_access_on_date string
    Date when share will start to be accessible. If nil access granted right after create.
    user_id number
    Bundle creator user ID
    workspace_id number
    Workspace ID. 0 means the default workspace.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapId Integer
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    createSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    description String
    Public description
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    finalizeSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSetId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId Integer
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    inboxId Integer
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Integer
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    permissions String
    Permissions that apply to Folders in this Share Link.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Integer
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    userId Integer
    Bundle creator user ID
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    paths string[]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapId number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    createSnapshot boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    description string
    Public description
    dontSeparateSubmissionsByFolder boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt string
    Bundle expiration date/time
    finalizeSnapshot boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSetId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    inboxId number
    ID of the associated inbox, if available.
    internalName string
    Internal name for identifying this Share Link.
    maxUses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    pathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    permissions string
    Permissions that apply to Folders in this Share Link.
    requireRegistration boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany boolean
    BundleRegistrations can be saved without providing company?
    skipEmail boolean
    BundleRegistrations can be saved without providing email?
    skipName boolean
    BundleRegistrations can be saved without providing name?
    snapshotId number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    userId number
    Bundle creator user ID
    workspaceId number
    Workspace ID. 0 means the default workspace.
    paths Sequence[str]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_id int
    ID of the clickwrap to use with this bundle.
    code str
    Bundle code. This code forms the end part of the Public URL.
    create_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    description str
    Public description
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at str
    Bundle expiration date/time
    finalize_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    form_field_set_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    group_id int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    inbox_id int
    ID of the associated inbox, if available.
    internal_name str
    Internal name for identifying this Share Link.
    max_uses int
    Maximum number of times bundle can be accessed
    note str
    Bundle internal note
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    path_template str
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone str
    Timezone to use when rendering timestamps in path templates.
    permissions str
    Permissions that apply to Folders in this Share Link.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id int
    ID of the snapshot containing this bundle's contents.
    start_access_on_date str
    Date when share will start to be accessible. If nil access granted right after create.
    user_id int
    Bundle creator user ID
    workspace_id int
    Workspace ID. 0 means the default workspace.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapId Number
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    createSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    description String
    Public description
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    finalizeSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSetId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId Number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    inboxId Number
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Number
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    permissions String
    Permissions that apply to Folders in this Share Link.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    userId Number
    Bundle creator user ID
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Outputs

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

    Bundlepaths object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    FormFieldSet string
    Custom Form to use
    HasInbox bool
    Does this bundle have an associated inbox?
    Id string
    The provider-assigned unique ID for this managed resource.
    PasswordProtected bool
    Is this bundle password protected?
    PreviewOnly bool
    RequestedUploadSlots object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    Url string
    Public URL of Share Link
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    Bundlepaths interface{}
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    FormFieldSet string
    Custom Form to use
    HasInbox bool
    Does this bundle have an associated inbox?
    Id string
    The provider-assigned unique ID for this managed resource.
    PasswordProtected bool
    Is this bundle password protected?
    PreviewOnly bool
    RequestedUploadSlots interface{}
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    Url string
    Public URL of Share Link
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue interface{}
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    clickwrap_body string
    Legal text that must be agreed to prior to accessing Bundle.
    color_left string
    Page link and button color
    color_link string
    Top bar link color
    color_text string
    Page link and button color
    color_top string
    Top bar background color
    color_top_text string
    Top bar text color
    created_at string
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at string
    Bundle deleted at date/time
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    form_field_set string
    Custom Form to use
    has_inbox bool
    Does this bundle have an associated inbox?
    id string
    The provider-assigned unique ID for this managed resource.
    password_protected bool
    Is this bundle password protected?
    preview_only bool
    requested_upload_slots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    url string
    Public URL of Share Link
    username string
    Bundle creator username
    watermark_attachment string
    Preview watermark image applied to all bundle items.
    watermark_value any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    bundlepaths Object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    formFieldSet String
    Custom Form to use
    hasInbox Boolean
    Does this bundle have an associated inbox?
    id String
    The provider-assigned unique ID for this managed resource.
    passwordProtected Boolean
    Is this bundle password protected?
    previewOnly Boolean
    requestedUploadSlots Object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    url String
    Public URL of Share Link
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    clickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    colorLeft string
    Page link and button color
    colorLink string
    Top bar link color
    colorText string
    Page link and button color
    colorTop string
    Top bar background color
    colorTopText string
    Top bar text color
    createdAt string
    Bundle created at date/time
    deleted boolean
    Indicates if the bundle has been deleted.
    deletedAt string
    Bundle deleted at date/time
    dontAllowFoldersInUploads boolean
    Should folder uploads be prevented?
    formFieldSet string
    Custom Form to use
    hasInbox boolean
    Does this bundle have an associated inbox?
    id string
    The provider-assigned unique ID for this managed resource.
    passwordProtected boolean
    Is this bundle password protected?
    previewOnly boolean
    requestedUploadSlots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    url string
    Public URL of Share Link
    username string
    Bundle creator username
    watermarkAttachment string
    Preview watermark image applied to all bundle items.
    watermarkValue any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    clickwrap_body str
    Legal text that must be agreed to prior to accessing Bundle.
    color_left str
    Page link and button color
    color_link str
    Top bar link color
    color_text str
    Page link and button color
    color_top str
    Top bar background color
    color_top_text str
    Top bar text color
    created_at str
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at str
    Bundle deleted at date/time
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    form_field_set str
    Custom Form to use
    has_inbox bool
    Does this bundle have an associated inbox?
    id str
    The provider-assigned unique ID for this managed resource.
    password_protected bool
    Is this bundle password protected?
    preview_only bool
    requested_upload_slots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    url str
    Public URL of Share Link
    username str
    Bundle creator username
    watermark_attachment str
    Preview watermark image applied to all bundle items.
    watermark_value Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    formFieldSet String
    Custom Form to use
    hasInbox Boolean
    Does this bundle have an associated inbox?
    id String
    The provider-assigned unique ID for this managed resource.
    passwordProtected Boolean
    Is this bundle password protected?
    previewOnly Boolean
    requestedUploadSlots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    url String
    Public URL of Share Link
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

    Look up Existing Bundle Resource

    Get an existing Bundle 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?: BundleState, opts?: CustomResourceOptions): Bundle
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bundlepaths: Optional[Any] = None,
        bypasses_site_expiration_rules: Optional[bool] = None,
        clickwrap_body: Optional[str] = None,
        clickwrap_id: Optional[int] = None,
        code: Optional[str] = None,
        color_left: Optional[str] = None,
        color_link: Optional[str] = None,
        color_text: Optional[str] = None,
        color_top: Optional[str] = None,
        color_top_text: Optional[str] = None,
        create_snapshot: Optional[bool] = None,
        created_at: Optional[str] = None,
        deleted: Optional[bool] = None,
        deleted_at: Optional[str] = None,
        description: Optional[str] = None,
        dont_allow_folders_in_uploads: Optional[bool] = None,
        dont_separate_submissions_by_folder: Optional[bool] = None,
        expires_at: Optional[str] = None,
        finalize_snapshot: Optional[bool] = None,
        form_field_set: Optional[str] = None,
        form_field_set_id: Optional[int] = None,
        group_id: Optional[int] = None,
        has_inbox: Optional[bool] = None,
        inbox_id: Optional[int] = None,
        internal_name: Optional[str] = None,
        max_uses: Optional[int] = None,
        note: Optional[str] = None,
        password: Optional[str] = None,
        password_protected: Optional[bool] = None,
        path_template: Optional[str] = None,
        path_template_time_zone: Optional[str] = None,
        paths: Optional[Sequence[str]] = None,
        permissions: Optional[str] = None,
        preview_only: Optional[bool] = None,
        requested_upload_slots: Optional[Any] = None,
        require_logout: Optional[bool] = None,
        require_registration: Optional[bool] = None,
        require_share_recipient: Optional[bool] = None,
        send_email_receipt_to_uploader: Optional[bool] = None,
        send_one_time_password_to_recipient_at_registration: Optional[bool] = None,
        skip_company: Optional[bool] = None,
        skip_email: Optional[bool] = None,
        skip_name: Optional[bool] = None,
        snapshot_id: Optional[int] = None,
        start_access_on_date: Optional[str] = None,
        url: Optional[str] = None,
        user_id: Optional[int] = None,
        username: Optional[str] = None,
        watermark_attachment: Optional[str] = None,
        watermark_value: Optional[Any] = None,
        workspace_id: Optional[int] = None) -> Bundle
    func GetBundle(ctx *Context, name string, id IDInput, state *BundleState, opts ...ResourceOption) (*Bundle, error)
    public static Bundle Get(string name, Input<string> id, BundleState? state, CustomResourceOptions? opts = null)
    public static Bundle get(String name, Output<String> id, BundleState state, CustomResourceOptions options)
    resources:  _:    type: filescom:Bundle    get:      id: ${id}
    import {
  to = filescom_bundle.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:
    Bundlepaths object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreateSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    Description string
    Public description
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FinalizeSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    FormFieldSet string
    Custom Form to use
    FormFieldSetId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    HasInbox bool
    Does this bundle have an associated inbox?
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    PasswordProtected bool
    Is this bundle password protected?
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Paths List<string>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    PreviewOnly bool
    RequestedUploadSlots object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    Url string
    Public URL of Share Link
    UserId int
    Bundle creator user ID
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Bundlepaths interface{}
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    BypassesSiteExpirationRules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    ClickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    ClickwrapId int
    ID of the clickwrap to use with this bundle.
    Code string
    Bundle code. This code forms the end part of the Public URL.
    ColorLeft string
    Page link and button color
    ColorLink string
    Top bar link color
    ColorText string
    Page link and button color
    ColorTop string
    Top bar background color
    ColorTopText string
    Top bar text color
    CreateSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    CreatedAt string
    Bundle created at date/time
    Deleted bool
    Indicates if the bundle has been deleted.
    DeletedAt string
    Bundle deleted at date/time
    Description string
    Public description
    DontAllowFoldersInUploads bool
    Should folder uploads be prevented?
    DontSeparateSubmissionsByFolder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    ExpiresAt string
    Bundle expiration date/time
    FinalizeSnapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    FormFieldSet string
    Custom Form to use
    FormFieldSetId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    GroupId int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    HasInbox bool
    Does this bundle have an associated inbox?
    InboxId int
    ID of the associated inbox, if available.
    InternalName string
    Internal name for identifying this Share Link.
    MaxUses int
    Maximum number of times bundle can be accessed
    Note string
    Bundle internal note
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    PasswordProtected bool
    Is this bundle password protected?
    PathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    PathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    Paths []string
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    Permissions string
    Permissions that apply to Folders in this Share Link.
    PreviewOnly bool
    RequestedUploadSlots interface{}
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    RequireLogout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    RequireRegistration bool
    Show a registration page that captures the downloader's name and email address?
    RequireShareRecipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    SendEmailReceiptToUploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    SendOneTimePasswordToRecipientAtRegistration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    SkipCompany bool
    BundleRegistrations can be saved without providing company?
    SkipEmail bool
    BundleRegistrations can be saved without providing email?
    SkipName bool
    BundleRegistrations can be saved without providing name?
    SnapshotId int
    ID of the snapshot containing this bundle's contents.
    StartAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    Url string
    Public URL of Share Link
    UserId int
    Bundle creator user ID
    Username string
    Bundle creator username
    WatermarkAttachment string
    Preview watermark image applied to all bundle items.
    WatermarkValue interface{}
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_body string
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrap_id number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    color_left string
    Page link and button color
    color_link string
    Top bar link color
    color_text string
    Page link and button color
    color_top string
    Top bar background color
    color_top_text string
    Top bar text color
    create_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    created_at string
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at string
    Bundle deleted at date/time
    description string
    Public description
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at string
    Bundle expiration date/time
    finalize_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    form_field_set string
    Custom Form to use
    form_field_set_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    group_id number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    has_inbox bool
    Does this bundle have an associated inbox?
    inbox_id number
    ID of the associated inbox, if available.
    internal_name string
    Internal name for identifying this Share Link.
    max_uses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    password_protected bool
    Is this bundle password protected?
    path_template string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone string
    Timezone to use when rendering timestamps in path templates.
    paths list(string)
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions string
    Permissions that apply to Folders in this Share Link.
    preview_only bool
    requested_upload_slots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id number
    ID of the snapshot containing this bundle's contents.
    start_access_on_date string
    Date when share will start to be accessible. If nil access granted right after create.
    url string
    Public URL of Share Link
    user_id number
    Bundle creator user ID
    username string
    Bundle creator username
    watermark_attachment string
    Preview watermark image applied to all bundle items.
    watermark_value any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspace_id number
    Workspace ID. 0 means the default workspace.
    bundlepaths Object
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId Integer
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    description String
    Public description
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    finalizeSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSet String
    Custom Form to use
    formFieldSetId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId Integer
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox Boolean
    Does this bundle have an associated inbox?
    inboxId Integer
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Integer
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    passwordProtected Boolean
    Is this bundle password protected?
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions String
    Permissions that apply to Folders in this Share Link.
    previewOnly Boolean
    requestedUploadSlots Object
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Integer
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    url String
    Public URL of Share Link
    userId Integer
    Bundle creator user ID
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Object
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    bundlepaths any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody string
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId number
    ID of the clickwrap to use with this bundle.
    code string
    Bundle code. This code forms the end part of the Public URL.
    colorLeft string
    Page link and button color
    colorLink string
    Top bar link color
    colorText string
    Page link and button color
    colorTop string
    Top bar background color
    colorTopText string
    Top bar text color
    createSnapshot boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    createdAt string
    Bundle created at date/time
    deleted boolean
    Indicates if the bundle has been deleted.
    deletedAt string
    Bundle deleted at date/time
    description string
    Public description
    dontAllowFoldersInUploads boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt string
    Bundle expiration date/time
    finalizeSnapshot boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSet string
    Custom Form to use
    formFieldSetId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox boolean
    Does this bundle have an associated inbox?
    inboxId number
    ID of the associated inbox, if available.
    internalName string
    Internal name for identifying this Share Link.
    maxUses number
    Maximum number of times bundle can be accessed
    note string
    Bundle internal note
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    passwordProtected boolean
    Is this bundle password protected?
    pathTemplate string
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone string
    Timezone to use when rendering timestamps in path templates.
    paths string[]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions string
    Permissions that apply to Folders in this Share Link.
    previewOnly boolean
    requestedUploadSlots any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany boolean
    BundleRegistrations can be saved without providing company?
    skipEmail boolean
    BundleRegistrations can be saved without providing email?
    skipName boolean
    BundleRegistrations can be saved without providing name?
    snapshotId number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate string
    Date when share will start to be accessible. If nil access granted right after create.
    url string
    Public URL of Share Link
    userId number
    Bundle creator user ID
    username string
    Bundle creator username
    watermarkAttachment string
    Preview watermark image applied to all bundle items.
    watermarkValue any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId number
    Workspace ID. 0 means the default workspace.
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypasses_site_expiration_rules bool
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrap_body str
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrap_id int
    ID of the clickwrap to use with this bundle.
    code str
    Bundle code. This code forms the end part of the Public URL.
    color_left str
    Page link and button color
    color_link str
    Top bar link color
    color_text str
    Page link and button color
    color_top str
    Top bar background color
    color_top_text str
    Top bar text color
    create_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    created_at str
    Bundle created at date/time
    deleted bool
    Indicates if the bundle has been deleted.
    deleted_at str
    Bundle deleted at date/time
    description str
    Public description
    dont_allow_folders_in_uploads bool
    Should folder uploads be prevented?
    dont_separate_submissions_by_folder bool
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expires_at str
    Bundle expiration date/time
    finalize_snapshot bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    form_field_set str
    Custom Form to use
    form_field_set_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    group_id int
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    has_inbox bool
    Does this bundle have an associated inbox?
    inbox_id int
    ID of the associated inbox, if available.
    internal_name str
    Internal name for identifying this Share Link.
    max_uses int
    Maximum number of times bundle can be accessed
    note str
    Bundle internal note
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    password_protected bool
    Is this bundle password protected?
    path_template str
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    path_template_time_zone str
    Timezone to use when rendering timestamps in path templates.
    paths Sequence[str]
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions str
    Permissions that apply to Folders in this Share Link.
    preview_only bool
    requested_upload_slots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    require_logout bool
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    require_registration bool
    Show a registration page that captures the downloader's name and email address?
    require_share_recipient bool
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    send_email_receipt_to_uploader bool
    Send delivery receipt to the uploader. Note: For writable share only
    send_one_time_password_to_recipient_at_registration bool
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skip_company bool
    BundleRegistrations can be saved without providing company?
    skip_email bool
    BundleRegistrations can be saved without providing email?
    skip_name bool
    BundleRegistrations can be saved without providing name?
    snapshot_id int
    ID of the snapshot containing this bundle's contents.
    start_access_on_date str
    Date when share will start to be accessible. If nil access granted right after create.
    url str
    Public URL of Share Link
    user_id int
    Bundle creator user ID
    username str
    Bundle creator username
    watermark_attachment str
    Preview watermark image applied to all bundle items.
    watermark_value Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspace_id int
    Workspace ID. 0 means the default workspace.
    bundlepaths Any
    A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    bypassesSiteExpirationRules Boolean
    If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
    clickwrapBody String
    Legal text that must be agreed to prior to accessing Bundle.
    clickwrapId Number
    ID of the clickwrap to use with this bundle.
    code String
    Bundle code. This code forms the end part of the Public URL.
    colorLeft String
    Page link and button color
    colorLink String
    Top bar link color
    colorText String
    Page link and button color
    colorTop String
    Top bar background color
    colorTopText String
    Top bar text color
    createSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, create a snapshot of this bundle's contents.
    createdAt String
    Bundle created at date/time
    deleted Boolean
    Indicates if the bundle has been deleted.
    deletedAt String
    Bundle deleted at date/time
    description String
    Public description
    dontAllowFoldersInUploads Boolean
    Should folder uploads be prevented?
    dontSeparateSubmissionsByFolder Boolean
    Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
    expiresAt String
    Bundle expiration date/time
    finalizeSnapshot Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, finalize the snapshot of this bundle's contents. Note that createSnapshot must also be true.
    formFieldSet String
    Custom Form to use
    formFieldSetId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Id of Form Field Set to use with this bundle
    groupId Number
    Owning group ID. If set, members of this group can view, edit, and share this Share Link.
    hasInbox Boolean
    Does this bundle have an associated inbox?
    inboxId Number
    ID of the associated inbox, if available.
    internalName String
    Internal name for identifying this Share Link.
    maxUses Number
    Maximum number of times bundle can be accessed
    note String
    Bundle internal note
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for this bundle.
    passwordProtected Boolean
    Is this bundle password protected?
    pathTemplate String
    Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
    pathTemplateTimeZone String
    Timezone to use when rendering timestamps in path templates.
    paths List<String>
    A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
    permissions String
    Permissions that apply to Folders in this Share Link.
    previewOnly Boolean
    requestedUploadSlots Any
    Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.
    requireLogout Boolean
    If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
    requireRegistration Boolean
    Show a registration page that captures the downloader's name and email address?
    requireShareRecipient Boolean
    Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
    sendEmailReceiptToUploader Boolean
    Send delivery receipt to the uploader. Note: For writable share only
    sendOneTimePasswordToRecipientAtRegistration Boolean
    If true, requireShareRecipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
    skipCompany Boolean
    BundleRegistrations can be saved without providing company?
    skipEmail Boolean
    BundleRegistrations can be saved without providing email?
    skipName Boolean
    BundleRegistrations can be saved without providing name?
    snapshotId Number
    ID of the snapshot containing this bundle's contents.
    startAccessOnDate String
    Date when share will start to be accessible. If nil access granted right after create.
    url String
    Public URL of Share Link
    userId Number
    Bundle creator user ID
    username String
    Bundle creator username
    watermarkAttachment String
    Preview watermark image applied to all bundle items.
    watermarkValue Any
    Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Import

    The pulumi import command can be used, for example:

    Bundles can be imported by specifying the id.

    $ pulumi import filescom:index/bundle:Bundle example_bundle 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