InventoryObject

Formal v1.2.0, Jun 6 26

Viewing docs for Formal v1.2.0
published on Saturday, Jun 6, 2026 by Formal

Schema (JSON)

formalco/pulumi-formal

Viewing docs for Formal v1.2.0
published on Saturday, Jun 6, 2026 by Formal

Schema (JSON)

formalco/pulumi-formal

Create InventoryObject Resource

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

Constructor syntax

new InventoryObject(name: string, args: InventoryObjectArgs, opts?: CustomResourceOptions);

@overload
def InventoryObject(resource_name: str,
                    args: InventoryObjectArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def InventoryObject(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    path: Optional[str] = None,
                    resource_id: Optional[str] = None,
                    type: Optional[str] = None,
                    data_type: Optional[str] = None,
                    name: Optional[str] = None)

func NewInventoryObject(ctx *Context, name string, args InventoryObjectArgs, opts ...ResourceOption) (*InventoryObject, error)

public InventoryObject(string name, InventoryObjectArgs args, CustomResourceOptions? opts = null)

public InventoryObject(String name, InventoryObjectArgs args)
public InventoryObject(String name, InventoryObjectArgs args, CustomResourceOptions options)

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

resource "formal_inventoryobject" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args InventoryObjectArgs: 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 InventoryObjectArgs: 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 InventoryObjectArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InventoryObjectArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args InventoryObjectArgs: 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 inventoryObjectResource = new Pulumi.InventoryObject("inventoryObjectResource", new()
{
    Path = "string",
    ResourceId = "string",
    Type = "string",
    DataType = "string",
    Name = "string",
});

example, err := formal.NewInventoryObject(ctx, "inventoryObjectResource", &formal.InventoryObjectArgs{
	Path:       pulumi.String("string"),
	ResourceId: pulumi.String("string"),
	Type:       pulumi.String("string"),
	DataType:   pulumi.String("string"),
	Name:       pulumi.String("string"),
})

resource "formal_inventoryobject" "inventoryObjectResource" {
  path        = "string"
  resource_id = "string"
  type        = "string"
  data_type   = "string"
  name        = "string"
}

var inventoryObjectResource = new InventoryObject("inventoryObjectResource", InventoryObjectArgs.builder()
    .path("string")
    .resourceId("string")
    .type("string")
    .dataType("string")
    .name("string")
    .build());

inventory_object_resource = formal.InventoryObject("inventoryObjectResource",
    path="string",
    resource_id="string",
    type="string",
    data_type="string",
    name="string")

const inventoryObjectResource = new formal.InventoryObject("inventoryObjectResource", {
    path: "string",
    resourceId: "string",
    type: "string",
    dataType: "string",
    name: "string",
});

type: formal:InventoryObject
properties:
    dataType: string
    name: string
    path: string
    resourceId: string
    type: string

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

Path string: Hierarchical path of the object (e.g. mydb.public.users.email).
ResourceId string: Resource (datastore) ID this object belongs to.
Type string: Object type. One of db, schema, table, column.
DataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
Name string: Last segment of the path (e.g. email).

Path string: Hierarchical path of the object (e.g. mydb.public.users.email).
ResourceId string: Resource (datastore) ID this object belongs to.
Type string: Object type. One of db, schema, table, column.
DataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
Name string: Last segment of the path (e.g. email).

path string: Hierarchical path of the object (e.g. mydb.public.users.email).
resource_id string: Resource (datastore) ID this object belongs to.
type string: Object type. One of db, schema, table, column.
data_type string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name string: Last segment of the path (e.g. email).

path String: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId String: Resource (datastore) ID this object belongs to.
type String: Object type. One of db, schema, table, column.
dataType String: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name String: Last segment of the path (e.g. email).

path string: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId string: Resource (datastore) ID this object belongs to.
type string: Object type. One of db, schema, table, column.
dataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name string: Last segment of the path (e.g. email).

path str: Hierarchical path of the object (e.g. mydb.public.users.email).
resource_id str: Resource (datastore) ID this object belongs to.
type str: Object type. One of db, schema, table, column.
data_type str: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name str: Last segment of the path (e.g. email).

path String: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId String: Resource (datastore) ID this object belongs to.
type String: Object type. One of db, schema, table, column.
dataType String: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name String: Last segment of the path (e.g. email).

Outputs

All input properties are implicitly available as output properties. Additionally, the InventoryObject 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 InventoryObject Resource

Get an existing InventoryObject 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?: InventoryObjectState, opts?: CustomResourceOptions): InventoryObject

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_type: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        resource_id: Optional[str] = None,
        type: Optional[str] = None) -> InventoryObject

func GetInventoryObject(ctx *Context, name string, id IDInput, state *InventoryObjectState, opts ...ResourceOption) (*InventoryObject, error)

public static InventoryObject Get(string name, Input<string> id, InventoryObjectState? state, CustomResourceOptions? opts = null)

public static InventoryObject get(String name, Output<String> id, InventoryObjectState state, CustomResourceOptions options)

resources:  _:    type: formal:InventoryObject    get:      id: ${id}

import {
  to = formal_inventoryobject.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:

DataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
Name string: Last segment of the path (e.g. email).
Path string: Hierarchical path of the object (e.g. mydb.public.users.email).
ResourceId string: Resource (datastore) ID this object belongs to.
Type string: Object type. One of db, schema, table, column.

DataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
Name string: Last segment of the path (e.g. email).
Path string: Hierarchical path of the object (e.g. mydb.public.users.email).
ResourceId string: Resource (datastore) ID this object belongs to.
Type string: Object type. One of db, schema, table, column.

data_type string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name string: Last segment of the path (e.g. email).
path string: Hierarchical path of the object (e.g. mydb.public.users.email).
resource_id string: Resource (datastore) ID this object belongs to.
type string: Object type. One of db, schema, table, column.

dataType String: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name String: Last segment of the path (e.g. email).
path String: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId String: Resource (datastore) ID this object belongs to.
type String: Object type. One of db, schema, table, column.

dataType string: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name string: Last segment of the path (e.g. email).
path string: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId string: Resource (datastore) ID this object belongs to.
type string: Object type. One of db, schema, table, column.

data_type str: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name str: Last segment of the path (e.g. email).
path str: Hierarchical path of the object (e.g. mydb.public.users.email).
resource_id str: Resource (datastore) ID this object belongs to.
type str: Object type. One of db, schema, table, column.

dataType String: Column data type (e.g. varchar). Required when type is column, ignored otherwise.
name String: Last segment of the path (e.g. email).
path String: Hierarchical path of the object (e.g. mydb.public.users.email).
resourceId String: Resource (datastore) ID this object belongs to.
type String: Object type. One of db, schema, table, column.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Viewing docs for Formal v1.2.0
published on Saturday, Jun 6, 2026 by Formal

Schema (JSON)

formalco/pulumi-formal

formal.InventoryObject

On this page

On this page

Create InventoryObject Resource

Constructor syntax

Parameters

Constructor example

InventoryObject Resource Properties

Inputs

Outputs

Look up Existing InventoryObject Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

formal.InventoryObject

On this page

On this page

Create InventoryObject Resource

Constructor syntax

Parameters

Constructor example

InventoryObject Resource Properties

Inputs

Outputs

Look up Existing InventoryObject Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.