Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DataCatalog.DataAsset

This resource provides the Data Asset resource in Oracle Cloud Infrastructure Data Catalog service.

Create a new data asset.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataAsset = new Oci.DataCatalog.DataAsset("testDataAsset", new()
    {
        CatalogId = oci_datacatalog_catalog.Test_catalog.Id,
        DisplayName = @var.Data_asset_display_name,
        TypeKey = @var.Data_asset_type_key,
        Description = @var.Data_asset_description,
        Properties = @var.Data_asset_properties,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataCatalog.NewDataAsset(ctx, "testDataAsset", &DataCatalog.DataAssetArgs{
			CatalogId:   pulumi.Any(oci_datacatalog_catalog.Test_catalog.Id),
			DisplayName: pulumi.Any(_var.Data_asset_display_name),
			TypeKey:     pulumi.Any(_var.Data_asset_type_key),
			Description: pulumi.Any(_var.Data_asset_description),
			Properties:  pulumi.Any(_var.Data_asset_properties),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.DataAsset;
import com.pulumi.oci.DataCatalog.DataAssetArgs;
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 testDataAsset = new DataAsset("testDataAsset", DataAssetArgs.builder()        
            .catalogId(oci_datacatalog_catalog.test_catalog().id())
            .displayName(var_.data_asset_display_name())
            .typeKey(var_.data_asset_type_key())
            .description(var_.data_asset_description())
            .properties(var_.data_asset_properties())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_data_asset = oci.data_catalog.DataAsset("testDataAsset",
    catalog_id=oci_datacatalog_catalog["test_catalog"]["id"],
    display_name=var["data_asset_display_name"],
    type_key=var["data_asset_type_key"],
    description=var["data_asset_description"],
    properties=var["data_asset_properties"])

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

const testDataAsset = new oci.datacatalog.DataAsset("testDataAsset", {
    catalogId: oci_datacatalog_catalog.test_catalog.id,
    displayName: _var.data_asset_display_name,
    typeKey: _var.data_asset_type_key,
    description: _var.data_asset_description,
    properties: _var.data_asset_properties,
});

resources:
  testDataAsset:
    type: oci:DataCatalog:DataAsset
    properties:
      #Required
      catalogId: ${oci_datacatalog_catalog.test_catalog.id}
      displayName: ${var.data_asset_display_name}
      typeKey: ${var.data_asset_type_key}
      #Optional
      description: ${var.data_asset_description}
      properties: ${var.data_asset_properties}

Create DataAsset Resource

new DataAsset(name: string, args: DataAssetArgs, opts?: CustomResourceOptions);

@overload
def DataAsset(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              catalog_id: Optional[str] = None,
              description: Optional[str] = None,
              display_name: Optional[str] = None,
              properties: Optional[Mapping[str, Any]] = None,
              type_key: Optional[str] = None)
@overload
def DataAsset(resource_name: str,
              args: DataAssetArgs,
              opts: Optional[ResourceOptions] = None)

func NewDataAsset(ctx *Context, name string, args DataAssetArgs, opts ...ResourceOption) (*DataAsset, error)

public DataAsset(string name, DataAssetArgs args, CustomResourceOptions? opts = null)

public DataAsset(String name, DataAssetArgs args)
public DataAsset(String name, DataAssetArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args DataAssetArgs: 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 DataAssetArgs: 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 DataAssetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataAssetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DataAssetArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DataAsset Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DataAsset resource accepts the following input properties:

CatalogId string: Unique catalog identifier.
DisplayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
TypeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
Description string: (Updatable) Detailed description of the data asset.
Properties Dictionary<string, object>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

CatalogId string: Unique catalog identifier.
DisplayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
TypeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
Description string: (Updatable) Detailed description of the data asset.
Properties map[string]interface{}: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

catalogId String: Unique catalog identifier.
displayName String: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
typeKey String: The key of the data asset type. This can be obtained via the '/types' endpoint.
description String: (Updatable) Detailed description of the data asset.
properties Map<String,Object>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

catalogId string: Unique catalog identifier.
displayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
typeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
description string: (Updatable) Detailed description of the data asset.
properties {[key: string]: any}: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

catalog_id str: Unique catalog identifier.
display_name str: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
type_key str: The key of the data asset type. This can be obtained via the '/types' endpoint.
description str: (Updatable) Detailed description of the data asset.
properties Mapping[str, Any]: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

catalogId String: Unique catalog identifier.
displayName String: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
typeKey String: The key of the data asset type. This can be obtained via the '/types' endpoint.
description String: (Updatable) Detailed description of the data asset.
properties Map<Any>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

Outputs

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

CreatedById string: OCID of the user who created the data asset.
ExternalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
Id string: The provider-assigned unique ID for this managed resource.
Key string: Unique data asset key that is immutable.
State string: The current state of the data asset.
TimeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
TimeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
TimeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
UpdatedById string: OCID of the user who last modified the data asset.
Uri string: URI to the data asset instance in the API.

CreatedById string: OCID of the user who created the data asset.
ExternalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
Id string: The provider-assigned unique ID for this managed resource.
Key string: Unique data asset key that is immutable.
State string: The current state of the data asset.
TimeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
TimeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
TimeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
UpdatedById string: OCID of the user who last modified the data asset.
Uri string: URI to the data asset instance in the API.

createdById String: OCID of the user who created the data asset.
externalKey String: External URI that can be used to reference the object. Format will differ based on the type of object.
id String: The provider-assigned unique ID for this managed resource.
key String: Unique data asset key that is immutable.
state String: The current state of the data asset.
timeCreated String: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested String: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated String: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
updatedById String: OCID of the user who last modified the data asset.
uri String: URI to the data asset instance in the API.

createdById string: OCID of the user who created the data asset.
externalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
id string: The provider-assigned unique ID for this managed resource.
key string: Unique data asset key that is immutable.
state string: The current state of the data asset.
timeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
updatedById string: OCID of the user who last modified the data asset.
uri string: URI to the data asset instance in the API.

created_by_id str: OCID of the user who created the data asset.
external_key str: External URI that can be used to reference the object. Format will differ based on the type of object.
id str: The provider-assigned unique ID for this managed resource.
key str: Unique data asset key that is immutable.
state str: The current state of the data asset.
time_created str: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
time_harvested str: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
time_updated str: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
updated_by_id str: OCID of the user who last modified the data asset.
uri str: URI to the data asset instance in the API.

createdById String: OCID of the user who created the data asset.
externalKey String: External URI that can be used to reference the object. Format will differ based on the type of object.
id String: The provider-assigned unique ID for this managed resource.
key String: Unique data asset key that is immutable.
state String: The current state of the data asset.
timeCreated String: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested String: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated String: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
updatedById String: OCID of the user who last modified the data asset.
uri String: URI to the data asset instance in the API.

Look up Existing DataAsset Resource

Get an existing DataAsset 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?: DataAssetState, opts?: CustomResourceOptions): DataAsset

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        created_by_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        external_key: Optional[str] = None,
        key: Optional[str] = None,
        properties: Optional[Mapping[str, Any]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_harvested: Optional[str] = None,
        time_updated: Optional[str] = None,
        type_key: Optional[str] = None,
        updated_by_id: Optional[str] = None,
        uri: Optional[str] = None) -> DataAsset

func GetDataAsset(ctx *Context, name string, id IDInput, state *DataAssetState, opts ...ResourceOption) (*DataAsset, error)

public static DataAsset Get(string name, Input<string> id, DataAssetState? state, CustomResourceOptions? opts = null)

public static DataAsset get(String name, Output<String> id, DataAssetState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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: Unique catalog identifier.
CreatedById string: OCID of the user who created the data asset.
Description string: (Updatable) Detailed description of the data asset.
DisplayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
ExternalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
Key string: Unique data asset key that is immutable.
Properties Dictionary<string, object>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
State string: The current state of the data asset.
TimeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
TimeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
TimeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
TypeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
UpdatedById string: OCID of the user who last modified the data asset.
Uri string: URI to the data asset instance in the API.

CatalogId string: Unique catalog identifier.
CreatedById string: OCID of the user who created the data asset.
Description string: (Updatable) Detailed description of the data asset.
DisplayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
ExternalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
Key string: Unique data asset key that is immutable.
Properties map[string]interface{}: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
State string: The current state of the data asset.
TimeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
TimeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
TimeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
TypeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
UpdatedById string: OCID of the user who last modified the data asset.
Uri string: URI to the data asset instance in the API.

catalogId String: Unique catalog identifier.
createdById String: OCID of the user who created the data asset.
description String: (Updatable) Detailed description of the data asset.
displayName String: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
externalKey String: External URI that can be used to reference the object. Format will differ based on the type of object.
key String: Unique data asset key that is immutable.
properties Map<String,Object>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
state String: The current state of the data asset.
timeCreated String: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested String: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated String: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
typeKey String: The key of the data asset type. This can be obtained via the '/types' endpoint.
updatedById String: OCID of the user who last modified the data asset.
uri String: URI to the data asset instance in the API.

catalogId string: Unique catalog identifier.
createdById string: OCID of the user who created the data asset.
description string: (Updatable) Detailed description of the data asset.
displayName string: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
externalKey string: External URI that can be used to reference the object. Format will differ based on the type of object.
key string: Unique data asset key that is immutable.
properties {[key: string]: any}: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
state string: The current state of the data asset.
timeCreated string: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested string: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated string: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
typeKey string: The key of the data asset type. This can be obtained via the '/types' endpoint.
updatedById string: OCID of the user who last modified the data asset.
uri string: URI to the data asset instance in the API.

catalog_id str: Unique catalog identifier.
created_by_id str: OCID of the user who created the data asset.
description str: (Updatable) Detailed description of the data asset.
display_name str: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
external_key str: External URI that can be used to reference the object. Format will differ based on the type of object.
key str: Unique data asset key that is immutable.
properties Mapping[str, Any]: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
state str: The current state of the data asset.
time_created str: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
time_harvested str: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
time_updated str: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
type_key str: The key of the data asset type. This can be obtained via the '/types' endpoint.
updated_by_id str: OCID of the user who last modified the data asset.
uri str: URI to the data asset instance in the API.

catalogId String: Unique catalog identifier.
createdById String: OCID of the user who created the data asset.
description String: (Updatable) Detailed description of the data asset.
displayName String: (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
externalKey String: External URI that can be used to reference the object. Format will differ based on the type of object.
key String: Unique data asset key that is immutable.
properties Map<Any>: A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
state String: The current state of the data asset.
timeCreated String: The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
timeHarvested String: The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
timeUpdated String: The last time that any change was made to the data asset. An RFC3339 formatted datetime string.
typeKey String: The key of the data asset type. This can be obtained via the '/types' endpoint.
updatedById String: OCID of the user who last modified the data asset.
uri String: URI to the data asset instance in the API.

Import

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

 $ pulumi import oci:DataCatalog/dataAsset:DataAsset test_data_asset "catalogs/{catalogId}/dataAssets/{dataAssetKey}"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.