1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. CustomDomain
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

    A CustomDomain object represents an additional customer-owned domain that routes to a Files.com site.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleCustomDomain = new filescom.CustomDomain("example_custom_domain", {
        destination: "site_alias",
        folderBehaviorId: 1,
        sslCertificateId: 1,
        domain: "files.example.com",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_custom_domain = filescom.CustomDomain("example_custom_domain",
        destination="site_alias",
        folder_behavior_id=1,
        ssl_certificate_id=1,
        domain="files.example.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.NewCustomDomain(ctx, "example_custom_domain", &filescom.CustomDomainArgs{
    			Destination:      pulumi.String("site_alias"),
    			FolderBehaviorId: pulumi.Int(1),
    			SslCertificateId: pulumi.Int(1),
    			Domain:           pulumi.String("files.example.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 exampleCustomDomain = new Filescom.CustomDomain("example_custom_domain", new()
        {
            Destination = "site_alias",
            FolderBehaviorId = 1,
            SslCertificateId = 1,
            Domain = "files.example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.CustomDomain;
    import com.pulumi.filescom.CustomDomainArgs;
    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 exampleCustomDomain = new CustomDomain("exampleCustomDomain", CustomDomainArgs.builder()
                .destination("site_alias")
                .folderBehaviorId(1)
                .sslCertificateId(1)
                .domain("files.example.com")
                .build());
    
        }
    }
    
    resources:
      exampleCustomDomain:
        type: filescom:CustomDomain
        name: example_custom_domain
        properties:
          destination: site_alias
          folderBehaviorId: 1
          sslCertificateId: 1
          domain: files.example.com
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_customdomain" "example_custom_domain" {
      destination        = "site_alias"
      folder_behavior_id = 1
      ssl_certificate_id = 1
      domain             = "files.example.com"
    }
    

    Create CustomDomain Resource

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

    Constructor syntax

    new CustomDomain(name: string, args: CustomDomainArgs, opts?: CustomResourceOptions);
    @overload
    def CustomDomain(resource_name: str,
                     args: CustomDomainArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomDomain(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     domain: Optional[str] = None,
                     destination: Optional[str] = None,
                     folder_behavior_id: Optional[int] = None,
                     ssl_certificate_id: Optional[int] = None)
    func NewCustomDomain(ctx *Context, name string, args CustomDomainArgs, opts ...ResourceOption) (*CustomDomain, error)
    public CustomDomain(string name, CustomDomainArgs args, CustomResourceOptions? opts = null)
    public CustomDomain(String name, CustomDomainArgs args)
    public CustomDomain(String name, CustomDomainArgs args, CustomResourceOptions options)
    
    type: filescom:CustomDomain
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_custom_domain" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CustomDomainArgs
    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 CustomDomainArgs
    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 CustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDomainArgs
    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 customDomainResource = new Filescom.CustomDomain("customDomainResource", new()
    {
        Domain = "string",
        Destination = "string",
        FolderBehaviorId = 0,
        SslCertificateId = 0,
    });
    
    example, err := filescom.NewCustomDomain(ctx, "customDomainResource", &filescom.CustomDomainArgs{
    	Domain:           pulumi.String("string"),
    	Destination:      pulumi.String("string"),
    	FolderBehaviorId: pulumi.Int(0),
    	SslCertificateId: pulumi.Int(0),
    })
    
    resource "filescom_custom_domain" "customDomainResource" {
      lifecycle {
        create_before_destroy = true
      }
      domain             = "string"
      destination        = "string"
      folder_behavior_id = 0
      ssl_certificate_id = 0
    }
    
    var customDomainResource = new CustomDomain("customDomainResource", CustomDomainArgs.builder()
        .domain("string")
        .destination("string")
        .folderBehaviorId(0)
        .sslCertificateId(0)
        .build());
    
    custom_domain_resource = filescom.CustomDomain("customDomainResource",
        domain="string",
        destination="string",
        folder_behavior_id=0,
        ssl_certificate_id=0)
    
    const customDomainResource = new filescom.CustomDomain("customDomainResource", {
        domain: "string",
        destination: "string",
        folderBehaviorId: 0,
        sslCertificateId: 0,
    });
    
    type: filescom:CustomDomain
    properties:
        destination: string
        domain: string
        folderBehaviorId: 0
        sslCertificateId: 0
    

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

    Domain string
    Customer-owned domain name.
    Destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    FolderBehaviorId int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    SslCertificateId int
    Current SSL certificate ID.
    Domain string
    Customer-owned domain name.
    Destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    FolderBehaviorId int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    SslCertificateId int
    Current SSL certificate ID.
    domain string
    Customer-owned domain name.
    destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    folder_behavior_id number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    ssl_certificate_id number
    Current SSL certificate ID.
    domain String
    Customer-owned domain name.
    destination String
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    folderBehaviorId Integer
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId Integer
    Current SSL certificate ID.
    domain string
    Customer-owned domain name.
    destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    folderBehaviorId number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId number
    Current SSL certificate ID.
    domain str
    Customer-owned domain name.
    destination str
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    folder_behavior_id int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    ssl_certificate_id int
    Current SSL certificate ID.
    domain String
    Customer-owned domain name.
    destination String
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    folderBehaviorId Number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId Number
    Current SSL certificate ID.

    Outputs

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

    BrickManaged bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    CreatedAt string
    When this Custom Domain was created.
    DnsStatus string
    Current DNS verification status.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    When this Custom Domain was last updated.
    BrickManaged bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    CreatedAt string
    When this Custom Domain was created.
    DnsStatus string
    Current DNS verification status.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    When this Custom Domain was last updated.
    brick_managed bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    created_at string
    When this Custom Domain was created.
    dns_status string
    Current DNS verification status.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    When this Custom Domain was last updated.
    brickManaged Boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt String
    When this Custom Domain was created.
    dnsStatus String
    Current DNS verification status.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    When this Custom Domain was last updated.
    brickManaged boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt string
    When this Custom Domain was created.
    dnsStatus string
    Current DNS verification status.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    When this Custom Domain was last updated.
    brick_managed bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    created_at str
    When this Custom Domain was created.
    dns_status str
    Current DNS verification status.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    When this Custom Domain was last updated.
    brickManaged Boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt String
    When this Custom Domain was created.
    dnsStatus String
    Current DNS verification status.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    When this Custom Domain was last updated.

    Look up Existing CustomDomain Resource

    Get an existing CustomDomain 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?: CustomDomainState, opts?: CustomResourceOptions): CustomDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            brick_managed: Optional[bool] = None,
            created_at: Optional[str] = None,
            destination: Optional[str] = None,
            dns_status: Optional[str] = None,
            domain: Optional[str] = None,
            folder_behavior_id: Optional[int] = None,
            ssl_certificate_id: Optional[int] = None,
            updated_at: Optional[str] = None) -> CustomDomain
    func GetCustomDomain(ctx *Context, name string, id IDInput, state *CustomDomainState, opts ...ResourceOption) (*CustomDomain, error)
    public static CustomDomain Get(string name, Input<string> id, CustomDomainState? state, CustomResourceOptions? opts = null)
    public static CustomDomain get(String name, Output<String> id, CustomDomainState state, CustomResourceOptions options)
    resources:  _:    type: filescom:CustomDomain    get:      id: ${id}
    import {
      to = filescom_custom_domain.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:
    BrickManaged bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    CreatedAt string
    When this Custom Domain was created.
    Destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    DnsStatus string
    Current DNS verification status.
    Domain string
    Customer-owned domain name.
    FolderBehaviorId int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    SslCertificateId int
    Current SSL certificate ID.
    UpdatedAt string
    When this Custom Domain was last updated.
    BrickManaged bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    CreatedAt string
    When this Custom Domain was created.
    Destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    DnsStatus string
    Current DNS verification status.
    Domain string
    Customer-owned domain name.
    FolderBehaviorId int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    SslCertificateId int
    Current SSL certificate ID.
    UpdatedAt string
    When this Custom Domain was last updated.
    brick_managed bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    created_at string
    When this Custom Domain was created.
    destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    dns_status string
    Current DNS verification status.
    domain string
    Customer-owned domain name.
    folder_behavior_id number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    ssl_certificate_id number
    Current SSL certificate ID.
    updated_at string
    When this Custom Domain was last updated.
    brickManaged Boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt String
    When this Custom Domain was created.
    destination String
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    dnsStatus String
    Current DNS verification status.
    domain String
    Customer-owned domain name.
    folderBehaviorId Integer
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId Integer
    Current SSL certificate ID.
    updatedAt String
    When this Custom Domain was last updated.
    brickManaged boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt string
    When this Custom Domain was created.
    destination string
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    dnsStatus string
    Current DNS verification status.
    domain string
    Customer-owned domain name.
    folderBehaviorId number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId number
    Current SSL certificate ID.
    updatedAt string
    When this Custom Domain was last updated.
    brick_managed bool
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    created_at str
    When this Custom Domain was created.
    destination str
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    dns_status str
    Current DNS verification status.
    domain str
    Customer-owned domain name.
    folder_behavior_id int
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    ssl_certificate_id int
    Current SSL certificate ID.
    updated_at str
    When this Custom Domain was last updated.
    brickManaged Boolean
    Is this domain's SSL certificate automatically managed and renewed by Files.com?
    createdAt String
    When this Custom Domain was created.
    destination String
    Where this custom domain routes. Can be siteAlias, publicHosting, s3Endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound publicHosting folder behavior is deleted, and can be set manually via the API for any reason.
    dnsStatus String
    Current DNS verification status.
    domain String
    Customer-owned domain name.
    folderBehaviorId Number
    Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
    sslCertificateId Number
    Current SSL certificate ID.
    updatedAt String
    When this Custom Domain was last updated.

    Import

    The pulumi import command can be used, for example:

    Custom Domains can be imported by specifying the id.

    $ pulumi import filescom:index/customDomain:CustomDomain example_custom_domain 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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial