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

ibm.CmObject

Explore with Pulumi AI

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

    Provides a resource for ibm_cm_object. This allows ibm.CmObject to be created, updated and deleted.

    Example Usage

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

const cmObject = new ibm.CmObject("cmObject", {
    catalogId: ibm_cm_catalog.cm_catalog.id,
    label: "Object Label",
    kind: "preset_configuration",
    shortDescription: "short description",
    data: JSON.stringify(fs.readFileSync("data.json", "utf8")),
    parentId: "us-south",
    tags: [
        "tag1",
        "tag2",
    ],
});

    import pulumi
import json
import pulumi_ibm as ibm

cm_object = ibm.CmObject("cmObject",
    catalog_id=ibm_cm_catalog["cm_catalog"]["id"],
    label="Object Label",
    kind="preset_configuration",
    short_description="short description",
    data=json.dumps((lambda path: open(path).read())("data.json")),
    parent_id="us-south",
    tags=[
        "tag1",
        "tag2",
    ])

    package main

import (
	"encoding/json"
	"os"

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

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(readFileOrPanic("data.json"))
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = ibm.NewCmObject(ctx, "cmObject", &ibm.CmObjectArgs{
			CatalogId:        pulumi.Any(ibm_cm_catalog.Cm_catalog.Id),
			Label:            pulumi.String("Object Label"),
			Kind:             pulumi.String("preset_configuration"),
			ShortDescription: pulumi.String("short description"),
			Data:             pulumi.String(json0),
			ParentId:         pulumi.String("us-south"),
			Tags: pulumi.StringArray{
				pulumi.String("tag1"),
				pulumi.String("tag2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var cmObject = new Ibm.CmObject("cmObject", new()
    {
        CatalogId = ibm_cm_catalog.Cm_catalog.Id,
        Label = "Object Label",
        Kind = "preset_configuration",
        ShortDescription = "short description",
        Data = JsonSerializer.Serialize(File.ReadAllText("data.json")),
        ParentId = "us-south",
        Tags = new[]
        {
            "tag1",
            "tag2",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CmObject;
import com.pulumi.ibm.CmObjectArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 cmObject = new CmObject("cmObject", CmObjectArgs.builder()
            .catalogId(ibm_cm_catalog.cm_catalog().id())
            .label("Object Label")
            .kind("preset_configuration")
            .shortDescription("short description")
            .data(serializeJson(
                Files.readString(Paths.get("data.json"))))
            .parentId("us-south")
            .tags(            
                "tag1",
                "tag2")
            .build());

    }
}

    resources:
  cmObject:
    type: ibm:CmObject
    properties:
      catalogId: ${ibm_cm_catalog.cm_catalog.id}
      label: Object Label
      kind: preset_configuration
      shortDescription: short description
      data:
        fn::toJSON:
          fn::readFile: data.json
      parentId: us-south
      tags:
        - tag1
        - tag2

    Provider Configuration

    The IBM Cloud provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:

    • Static credentials
    • Environment variables

    To find which credentials are required for this resource, see the service table here.

    Static credentials

    You can provide your static credentials by adding the ibmcloud_api_key, iaas_classic_username, and iaas_classic_api_key arguments in the IBM Cloud provider block.

    Usage:

    provider "ibm" {
    ibmcloud_api_key = ""
    iaas_classic_username = ""
    iaas_classic_api_key = ""
}

    Environment variables

    You can provide your credentials by exporting the IC_API_KEY, IAAS_CLASSIC_USERNAME, and IAAS_CLASSIC_API_KEY environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.

    provider "ibm" {}

    Usage:

    export IC_API_KEY="api_key"
export IAAS_CLASSIC_USERNAME="iaas_classic_username"
export IAAS_CLASSIC_API_KEY="api_key"
pulumi preview

    Note:

    1. Create or find your ibmcloud_api_key and iaas_classic_api_key here.
    • Select My IBM Cloud API Keys option from view dropdown for ibmcloud_api_key
    • Select Classic Infrastructure API Keys option from view dropdown for iaas_classic_api_key
    1. For iaas_classic_username
    • Go to Users
    • Click on user.
    • Find user name in the VPN password section under User Details tab

    For more informaton, see here.

    Create CmObject Resource

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

    Constructor syntax

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

@overload
def CmObject(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             catalog_id: Optional[str] = None,
             kind: Optional[str] = None,
             cm_object_id: Optional[str] = None,
             data: Optional[str] = None,
             label: Optional[str] = None,
             label_i18n: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             parent_id: Optional[str] = None,
             short_description: Optional[str] = None,
             short_description_i18n: Optional[Mapping[str, str]] = None,
             tags: Optional[Sequence[str]] = None)
    func NewCmObject(ctx *Context, name string, args CmObjectArgs, opts ...ResourceOption) (*CmObject, error)
    public CmObject(string name, CmObjectArgs args, CustomResourceOptions? opts = null)
    public CmObject(String name, CmObjectArgs args)
public CmObject(String name, CmObjectArgs args, CustomResourceOptions options)

    type: ibm:CmObject
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 CmObjectArgs
    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 CmObjectArgs
    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 CmObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CmObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CmObjectArgs
    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 cmObjectResource = new Ibm.CmObject("cmObjectResource", new()
{
    CatalogId = "string",
    Kind = "string",
    CmObjectId = "string",
    Data = "string",
    Label = "string",
    LabelI18n = 
    {
        { "string", "string" },
    },
    Name = "string",
    ParentId = "string",
    ShortDescription = "string",
    ShortDescriptionI18n = 
    {
        { "string", "string" },
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewCmObject(ctx, "cmObjectResource", &ibm.CmObjectArgs{
	CatalogId:  pulumi.String("string"),
	Kind:       pulumi.String("string"),
	CmObjectId: pulumi.String("string"),
	Data:       pulumi.String("string"),
	Label:      pulumi.String("string"),
	LabelI18n: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:             pulumi.String("string"),
	ParentId:         pulumi.String("string"),
	ShortDescription: pulumi.String("string"),
	ShortDescriptionI18n: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var cmObjectResource = new CmObject("cmObjectResource", CmObjectArgs.builder()
    .catalogId("string")
    .kind("string")
    .cmObjectId("string")
    .data("string")
    .label("string")
    .labelI18n(Map.of("string", "string"))
    .name("string")
    .parentId("string")
    .shortDescription("string")
    .shortDescriptionI18n(Map.of("string", "string"))
    .tags("string")
    .build());

    cm_object_resource = ibm.CmObject("cmObjectResource",
    catalog_id="string",
    kind="string",
    cm_object_id="string",
    data="string",
    label="string",
    label_i18n={
        "string": "string",
    },
    name="string",
    parent_id="string",
    short_description="string",
    short_description_i18n={
        "string": "string",
    },
    tags=["string"])

    const cmObjectResource = new ibm.CmObject("cmObjectResource", {
    catalogId: "string",
    kind: "string",
    cmObjectId: "string",
    data: "string",
    label: "string",
    labelI18n: {
        string: "string",
    },
    name: "string",
    parentId: "string",
    shortDescription: "string",
    shortDescriptionI18n: {
        string: "string",
    },
    tags: ["string"],
});

    type: ibm:CmObject
properties:
    catalogId: string
    cmObjectId: string
    data: string
    kind: string
    label: string
    labelI18n:
        string: string
    name: string
    parentId: string
    shortDescription: string
    shortDescriptionI18n:
        string: string
    tags:
        - string

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

    CatalogId string
    Catalog identifier.
    Kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    CmObjectId string
    The unique identifier of the ibm_cm_object.
    Data string
    Stringified map of object data.
    Label string
    Display name in the requested language.
    LabelI18n Dictionary<string, string>
    A map of translated strings, by language code.
    Name string
    The programmatic name of this object.
    ParentId string
    The parent region for this specific object.
    ShortDescription string
    Short description in the requested language.
    ShortDescriptionI18n Dictionary<string, string>
    A map of translated strings, by language code.
    Tags List<string>
    List of tags associated with this catalog.
    CatalogId string
    Catalog identifier.
    Kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    CmObjectId string
    The unique identifier of the ibm_cm_object.
    Data string
    Stringified map of object data.
    Label string
    Display name in the requested language.
    LabelI18n map[string]string
    A map of translated strings, by language code.
    Name string
    The programmatic name of this object.
    ParentId string
    The parent region for this specific object.
    ShortDescription string
    Short description in the requested language.
    ShortDescriptionI18n map[string]string
    A map of translated strings, by language code.
    Tags []string
    List of tags associated with this catalog.
    catalogId String
    Catalog identifier.
    kind String
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    cmObjectId String
    The unique identifier of the ibm_cm_object.
    data String
    Stringified map of object data.
    label String
    Display name in the requested language.
    labelI18n Map<String,String>
    A map of translated strings, by language code.
    name String
    The programmatic name of this object.
    parentId String
    The parent region for this specific object.
    shortDescription String
    Short description in the requested language.
    shortDescriptionI18n Map<String,String>
    A map of translated strings, by language code.
    tags List<String>
    List of tags associated with this catalog.
    catalogId string
    Catalog identifier.
    kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    cmObjectId string
    The unique identifier of the ibm_cm_object.
    data string
    Stringified map of object data.
    label string
    Display name in the requested language.
    labelI18n {[key: string]: string}
    A map of translated strings, by language code.
    name string
    The programmatic name of this object.
    parentId string
    The parent region for this specific object.
    shortDescription string
    Short description in the requested language.
    shortDescriptionI18n {[key: string]: string}
    A map of translated strings, by language code.
    tags string[]
    List of tags associated with this catalog.
    catalog_id str
    Catalog identifier.
    kind str
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    cm_object_id str
    The unique identifier of the ibm_cm_object.
    data str
    Stringified map of object data.
    label str
    Display name in the requested language.
    label_i18n Mapping[str, str]
    A map of translated strings, by language code.
    name str
    The programmatic name of this object.
    parent_id str
    The parent region for this specific object.
    short_description str
    Short description in the requested language.
    short_description_i18n Mapping[str, str]
    A map of translated strings, by language code.
    tags Sequence[str]
    List of tags associated with this catalog.
    catalogId String
    Catalog identifier.
    kind String
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    cmObjectId String
    The unique identifier of the ibm_cm_object.
    data String
    Stringified map of object data.
    label String
    Display name in the requested language.
    labelI18n Map<String>
    A map of translated strings, by language code.
    name String
    The programmatic name of this object.
    parentId String
    The parent region for this specific object.
    shortDescription String
    Short description in the requested language.
    shortDescriptionI18n Map<String>
    A map of translated strings, by language code.
    tags List<String>
    List of tags associated with this catalog.

    Outputs

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

    CatalogName string
    (String) The name of the catalog.
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Id string
    The provider-assigned unique ID for this managed resource.
    ObjectId string
    The ID of the object.
    Publishes List<CmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    States List<CmObjectState>
    Object state.

    • Nested scheme for state:
    Updated string
    (String) The data and time this catalog was last updated.
    Url string
    (String) The url for this specific object.
    CatalogName string
    (String) The name of the catalog.
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Id string
    The provider-assigned unique ID for this managed resource.
    ObjectId string
    The ID of the object.
    Publishes []CmObjectPublish
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    States []CmObjectStateType
    Object state.

    • Nested scheme for state:
    Updated string
    (String) The data and time this catalog was last updated.
    Url string
    (String) The url for this specific object.
    catalogName String
    (String) The name of the catalog.
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    id String
    The provider-assigned unique ID for this managed resource.
    objectId String
    The ID of the object.
    publishes List<CmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    states List<CmObjectState>
    Object state.

    • Nested scheme for state:
    updated String
    (String) The data and time this catalog was last updated.
    url String
    (String) The url for this specific object.
    catalogName string
    (String) The name of the catalog.
    created string
    (String) The date and time this catalog was created.
    crn string
    (String) The crn for this specific object.
    id string
    The provider-assigned unique ID for this managed resource.
    objectId string
    The ID of the object.
    publishes CmObjectPublish[]
    Publish information.

    • Nested scheme for publish:
    rev string
    (String) Cloudant revision.
    states CmObjectState[]
    Object state.

    • Nested scheme for state:
    updated string
    (String) The data and time this catalog was last updated.
    url string
    (String) The url for this specific object.
    catalog_name str
    (String) The name of the catalog.
    created str
    (String) The date and time this catalog was created.
    crn str
    (String) The crn for this specific object.
    id str
    The provider-assigned unique ID for this managed resource.
    object_id str
    The ID of the object.
    publishes Sequence[CmObjectPublish]
    Publish information.

    • Nested scheme for publish:
    rev str
    (String) Cloudant revision.
    states Sequence[CmObjectState]
    Object state.

    • Nested scheme for state:
    updated str
    (String) The data and time this catalog was last updated.
    url str
    (String) The url for this specific object.
    catalogName String
    (String) The name of the catalog.
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    id String
    The provider-assigned unique ID for this managed resource.
    objectId String
    The ID of the object.
    publishes List<Property Map>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    states List<Property Map>
    Object state.

    • Nested scheme for state:
    updated String
    (String) The data and time this catalog was last updated.
    url String
    (String) The url for this specific object.

    Look up Existing CmObject Resource

    Get an existing CmObject 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?: CmObjectState, opts?: CustomResourceOptions): CmObject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        catalog_name: Optional[str] = None,
        cm_object_id: Optional[str] = None,
        created: Optional[str] = None,
        crn: Optional[str] = None,
        data: Optional[str] = None,
        kind: Optional[str] = None,
        label: Optional[str] = None,
        label_i18n: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        object_id: Optional[str] = None,
        parent_id: Optional[str] = None,
        publishes: Optional[Sequence[CmObjectPublishArgs]] = None,
        rev: Optional[str] = None,
        short_description: Optional[str] = None,
        short_description_i18n: Optional[Mapping[str, str]] = None,
        states: Optional[Sequence[CmObjectStateArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        updated: Optional[str] = None,
        url: Optional[str] = None) -> CmObject
    func GetCmObject(ctx *Context, name string, id IDInput, state *CmObjectState, opts ...ResourceOption) (*CmObject, error)
    public static CmObject Get(string name, Input<string> id, CmObjectState? state, CustomResourceOptions? opts = null)
    public static CmObject get(String name, Output<String> id, CmObjectState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CmObject    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:
    CatalogId string
    Catalog identifier.
    CatalogName string
    (String) The name of the catalog.
    CmObjectId string
    The unique identifier of the ibm_cm_object.
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Data string
    Stringified map of object data.
    Kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    Label string
    Display name in the requested language.
    LabelI18n Dictionary<string, string>
    A map of translated strings, by language code.
    Name string
    The programmatic name of this object.
    ObjectId string
    The ID of the object.
    ParentId string
    The parent region for this specific object.
    Publishes List<CmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    ShortDescription string
    Short description in the requested language.
    ShortDescriptionI18n Dictionary<string, string>
    A map of translated strings, by language code.
    States List<CmObjectState>
    Object state.

    • Nested scheme for state:
    Tags List<string>
    List of tags associated with this catalog.
    Updated string
    (String) The data and time this catalog was last updated.
    Url string
    (String) The url for this specific object.
    CatalogId string
    Catalog identifier.
    CatalogName string
    (String) The name of the catalog.
    CmObjectId string
    The unique identifier of the ibm_cm_object.
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Data string
    Stringified map of object data.
    Kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    Label string
    Display name in the requested language.
    LabelI18n map[string]string
    A map of translated strings, by language code.
    Name string
    The programmatic name of this object.
    ObjectId string
    The ID of the object.
    ParentId string
    The parent region for this specific object.
    Publishes []CmObjectPublishArgs
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    ShortDescription string
    Short description in the requested language.
    ShortDescriptionI18n map[string]string
    A map of translated strings, by language code.
    States []CmObjectStateTypeArgs
    Object state.

    • Nested scheme for state:
    Tags []string
    List of tags associated with this catalog.
    Updated string
    (String) The data and time this catalog was last updated.
    Url string
    (String) The url for this specific object.
    catalogId String
    Catalog identifier.
    catalogName String
    (String) The name of the catalog.
    cmObjectId String
    The unique identifier of the ibm_cm_object.
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    data String
    Stringified map of object data.
    kind String
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    label String
    Display name in the requested language.
    labelI18n Map<String,String>
    A map of translated strings, by language code.
    name String
    The programmatic name of this object.
    objectId String
    The ID of the object.
    parentId String
    The parent region for this specific object.
    publishes List<CmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    shortDescription String
    Short description in the requested language.
    shortDescriptionI18n Map<String,String>
    A map of translated strings, by language code.
    states List<CmObjectState>
    Object state.

    • Nested scheme for state:
    tags List<String>
    List of tags associated with this catalog.
    updated String
    (String) The data and time this catalog was last updated.
    url String
    (String) The url for this specific object.
    catalogId string
    Catalog identifier.
    catalogName string
    (String) The name of the catalog.
    cmObjectId string
    The unique identifier of the ibm_cm_object.
    created string
    (String) The date and time this catalog was created.
    crn string
    (String) The crn for this specific object.
    data string
    Stringified map of object data.
    kind string
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    label string
    Display name in the requested language.
    labelI18n {[key: string]: string}
    A map of translated strings, by language code.
    name string
    The programmatic name of this object.
    objectId string
    The ID of the object.
    parentId string
    The parent region for this specific object.
    publishes CmObjectPublish[]
    Publish information.

    • Nested scheme for publish:
    rev string
    (String) Cloudant revision.
    shortDescription string
    Short description in the requested language.
    shortDescriptionI18n {[key: string]: string}
    A map of translated strings, by language code.
    states CmObjectState[]
    Object state.

    • Nested scheme for state:
    tags string[]
    List of tags associated with this catalog.
    updated string
    (String) The data and time this catalog was last updated.
    url string
    (String) The url for this specific object.
    catalog_id str
    Catalog identifier.
    catalog_name str
    (String) The name of the catalog.
    cm_object_id str
    The unique identifier of the ibm_cm_object.
    created str
    (String) The date and time this catalog was created.
    crn str
    (String) The crn for this specific object.
    data str
    Stringified map of object data.
    kind str
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    label str
    Display name in the requested language.
    label_i18n Mapping[str, str]
    A map of translated strings, by language code.
    name str
    The programmatic name of this object.
    object_id str
    The ID of the object.
    parent_id str
    The parent region for this specific object.
    publishes Sequence[CmObjectPublishArgs]
    Publish information.

    • Nested scheme for publish:
    rev str
    (String) Cloudant revision.
    short_description str
    Short description in the requested language.
    short_description_i18n Mapping[str, str]
    A map of translated strings, by language code.
    states Sequence[CmObjectStateArgs]
    Object state.

    • Nested scheme for state:
    tags Sequence[str]
    List of tags associated with this catalog.
    updated str
    (String) The data and time this catalog was last updated.
    url str
    (String) The url for this specific object.
    catalogId String
    Catalog identifier.
    catalogName String
    (String) The name of the catalog.
    cmObjectId String
    The unique identifier of the ibm_cm_object.
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    data String
    Stringified map of object data.
    kind String
    Kind of object. Options are "vpe", "preset_configuration", or "proxy_source".
    label String
    Display name in the requested language.
    labelI18n Map<String>
    A map of translated strings, by language code.
    name String
    The programmatic name of this object.
    objectId String
    The ID of the object.
    parentId String
    The parent region for this specific object.
    publishes List<Property Map>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    shortDescription String
    Short description in the requested language.
    shortDescriptionI18n Map<String>
    A map of translated strings, by language code.
    states List<Property Map>
    Object state.

    • Nested scheme for state:
    tags List<String>
    List of tags associated with this catalog.
    updated String
    (String) The data and time this catalog was last updated.
    url String
    (String) The url for this specific object.

    Supporting Types

    CmObjectPublish, CmObjectPublishArgs

    IbmApproved bool
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    PermitIbmPublicPublish bool
    (Boolean) Is it permitted to request publishing to IBM or Public.
    PortalApprovalRecord string
    (String) The portal's approval record ID.
    PortalUrl string
    (String) The portal UI URL.
    PublicApproved bool
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.
    IbmApproved bool
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    PermitIbmPublicPublish bool
    (Boolean) Is it permitted to request publishing to IBM or Public.
    PortalApprovalRecord string
    (String) The portal's approval record ID.
    PortalUrl string
    (String) The portal UI URL.
    PublicApproved bool
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.
    ibmApproved Boolean
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    permitIbmPublicPublish Boolean
    (Boolean) Is it permitted to request publishing to IBM or Public.
    portalApprovalRecord String
    (String) The portal's approval record ID.
    portalUrl String
    (String) The portal UI URL.
    publicApproved Boolean
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.
    ibmApproved boolean
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    permitIbmPublicPublish boolean
    (Boolean) Is it permitted to request publishing to IBM or Public.
    portalApprovalRecord string
    (String) The portal's approval record ID.
    portalUrl string
    (String) The portal UI URL.
    publicApproved boolean
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.
    ibm_approved bool
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    permit_ibm_public_publish bool
    (Boolean) Is it permitted to request publishing to IBM or Public.
    portal_approval_record str
    (String) The portal's approval record ID.
    portal_url str
    (String) The portal UI URL.
    public_approved bool
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.
    ibmApproved Boolean
    (Boolean) Indicates if this offering has been approved for use by all IBMers.
    permitIbmPublicPublish Boolean
    (Boolean) Is it permitted to request publishing to IBM or Public.
    portalApprovalRecord String
    (String) The portal's approval record ID.
    portalUrl String
    (String) The portal UI URL.
    publicApproved Boolean
    (Boolean) Indicates if this offering has been approved for use by all IBM Cloud users.

    CmObjectState, CmObjectStateArgs

    Current string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    CurrentEntered string
    (String) Date and time of current request.
    Pending string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    PendingRequested string
    (String) Date and time of pending request.
    Previous string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    Current string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    CurrentEntered string
    (String) Date and time of current request.
    Pending string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    PendingRequested string
    (String) Date and time of pending request.
    Previous string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    current String
    (String) one of: new, validated, account-published, ibm-published, public-published.
    currentEntered String
    (String) Date and time of current request.
    pending String
    (String) one of: new, validated, account-published, ibm-published, public-published.
    pendingRequested String
    (String) Date and time of pending request.
    previous String
    (String) one of: new, validated, account-published, ibm-published, public-published.
    current string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    currentEntered string
    (String) Date and time of current request.
    pending string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    pendingRequested string
    (String) Date and time of pending request.
    previous string
    (String) one of: new, validated, account-published, ibm-published, public-published.
    current str
    (String) one of: new, validated, account-published, ibm-published, public-published.
    current_entered str
    (String) Date and time of current request.
    pending str
    (String) one of: new, validated, account-published, ibm-published, public-published.
    pending_requested str
    (String) Date and time of pending request.
    previous str
    (String) one of: new, validated, account-published, ibm-published, public-published.
    current String
    (String) one of: new, validated, account-published, ibm-published, public-published.
    currentEntered String
    (String) Date and time of current request.
    pending String
    (String) one of: new, validated, account-published, ibm-published, public-published.
    pendingRequested String
    (String) Date and time of pending request.
    previous String
    (String) one of: new, validated, account-published, ibm-published, public-published.

    Import

    You can import the ibm_cm_object resource by using id.

    The id property is just the object_id.

    • object_id: A string. Object identification.

    Syntax

    $ pulumi import ibm:index/cmObject:CmObject cm_object <object_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