published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
A FileComment is a comment attached to a file by a user.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";
const exampleFileComment = new filescom.FileComment("example_file_comment", {
body: "What a great file!",
path: "path",
});
import pulumi
import pulumi_filescom as filescom
example_file_comment = filescom.FileComment("example_file_comment",
body="What a great file!",
path="path")
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.NewFileComment(ctx, "example_file_comment", &filescom.FileCommentArgs{
Body: pulumi.String("What a great file!"),
Path: pulumi.String("path"),
})
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 exampleFileComment = new Filescom.FileComment("example_file_comment", new()
{
Body = "What a great file!",
Path = "path",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FileComment;
import com.pulumi.filescom.FileCommentArgs;
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 exampleFileComment = new FileComment("exampleFileComment", FileCommentArgs.builder()
.body("What a great file!")
.path("path")
.build());
}
}
resources:
exampleFileComment:
type: filescom:FileComment
name: example_file_comment
properties:
body: What a great file!
path: path
pulumi {
required_providers {
filescom = {
source = "pulumi/filescom"
}
}
}
resource "filescom_filecomment" "example_file_comment" {
body = "What a great file!"
path = "path"
}
Create FileComment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FileComment(name: string, args: FileCommentArgs, opts?: CustomResourceOptions);@overload
def FileComment(resource_name: str,
args: FileCommentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FileComment(resource_name: str,
opts: Optional[ResourceOptions] = None,
body: Optional[str] = None,
path: Optional[str] = None)func NewFileComment(ctx *Context, name string, args FileCommentArgs, opts ...ResourceOption) (*FileComment, error)public FileComment(string name, FileCommentArgs args, CustomResourceOptions? opts = null)
public FileComment(String name, FileCommentArgs args)
public FileComment(String name, FileCommentArgs args, CustomResourceOptions options)
type: filescom:FileComment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "filescom_file_comment" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args FileCommentArgs
- 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 FileCommentArgs
- 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 FileCommentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileCommentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FileCommentArgs
- 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 fileCommentResource = new Filescom.FileComment("fileCommentResource", new()
{
Body = "string",
Path = "string",
});
example, err := filescom.NewFileComment(ctx, "fileCommentResource", &filescom.FileCommentArgs{
Body: pulumi.String("string"),
Path: pulumi.String("string"),
})
resource "filescom_file_comment" "fileCommentResource" {
lifecycle {
create_before_destroy = true
}
body = "string"
path = "string"
}
var fileCommentResource = new FileComment("fileCommentResource", FileCommentArgs.builder()
.body("string")
.path("string")
.build());
file_comment_resource = filescom.FileComment("fileCommentResource",
body="string",
path="string")
const fileCommentResource = new filescom.FileComment("fileCommentResource", {
body: "string",
path: "string",
});
type: filescom:FileComment
properties:
body: string
path: string
FileComment 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 FileComment resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the FileComment resource produces the following output properties:
Look up Existing FileComment Resource
Get an existing FileComment 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?: FileCommentState, opts?: CustomResourceOptions): FileComment@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
body: Optional[str] = None,
path: Optional[str] = None,
reactions: Optional[Any] = None) -> FileCommentfunc GetFileComment(ctx *Context, name string, id IDInput, state *FileCommentState, opts ...ResourceOption) (*FileComment, error)public static FileComment Get(string name, Input<string> id, FileCommentState? state, CustomResourceOptions? opts = null)public static FileComment get(String name, Output<String> id, FileCommentState state, CustomResourceOptions options)resources: _: type: filescom:FileComment get: id: ${id}import {
to = filescom_file_comment.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.
Import
The pulumi import command can be used, for example:
File Comments can be imported by specifying the id and path.
$ pulumi import filescom:index/fileComment:FileComment example_file_comment 1,path
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
filescomTerraform Provider.
published on Thursday, Aug 20, 2026 by jschady