Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SchematicsInventory
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SchematicsInventory

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete for a Schematics inventory. For more information, about Schematics action inventories, see Creating resource inventories for Schematics actions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const schematicsInventory = new ibm.SchematicsInventory("schematicsInventory", {});

    import pulumi
import pulumi_ibm as ibm

schematics_inventory = ibm.SchematicsInventory("schematicsInventory")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSchematicsInventory(ctx, "schematicsInventory", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var schematicsInventory = new Ibm.SchematicsInventory("schematicsInventory");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsInventory;
import java.util.List;
import java.util.ArrayList;
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 schematicsInventory = new SchematicsInventory("schematicsInventory");

    }
}

    resources:
  schematicsInventory:
    type: ibm:SchematicsInventory

    Create SchematicsInventory Resource

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

    Constructor syntax

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

@overload
def SchematicsInventory(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        inventories_ini: Optional[str] = None,
                        location: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group: Optional[str] = None,
                        resource_queries: Optional[Sequence[str]] = None,
                        schematics_inventory_id: Optional[str] = None)
    func NewSchematicsInventory(ctx *Context, name string, args *SchematicsInventoryArgs, opts ...ResourceOption) (*SchematicsInventory, error)
    public SchematicsInventory(string name, SchematicsInventoryArgs? args = null, CustomResourceOptions? opts = null)
    public SchematicsInventory(String name, SchematicsInventoryArgs args)
