import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Catalog resource in Oracle Cloud Infrastructure Data Catalog service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/data-catalog/latest/Catalog * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/datacatalog * * Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. * For more information, please see the documentation. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testCatalog = new oci.datacatalog.Catalog("test_catalog", { * compartmentId: compartmentId, * definedTags: { * "foo-namespace.bar-key": "value", * }, * displayName: catalogDisplayName, * freeformTags: { * "bar-key": "value", * }, * }); * ``` * * ## Import * * Catalogs can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:DataCatalog/catalog:Catalog test_catalog "id" * ``` */ export declare class Catalog extends pulumi.CustomResource { /** * Get an existing Catalog resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CatalogState, opts?: pulumi.CustomResourceOptions): Catalog; /** * Returns true if the given object is an instance of Catalog. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Catalog; /** * (Updatable) The list of private reverse connection endpoints attached to the catalog * * ** 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 */ readonly attachedCatalogPrivateEndpoints: pulumi.Output; /** * (Updatable) Compartment identifier. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Data catalog identifier. */ readonly displayName: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state. */ readonly lifecycleDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated. */ readonly numberOfObjects: pulumi.Output; /** * The REST front endpoint URL to the data catalog instance. */ readonly serviceApiUrl: pulumi.Output; /** * The console front endpoint URL to the data catalog instance. */ readonly serviceConsoleUrl: pulumi.Output; /** * The current state of the data catalog resource. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The time the data catalog was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ readonly timeUpdated: pulumi.Output; /** * Create a Catalog resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CatalogArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Catalog resources. */ export interface CatalogState { /** * (Updatable) The list of private reverse connection endpoints attached to the catalog * * ** 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 */ attachedCatalogPrivateEndpoints?: pulumi.Input[] | undefined>; /** * (Updatable) Compartment identifier. */ compartmentId?: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Data catalog identifier. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated. */ numberOfObjects?: pulumi.Input; /** * The REST front endpoint URL to the data catalog instance. */ serviceApiUrl?: pulumi.Input; /** * The console front endpoint URL to the data catalog instance. */ serviceConsoleUrl?: pulumi.Input; /** * The current state of the data catalog resource. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated?: pulumi.Input; /** * The time the data catalog was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a Catalog resource. */ export interface CatalogArgs { /** * (Updatable) The list of private reverse connection endpoints attached to the catalog * * ** 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 */ attachedCatalogPrivateEndpoints?: pulumi.Input[] | undefined>; /** * (Updatable) Compartment identifier. */ compartmentId: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Data catalog identifier. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=catalog.d.ts.map