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

filescom.ShareGroup

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

    A ShareGroup is a way for you to store and name groups of email contacts to be used for sending share and inbox invitations.

    Example Usage

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

const exampleShareGroup = new filescom.ShareGroup("example_share_group", {
    userId: 1,
    notes: "This group is defined for testing purposes",
    name: "Test group 1",
    members: [{
        name: "John Doe",
        company: "Acme Ltd",
        email: "johndoe@gmail.com",
    }],
});

    import pulumi
import pulumi_filescom as filescom

example_share_group = filescom.ShareGroup("example_share_group",
    user_id=1,
    notes="This group is defined for testing purposes",
    name="Test group 1",
    members=[{
        "name": "John Doe",
        "company": "Acme Ltd",
        "email": "johndoe@gmail.com",
    }])

    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.NewShareGroup(ctx, "example_share_group", &filescom.ShareGroupArgs{
			UserId: pulumi.Int(1),
			Notes:  pulumi.String("This group is defined for testing purposes"),
			Name:   pulumi.String("Test group 1"),
			Members: pulumi.Any{
				map[string]string{
					"name":    "John Doe",
					"company": "Acme Ltd",
					"email":   "johndoe@gmail.com",
				},
			},
		})
		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 exampleShareGroup = new Filescom.ShareGroup("example_share_group", new()
    {
        UserId = 1,
        Notes = "This group is defined for testing purposes",
        Name = "Test group 1",
        Members = new[]
        {
            
            {
                { "name", "John Doe" },
                { "company", "Acme Ltd" },
                { "email", "johndoe@gmail.com" },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.ShareGroup;
import com.pulumi.filescom.ShareGroupArgs;
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 exampleShareGroup = new ShareGroup("exampleShareGroup", ShareGroupArgs.builder()
            .userId(1)
            .notes("This group is defined for testing purposes")
            .name("Test group 1")
            .members(Map.ofEntries(
                Map.entry("name", "John Doe"),
                Map.entry("company", "Acme Ltd"),
                Map.entry("email", "johndoe@gmail.com")
            ))
            .build());

    }
}

    resources:
  exampleShareGroup:
    type: filescom:ShareGroup
    name: example_share_group
    properties:
      userId: 1
      notes: This group is defined for testing purposes
      name: Test group 1
      members:
        - name: John Doe
          company: Acme Ltd
          email: johndoe@gmail.com

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

resource "filescom_sharegroup" "example_share_group" {
  user_id = 1
  notes   = "This group is defined for testing purposes"
  name    = "Test group 1"
  members = [{
    "name"    = "John Doe"
    "company" = "Acme Ltd"
    "email"   = "johndoe@gmail.com"
  }]
}

    Create ShareGroup Resource

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

    Constructor syntax

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

@overload
def ShareGroup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               members: Optional[Any] = None,
               name: Optional[str] = None,
               notes: Optional[str] = None,
               user_id: Optional[int] = None)
    func NewShareGroup(ctx *Context, name string, args ShareGroupArgs, opts ...ResourceOption) (*ShareGroup, error)
    public ShareGroup(string name, ShareGroupArgs args, CustomResourceOptions? opts = null)
    public ShareGroup(String name, ShareGroupArgs args)
public ShareGroup(String name, ShareGroupArgs args, CustomResourceOptions options)

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


    resource "filescom_share_group" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ShareGroupArgs
    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 ShareGroupArgs
    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 ShareGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShareGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShareGroupArgs
    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 shareGroupResource = new Filescom.ShareGroup("shareGroupResource", new()
{
    Members = "any",
    Name = "string",
    Notes = "string",
    UserId = 0,
});

    example, err := filescom.NewShareGroup(ctx, "shareGroupResource", &filescom.ShareGroupArgs{
	Members: pulumi.Any("any"),
	Name:    pulumi.String("string"),
	Notes:   pulumi.String("string"),
	UserId:  pulumi.Int(0),
})

    resource "filescom_share_group" "shareGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  members = "any"
  name    = "string"
  notes   = "string"
  user_id = 0
}

    var shareGroupResource = new ShareGroup("shareGroupResource", ShareGroupArgs.builder()
    .members("any")
    .name("string")
    .notes("string")
    .userId(0)
    .build());

    share_group_resource = filescom.ShareGroup("shareGroupResource",
    members="any",
    name="string",
    notes="string",
    user_id=0)

    const shareGroupResource = new filescom.ShareGroup("shareGroupResource", {
    members: "any",
    name: "string",
    notes: "string",
    userId: 0,
});

    type: filescom:ShareGroup
properties:
    members: any
    name: string
    notes: string
    userId: 0

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

    Members object
    A list of share group members
    Name string
    Name of the share group
    Notes string
    Additional notes of the share group
    UserId int
    Owner User ID
    Members interface{}
    A list of share group members
    Name string
    Name of the share group
    Notes string
    Additional notes of the share group
    UserId int
    Owner User ID
    members any
    A list of share group members
    name string
    Name of the share group
    notes string
    Additional notes of the share group
    user_id number
    Owner User ID
    members Object
    A list of share group members
    name String
    Name of the share group
    notes String
    Additional notes of the share group
    userId Integer
    Owner User ID
    members any
    A list of share group members
    name string
    Name of the share group
    notes string
    Additional notes of the share group
    userId number
    Owner User ID
    members Any
    A list of share group members
    name str
    Name of the share group
    notes str
    Additional notes of the share group
    user_id int
    Owner User ID
    members Any
    A list of share group members
    name String
    Name of the share group
    notes String
    Additional notes of the share group
    userId Number
    Owner User ID

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ShareGroup Resource

    Get an existing ShareGroup 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?: ShareGroupState, opts?: CustomResourceOptions): ShareGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        members: Optional[Any] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        user_id: Optional[int] = None) -> ShareGroup
    func GetShareGroup(ctx *Context, name string, id IDInput, state *ShareGroupState, opts ...ResourceOption) (*ShareGroup, error)
    public static ShareGroup Get(string name, Input<string> id, ShareGroupState? state, CustomResourceOptions? opts = null)
    public static ShareGroup get(String name, Output<String> id, ShareGroupState state, CustomResourceOptions options)
    resources:  _:    type: filescom:ShareGroup    get:      id: ${id}
    import {
  to = filescom_share_group.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:
    Members object
    A list of share group members
    Name string
    Name of the share group
    Notes string
    Additional notes of the share group
    UserId int
    Owner User ID
    Members interface{}
    A list of share group members
    Name string
    Name of the share group
    Notes string
    Additional notes of the share group
    UserId int
    Owner User ID
    members any
    A list of share group members
    name string
    Name of the share group
    notes string
    Additional notes of the share group
    user_id number
    Owner User ID
    members Object
    A list of share group members
    name String
    Name of the share group
    notes String
    Additional notes of the share group
    userId Integer
    Owner User ID
    members any
    A list of share group members
    name string
    Name of the share group
    notes string
    Additional notes of the share group
    userId number
    Owner User ID
    members Any
    A list of share group members
    name str
    Name of the share group
    notes str
    Additional notes of the share group
    user_id int
    Owner User ID
    members Any
    A list of share group members
    name String
    Name of the share group
    notes String
    Additional notes of the share group
    userId Number
    Owner User ID

    Import

    The pulumi import command can be used, for example:

    Share Groups can be imported by specifying the id.

    $ pulumi import filescom:index/shareGroup:ShareGroup example_share_group 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