public SchematicsInventory(String name, SchematicsInventoryArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SchematicsInventoryArgs
    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 SchematicsInventoryArgs
    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 SchematicsInventoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchematicsInventoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchematicsInventoryArgs
    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 schematicsInventoryResource = new Ibm.SchematicsInventory("schematicsInventoryResource", new()
{
    Description = "string",
    InventoriesIni = "string",
    Location = "string",
    Name = "string",
    ResourceGroup = "string",
    ResourceQueries = new[]
    {
        "string",
    },
    SchematicsInventoryId = "string",
});

    example, err := ibm.NewSchematicsInventory(ctx, "schematicsInventoryResource", &ibm.SchematicsInventoryArgs{
	Description:    pulumi.String("string"),
	InventoriesIni: pulumi.String("string"),
	Location:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	ResourceGroup:  pulumi.String("string"),
	ResourceQueries: pulumi.StringArray{
		pulumi.String("string"),
	},
	SchematicsInventoryId: pulumi.String("string"),
})

    var schematicsInventoryResource = new SchematicsInventory("schematicsInventoryResource", SchematicsInventoryArgs.builder()
    .description("string")
    .inventoriesIni("string")
    .location("string")
    .name("string")
    .resourceGroup("string")
    .resourceQueries("string")
    .schematicsInventoryId("string")
    .build());

    schematics_inventory_resource = ibm.SchematicsInventory("schematicsInventoryResource",
    description="string",
    inventories_ini="string",
    location="string",
    name="string",
    resource_group="string",
    resource_queries=["string"],
    schematics_inventory_id="string")

    const schematicsInventoryResource = new ibm.SchematicsInventory("schematicsInventoryResource", {
    description: "string",
    inventoriesIni: "string",
    location: "string",
    name: "string",
    resourceGroup: "string",
    resourceQueries: ["string"],
    schematicsInventoryId: "string",
});

    type: ibm:SchematicsInventory
properties:
    description: string
    inventoriesIni: string
    location: string
    name: string
    resourceGroup: string
    resourceQueries:
        - string
    schematicsInventoryId: string

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

    Description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    InventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    Location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    Name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    ResourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    ResourceQueries List<string>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    SchematicsInventoryId string
    The unique identifier of the schematics_inventory.
    Description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    InventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    Location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    Name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    ResourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    ResourceQueries []string
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    SchematicsInventoryId string
    The unique identifier of the schematics_inventory.
    description String
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni String
    Input inventory of host and host group for the playbook, in the .ini file format.
    location String
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name String
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup String
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries List<String>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId String
    The unique identifier of the schematics_inventory.
    description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries string[]
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId string
    The unique identifier of the schematics_inventory.
    description str
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventories_ini str
    Input inventory of host and host group for the playbook, in the .ini file format.
    location str
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name str
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resource_group str
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resource_queries Sequence[str]
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematics_inventory_id str
    The unique identifier of the schematics_inventory.
    description String
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni String
    Input inventory of host and host group for the playbook, in the .ini file format.
    location String
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name String
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup String
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries List<String>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId String
    The unique identifier of the schematics_inventory.

    Outputs

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

    CreatedAt string
    (String) Inventory creation time.
    CreatedBy string
    (String) Email address of user who created the inventory.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    (String) Inventory updation time.
    UpdatedBy string
    (String) Email address of user who updated the inventory.
    CreatedAt string
    (String) Inventory creation time.
    CreatedBy string
    (String) Email address of user who created the inventory.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    (String) Inventory updation time.
    UpdatedBy string
    (String) Email address of user who updated the inventory.
    createdAt String
    (String) Inventory creation time.
    createdBy String
    (String) Email address of user who created the inventory.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    (String) Inventory updation time.
    updatedBy String
    (String) Email address of user who updated the inventory.
    createdAt string
    (String) Inventory creation time.
    createdBy string
    (String) Email address of user who created the inventory.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    (String) Inventory updation time.
    updatedBy string
    (String) Email address of user who updated the inventory.
    created_at str
    (String) Inventory creation time.
    created_by str
    (String) Email address of user who created the inventory.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    (String) Inventory updation time.
    updated_by str
    (String) Email address of user who updated the inventory.
    createdAt String
    (String) Inventory creation time.
    createdBy String
    (String) Email address of user who created the inventory.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    (String) Inventory updation time.
    updatedBy String
    (String) Email address of user who updated the inventory.

    Look up Existing SchematicsInventory Resource

    Get an existing SchematicsInventory 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?: SchematicsInventoryState, opts?: CustomResourceOptions): SchematicsInventory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        inventories_ini: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_queries: Optional[Sequence[str]] = None,
        schematics_inventory_id: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None) -> SchematicsInventory
    func GetSchematicsInventory(ctx *Context, name string, id IDInput, state *SchematicsInventoryState, opts ...ResourceOption) (*SchematicsInventory, error)
    public static SchematicsInventory Get(string name, Input<string> id, SchematicsInventoryState? state, CustomResourceOptions? opts = null)
    public static SchematicsInventory get(String name, Output<String> id, SchematicsInventoryState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SchematicsInventory    get:      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:
    CreatedAt string
    (String) Inventory creation time.
    CreatedBy string
    (String) Email address of user who created the inventory.
    Description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    InventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    Location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    Name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    ResourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    ResourceQueries List<string>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    SchematicsInventoryId string
    The unique identifier of the schematics_inventory.
    UpdatedAt string
    (String) Inventory updation time.
    UpdatedBy string
    (String) Email address of user who updated the inventory.
    CreatedAt string
    (String) Inventory creation time.
    CreatedBy string
    (String) Email address of user who created the inventory.
    Description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    InventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    Location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    Name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    ResourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    ResourceQueries []string
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    SchematicsInventoryId string
    The unique identifier of the schematics_inventory.
    UpdatedAt string
    (String) Inventory updation time.
    UpdatedBy string
    (String) Email address of user who updated the inventory.
    createdAt String
    (String) Inventory creation time.
    createdBy String
    (String) Email address of user who created the inventory.
    description String
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni String
    Input inventory of host and host group for the playbook, in the .ini file format.
    location String
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name String
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup String
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries List<String>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId String
    The unique identifier of the schematics_inventory.
    updatedAt String
    (String) Inventory updation time.
    updatedBy String
    (String) Email address of user who updated the inventory.
    createdAt string
    (String) Inventory creation time.
    createdBy string
    (String) Email address of user who created the inventory.
    description string
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni string
    Input inventory of host and host group for the playbook, in the .ini file format.
    location string
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name string
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup string
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries string[]
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId string
    The unique identifier of the schematics_inventory.
    updatedAt string
    (String) Inventory updation time.
    updatedBy string
    (String) Email address of user who updated the inventory.
    created_at str
    (String) Inventory creation time.
    created_by str
    (String) Email address of user who created the inventory.
    description str
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventories_ini str
    Input inventory of host and host group for the playbook, in the .ini file format.
    location str
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name str
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resource_group str
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resource_queries Sequence[str]
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematics_inventory_id str
    The unique identifier of the schematics_inventory.
    updated_at str
    (String) Inventory updation time.
    updated_by str
    (String) Email address of user who updated the inventory.
    createdAt String
    (String) Inventory creation time.
    createdBy String
    (String) Email address of user who created the inventory.
    description String
    The description of your inventory definition. The description can be up to 2048 characters long in size.
    inventoriesIni String
    Input inventory of host and host group for the playbook, in the .ini file format.
    location String
    List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
    name String
    The unique name of your inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.

    • Constraints: The maximum length is 64 characters. The minimum length is 3 characters.
    resourceGroup String
    The resource group name for the inventory definition. By default, inventory definition will be created in Default resource group.
    resourceQueries List<String>
    Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.
    schematicsInventoryId String
    The unique identifier of the schematics_inventory.
    updatedAt String
    (String) Inventory updation time.
    updatedBy String
    (String) Email address of user who updated the inventory.

    Import

    You can import the ibm_schematics_inventory resource by using id. inventory ID.

    Syntax

    $ pulumi import ibm:index/schematicsInventory:SchematicsInventory schematics_inventory <id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm