1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCmObject
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCmObject

Explore with Pulumi AI

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

    Provides a read-only data source for ibm_cm_object. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const cmObject = ibm.getCmObject({
        catalogId: ibm_cm_object.cm_object.catalog_id,
        objectId: ibm_cm_object.cm_object.id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    cm_object = ibm.get_cm_object(catalog_id=ibm_cm_object["cm_object"]["catalog_id"],
        object_id=ibm_cm_object["cm_object"]["id"])
    
    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.LookupCmObject(ctx, &ibm.LookupCmObjectArgs{
    			CatalogId: ibm_cm_object.Cm_object.Catalog_id,
    			ObjectId:  ibm_cm_object.Cm_object.Id,
    		}, 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 cmObject = Ibm.GetCmObject.Invoke(new()
        {
            CatalogId = ibm_cm_object.Cm_object.Catalog_id,
            ObjectId = ibm_cm_object.Cm_object.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetCmObjectArgs;
    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) {
            final var cmObject = IbmFunctions.getCmObject(GetCmObjectArgs.builder()
                .catalogId(ibm_cm_object.cm_object().catalog_id())
                .objectId(ibm_cm_object.cm_object().id())
                .build());
    
        }
    }
    
    variables:
      cmObject:
        fn::invoke:
          function: ibm:getCmObject
          arguments:
            catalogId: ${ibm_cm_object.cm_object.catalog_id}
            objectId: ${ibm_cm_object.cm_object.id}
    

    Using getCmObject

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCmObject(args: GetCmObjectArgs, opts?: InvokeOptions): Promise<GetCmObjectResult>
    function getCmObjectOutput(args: GetCmObjectOutputArgs, opts?: InvokeOptions): Output<GetCmObjectResult>
    def get_cm_object(catalog_id: Optional[str] = None,
                      id: Optional[str] = None,
                      object_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCmObjectResult
    def get_cm_object_output(catalog_id: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      object_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCmObjectResult]
    func LookupCmObject(ctx *Context, args *LookupCmObjectArgs, opts ...InvokeOption) (*LookupCmObjectResult, error)
    func LookupCmObjectOutput(ctx *Context, args *LookupCmObjectOutputArgs, opts ...InvokeOption) LookupCmObjectResultOutput

    > Note: This function is named LookupCmObject in the Go SDK.

    public static class GetCmObject 
    {
        public static Task<GetCmObjectResult> InvokeAsync(GetCmObjectArgs args, InvokeOptions? opts = null)
        public static Output<GetCmObjectResult> Invoke(GetCmObjectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCmObjectResult> getCmObject(GetCmObjectArgs args, InvokeOptions options)
    public static Output<GetCmObjectResult> getCmObject(GetCmObjectArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCmObject:getCmObject
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CatalogId string
    Catalog identifier.
    ObjectId string
    Object identification.
    Id string
    The unique identifier of the ibm_cm_object.
    CatalogId string
    Catalog identifier.
    ObjectId string
    Object identification.
    Id string
    The unique identifier of the ibm_cm_object.
    catalogId String
    Catalog identifier.
    objectId String
    Object identification.
    id String
    The unique identifier of the ibm_cm_object.
    catalogId string
    Catalog identifier.
    objectId string
    Object identification.
    id string
    The unique identifier of the ibm_cm_object.
    catalog_id str
    Catalog identifier.
    object_id str
    Object identification.
    id str
    The unique identifier of the ibm_cm_object.
    catalogId String
    Catalog identifier.
    objectId String
    Object identification.
    id String
    The unique identifier of the ibm_cm_object.

    getCmObject Result

    The following output properties are available:

    CatalogId string
    CatalogName string
    (String) The name of the catalog.
    CatalogObjectId string
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Data string
    (String) Stringified map of object data.
    Id string
    The unique identifier of the ibm_cm_object.
    Kind string
    (String) Kind of object.
    Label string
    (String) Display name in the requested language.
    LabelI18n Dictionary<string, string>
    Name string
    (String) The programmatic name of this object.
    ObjectId string
    ParentId string
    (String) The parent for this specific object.
    Publishes List<GetCmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    ShortDescription string
    (String) Short description in the requested language.
    ShortDescriptionI18n Dictionary<string, string>
    States List<GetCmObjectState>
    Object state.

    • Nested scheme for state:
    Tags List<string>
    (List) 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
    CatalogName string
    (String) The name of the catalog.
    CatalogObjectId string
    Created string
    (String) The date and time this catalog was created.
    Crn string
    (String) The crn for this specific object.
    Data string
    (String) Stringified map of object data.
    Id string
    The unique identifier of the ibm_cm_object.
    Kind string
    (String) Kind of object.
    Label string
    (String) Display name in the requested language.
    LabelI18n map[string]string
    Name string
    (String) The programmatic name of this object.
    ObjectId string
    ParentId string
    (String) The parent for this specific object.
    Publishes []GetCmObjectPublish
    Publish information.

    • Nested scheme for publish:
    Rev string
    (String) Cloudant revision.
    ShortDescription string
    (String) Short description in the requested language.
    ShortDescriptionI18n map[string]string
    States []GetCmObjectState
    Object state.

    • Nested scheme for state:
    Tags []string
    (List) 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
    catalogName String
    (String) The name of the catalog.
    catalogObjectId String
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    data String
    (String) Stringified map of object data.
    id String
    The unique identifier of the ibm_cm_object.
    kind String
    (String) Kind of object.
    label String
    (String) Display name in the requested language.
    labelI18n Map<String,String>
    name String
    (String) The programmatic name of this object.
    objectId String
    parentId String
    (String) The parent for this specific object.
    publishes List<GetCmObjectPublish>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    shortDescription String
    (String) Short description in the requested language.
    shortDescriptionI18n Map<String,String>
    states List<GetCmObjectState>
    Object state.

    • Nested scheme for state:
    tags List<String>
    (List) 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
    catalogName string
    (String) The name of the catalog.
    catalogObjectId string
    created string
    (String) The date and time this catalog was created.
    crn string
    (String) The crn for this specific object.
    data string
    (String) Stringified map of object data.
    id string
    The unique identifier of the ibm_cm_object.
    kind string
    (String) Kind of object.
    label string
    (String) Display name in the requested language.
    labelI18n {[key: string]: string}
    name string
    (String) The programmatic name of this object.
    objectId string
    parentId string
    (String) The parent for this specific object.
    publishes GetCmObjectPublish[]
    Publish information.

    • Nested scheme for publish:
    rev string
    (String) Cloudant revision.
    shortDescription string
    (String) Short description in the requested language.
    shortDescriptionI18n {[key: string]: string}
    states GetCmObjectState[]
    Object state.

    • Nested scheme for state:
    tags string[]
    (List) 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_name str
    (String) The name of the catalog.
    catalog_object_id str
    created str
    (String) The date and time this catalog was created.
    crn str
    (String) The crn for this specific object.
    data str
    (String) Stringified map of object data.
    id str
    The unique identifier of the ibm_cm_object.
    kind str
    (String) Kind of object.
    label str
    (String) Display name in the requested language.
    label_i18n Mapping[str, str]
    name str
    (String) The programmatic name of this object.
    object_id str
    parent_id str
    (String) The parent for this specific object.
    publishes Sequence[GetCmObjectPublish]
    Publish information.

    • Nested scheme for publish:
    rev str
    (String) Cloudant revision.
    short_description str
    (String) Short description in the requested language.
    short_description_i18n Mapping[str, str]
    states Sequence[GetCmObjectState]
    Object state.

    • Nested scheme for state:
    tags Sequence[str]
    (List) 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
    catalogName String
    (String) The name of the catalog.
    catalogObjectId String
    created String
    (String) The date and time this catalog was created.
    crn String
    (String) The crn for this specific object.
    data String
    (String) Stringified map of object data.
    id String
    The unique identifier of the ibm_cm_object.
    kind String
    (String) Kind of object.
    label String
    (String) Display name in the requested language.
    labelI18n Map<String>
    name String
    (String) The programmatic name of this object.
    objectId String
    parentId String
    (String) The parent for this specific object.
    publishes List<Property Map>
    Publish information.

    • Nested scheme for publish:
    rev String
    (String) Cloudant revision.
    shortDescription String
    (String) Short description in the requested language.
    shortDescriptionI18n Map<String>
    states List<Property Map>
    Object state.

    • Nested scheme for state:
    tags List<String>
    (List) 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

    GetCmObjectPublish

    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.

    GetCmObjectState

    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.

    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