1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getSnapshot
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    Snapshots allow you to create a read-only archive of files at a specific point in time. You can define a snapshot, add files to it, and then finalize it. Once finalized, the snapshot’s contents are immutable.

    Each snapshot may have an expiration date. When the expiration date is reached, the snapshot is automatically deleted from the Files.com platform.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleSnapshot = filescom.getSnapshot({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_snapshot = filescom.get_snapshot(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.GetSnapshot(ctx, &filescom.LookupSnapshotArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleSnapshot = Filescom.GetSnapshot.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetSnapshotArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleSnapshot = FilescomFunctions.getSnapshot(GetSnapshotArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleSnapshot:
        fn::invoke:
          function: filescom:getSnapshot
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getsnapshot" "exampleSnapshot" {
      id = 1
    }
    

    Using getSnapshot

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

    function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
    function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetSnapshotResult>
    def get_snapshot(id: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(id: pulumi.Input[Optional[int]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
    func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

    public static class GetSnapshot 
    {
        public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getSnapshot:getSnapshot
      arguments:
        # arguments dictionary
    data "filescom_get_snapshot" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    The snapshot's unique ID.
    Id int
    The snapshot's unique ID.
    id number
    The snapshot's unique ID.
    id Integer
    The snapshot's unique ID.
    id number
    The snapshot's unique ID.
    id int
    The snapshot's unique ID.
    id Number
    The snapshot's unique ID.

    getSnapshot Result

    The following output properties are available:

    BundleId int
    The bundle using this snapshot, if applicable.
    ExpiresAt string
    When the snapshot expires.
    FinalizedAt string
    When the snapshot was finalized.
    Id int
    The snapshot's unique ID.
    Name string
    A name for the snapshot.
    UserId int
    The user that created this snapshot, if applicable.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    BundleId int
    The bundle using this snapshot, if applicable.
    ExpiresAt string
    When the snapshot expires.
    FinalizedAt string
    When the snapshot was finalized.
    Id int
    The snapshot's unique ID.
    Name string
    A name for the snapshot.
    UserId int
    The user that created this snapshot, if applicable.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    bundle_id number
    The bundle using this snapshot, if applicable.
    expires_at string
    When the snapshot expires.
    finalized_at string
    When the snapshot was finalized.
    id number
    The snapshot's unique ID.
    name string
    A name for the snapshot.
    user_id number
    The user that created this snapshot, if applicable.
    workspace_id number
    Workspace ID. 0 means the default workspace.
    bundleId Integer
    The bundle using this snapshot, if applicable.
    expiresAt String
    When the snapshot expires.
    finalizedAt String
    When the snapshot was finalized.
    id Integer
    The snapshot's unique ID.
    name String
    A name for the snapshot.
    userId Integer
    The user that created this snapshot, if applicable.
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    bundleId number
    The bundle using this snapshot, if applicable.
    expiresAt string
    When the snapshot expires.
    finalizedAt string
    When the snapshot was finalized.
    id number
    The snapshot's unique ID.
    name string
    A name for the snapshot.
    userId number
    The user that created this snapshot, if applicable.
    workspaceId number
    Workspace ID. 0 means the default workspace.
    bundle_id int
    The bundle using this snapshot, if applicable.
    expires_at str
    When the snapshot expires.
    finalized_at str
    When the snapshot was finalized.
    id int
    The snapshot's unique ID.
    name str
    A name for the snapshot.
    user_id int
    The user that created this snapshot, if applicable.
    workspace_id int
    Workspace ID. 0 means the default workspace.
    bundleId Number
    The bundle using this snapshot, if applicable.
    expiresAt String
    When the snapshot expires.
    finalizedAt String
    When the snapshot was finalized.
    id Number
    The snapshot's unique ID.
    name String
    A name for the snapshot.
    userId Number
    The user that created this snapshot, if applicable.
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial