Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ServiceCatalog
  5. Catalog
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.ServiceCatalog.Catalog

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Service Catalog resource in Oracle Cloud Infrastructure Service Catalog service.

Creates a brand new service catalog in a given compartment.

Example Usage

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

const testServiceCatalog = new oci.servicecatalog.Catalog("test_service_catalog", {
    compartmentId: compartmentId,
    displayName: serviceCatalogDisplayName,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_service_catalog = oci.service_catalog.Catalog("test_service_catalog",
    compartment_id=compartment_id,
    display_name=service_catalog_display_name,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/servicecatalog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicecatalog.NewCatalog(ctx, "test_service_catalog", &servicecatalog.CatalogArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(serviceCatalogDisplayName),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testServiceCatalog = new Oci.ServiceCatalog.Catalog("test_service_catalog", new()
    {
        CompartmentId = compartmentId,
        DisplayName = serviceCatalogDisplayName,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ServiceCatalog.Catalog;
import com.pulumi.oci.ServiceCatalog.CatalogArgs;
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 testServiceCatalog = new Catalog("testServiceCatalog", CatalogArgs.builder()
            .compartmentId(compartmentId)
            .displayName(serviceCatalogDisplayName)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}
Copy
resources:
  testServiceCatalog:
    type: oci:ServiceCatalog:Catalog
    name: test_service_catalog
    properties:
      compartmentId: ${compartmentId}
      displayName: ${serviceCatalogDisplayName}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
Copy

Create Catalog Resource

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

Constructor syntax

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

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            display_name: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            freeform_tags: Optional[Mapping[str, str]] = None)
func NewCatalog(ctx *Context, name string, args CatalogArgs, opts ...ResourceOption) (*Catalog, error)
public Catalog(string name, CatalogArgs args, CustomResourceOptions? opts = null)
public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

type: oci:ServiceCatalog:Catalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CatalogArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CatalogArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CatalogArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CatalogArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CatalogArgs
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 ociCatalogResource = new Oci.ServiceCatalog.Catalog("ociCatalogResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ServiceCatalog.NewCatalog(ctx, "ociCatalogResource", &ServiceCatalog.CatalogArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var ociCatalogResource = new Catalog("ociCatalogResource", CatalogArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());
Copy
oci_catalog_resource = oci.service_catalog.Catalog("ociCatalogResource",
    compartment_id="string",
    display_name="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })
Copy
const ociCatalogResource = new oci.servicecatalog.Catalog("ociCatalogResource", {
    compartmentId: "string",
    displayName: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});
Copy
type: oci:ServiceCatalog:Catalog
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
Copy

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

CompartmentId This property is required. string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
DisplayName This property is required. string
(Updatable) The display name of the service catalog.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags Dictionary<string, string>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId This property is required. string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
DisplayName This property is required. string
(Updatable) The display name of the service catalog.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags map[string]string

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The unique identifier for the compartment where the service catalog will be created.
displayName This property is required. String
(Updatable) The display name of the service catalog.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<String,String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
displayName This property is required. string
(Updatable) The display name of the service catalog.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags {[key: string]: string}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id This property is required. str
(Updatable) The unique identifier for the compartment where the service catalog will be created.
display_name This property is required. str
(Updatable) The display name of the service catalog.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeform_tags Mapping[str, str]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The unique identifier for the compartment where the service catalog will be created.
displayName This property is required. String
(Updatable) The display name of the service catalog.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
State string
The lifecycle state of the service catalog.
TimeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
TimeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
Id string
The provider-assigned unique ID for this managed resource.
State string
The lifecycle state of the service catalog.
TimeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
TimeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
id String
The provider-assigned unique ID for this managed resource.
state String
The lifecycle state of the service catalog.
timeCreated String
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated String
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
id string
The provider-assigned unique ID for this managed resource.
state string
The lifecycle state of the service catalog.
timeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
id str
The provider-assigned unique ID for this managed resource.
state str
The lifecycle state of the service catalog.
time_created str
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
time_updated str
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
id String
The provider-assigned unique ID for this managed resource.
state String
The lifecycle state of the service catalog.
timeCreated String
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated String
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z

Look up Existing Catalog Resource

Get an existing Catalog 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?: CatalogState, opts?: CustomResourceOptions): Catalog
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Catalog
func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
public static Catalog get(String name, Output<String> id, CatalogState state, CustomResourceOptions options)
resources:  _:    type: oci:ServiceCatalog:Catalog    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CompartmentId string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) The display name of the service catalog.
FreeformTags Dictionary<string, string>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The lifecycle state of the service catalog.
TimeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
TimeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
CompartmentId string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) The display name of the service catalog.
FreeformTags map[string]string

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The lifecycle state of the service catalog.
TimeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
TimeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
compartmentId String
(Updatable) The unique identifier for the compartment where the service catalog will be created.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) The display name of the service catalog.
freeformTags Map<String,String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The lifecycle state of the service catalog.
timeCreated String
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated String
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
compartmentId string
(Updatable) The unique identifier for the compartment where the service catalog will be created.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
(Updatable) The display name of the service catalog.
freeformTags {[key: string]: string}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state string
The lifecycle state of the service catalog.
timeCreated string
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated string
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
compartment_id str
(Updatable) The unique identifier for the compartment where the service catalog will be created.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str
(Updatable) The display name of the service catalog.
freeform_tags Mapping[str, str]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state str
The lifecycle state of the service catalog.
time_created str
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
time_updated str
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z
compartmentId String
(Updatable) The unique identifier for the compartment where the service catalog will be created.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) The display name of the service catalog.
freeformTags Map<String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The lifecycle state of the service catalog.
timeCreated String
The date and time the service catalog was created, expressed in RFC 3339 timestamp format. Example: 2021-05-26T21:10:29.600Z
timeUpdated String
The date and time the service catalog was last modified, expressed in RFC 3339 timestamp format. Example: 2021-12-10T05:10:29.721Z

Import

ServiceCatalogs can be imported using the id, e.g.

$ pulumi import oci:ServiceCatalog/catalog:Catalog test_service_catalog "id"
Copy

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci