Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. Connection
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataCatalog.Connection

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

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

    Creates a new connection.

    Example Usage

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

const testConnection = new oci.datacatalog.Connection("test_connection", {
    catalogId: testCatalog.id,
    dataAssetKey: connectionDataAssetKey,
    displayName: connectionDisplayName,
    properties: connectionProperties,
    typeKey: connectionTypeKey,
    description: connectionDescription,
    encProperties: connectionEncProperties,
    isDefault: connectionIsDefault,
});

    import pulumi
import pulumi_oci as oci

test_connection = oci.data_catalog.Connection("test_connection",
    catalog_id=test_catalog["id"],
    data_asset_key=connection_data_asset_key,
    display_name=connection_display_name,
    properties=connection_properties,
    type_key=connection_type_key,
    description=connection_description,
    enc_properties=connection_enc_properties,
    is_default=connection_is_default)

    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.NewConnection(ctx, "test_connection", &DataCatalog.ConnectionArgs{
			CatalogId:     pulumi.Any(testCatalog.Id),
			DataAssetKey:  pulumi.Any(connectionDataAssetKey),
			DisplayName:   pulumi.Any(connectionDisplayName),
			Properties:    pulumi.Any(connectionProperties),
			TypeKey:       pulumi.Any(connectionTypeKey),
			Description:   pulumi.Any(connectionDescription),
			EncProperties: pulumi.Any(connectionEncProperties),
			IsDefault:     pulumi.Any(connectionIsDefault),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testConnection = new Oci.DataCatalog.Connection("test_connection", new()
    {
        CatalogId = testCatalog.Id,
        DataAssetKey = connectionDataAssetKey,
        DisplayName = connectionDisplayName,
        Properties = connectionProperties,
        TypeKey = connectionTypeKey,
        Description = connectionDescription,
        EncProperties = connectionEncProperties,
        IsDefault = connectionIsDefault,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.Connection;
import com.pulumi.oci.DataCatalog.ConnectionArgs;
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 testConnection = new Connection("testConnection", ConnectionArgs.builder()
            .catalogId(testCatalog.id())
            .dataAssetKey(connectionDataAssetKey)
            .displayName(connectionDisplayName)
            .properties(connectionProperties)
            .typeKey(connectionTypeKey)
            .description(connectionDescription)
            .encProperties(connectionEncProperties)
            .isDefault(connectionIsDefault)
            .build());

    }
}

    resources:
  testConnection:
    type: oci:DataCatalog:Connection
    name: test_connection
    properties:
      catalogId: ${testCatalog.id}
      dataAssetKey: ${connectionDataAssetKey}
      displayName: ${connectionDisplayName}
      properties: ${connectionProperties}
      typeKey: ${connectionTypeKey}
      description: ${connectionDescription}
      encProperties: ${connectionEncProperties}
      isDefault: ${connectionIsDefault}

    Create Connection Resource

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

    Constructor syntax

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

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               catalog_id: Optional[str] = None,
               data_asset_key: Optional[str] = None,
               display_name: Optional[str] = None,
               properties: Optional[Mapping[str, Any]] = None,
               type_key: Optional[str] = None,
               description: Optional[str] = None,
               enc_properties: Optional[Mapping[str, Any]] = None,
               is_default: Optional[bool] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

    type: oci:DataCatalog:Connection
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 ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    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 connectionResource = new Oci.DataCatalog.Connection("connectionResource", new()
{
    CatalogId = "string",
    DataAssetKey = "string",
    DisplayName = "string",
    Properties = 
    {
        { "string", "any" },
    },
    TypeKey = "string",
    Description = "string",
    EncProperties = 
    {
        { "string", "any" },
    },
    IsDefault = false,
});

    example, err := DataCatalog.NewConnection(ctx, "connectionResource", &DataCatalog.ConnectionArgs{
	CatalogId:    pulumi.String("string"),
	DataAssetKey: pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Properties: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	TypeKey:     pulumi.String("string"),
	Description: pulumi.String("string"),
	EncProperties: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	IsDefault: pulumi.Bool(false),
})

    var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
    .catalogId("string")
    .dataAssetKey("string")
    .displayName("string")
    .properties(Map.of("string", "any"))
    .typeKey("string")
    .description("string")
    .encProperties(Map.of("string", "any"))
    .isDefault(false)
    .build());

    connection_resource = oci.data_catalog.Connection("connectionResource",
    catalog_id="string",
    data_asset_key="string",
    display_name="string",
    properties={
        "string": "any",
    },
    type_key="string",
    description="string",
    enc_properties={
        "string": "any",
    },
    is_default=False)

    const connectionResource = new oci.datacatalog.Connection("connectionResource", {
    catalogId: "string",
    dataAssetKey: "string",
    displayName: "string",
    properties: {
        string: "any",
    },
    typeKey: "string",
    description: "string",
    encProperties: {
        string: "any",
    },
    isDefault: false,
});

    type: oci:DataCatalog:Connection
properties:
    catalogId: string
    dataAssetKey: string
    description: string
    displayName: string
    encProperties:
        string: any
    isDefault: false
    properties:
        string: any
    typeKey: string

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

    CatalogId string
    Unique catalog identifier.
    DataAssetKey string
    Unique data asset key.
    DisplayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Properties Dictionary<string, object>
    TypeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    Description string
    (Updatable) A description of the connection.
    EncProperties Dictionary<string, object>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    IsDefault bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    CatalogId string
    Unique catalog identifier.
    DataAssetKey string
    Unique data asset key.
    DisplayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Properties map[string]interface{}
    TypeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    Description string
    (Updatable) A description of the connection.
    EncProperties map[string]interface{}
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    IsDefault bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    catalogId String
    Unique catalog identifier.
    dataAssetKey String
    Unique data asset key.
    displayName String
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    properties Map<String,Object>
    typeKey String

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    description String
    (Updatable) A description of the connection.
    encProperties Map<String,Object>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    isDefault Boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    catalogId string
    Unique catalog identifier.
    dataAssetKey string
    Unique data asset key.
    displayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    properties {[key: string]: any}
    typeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    description string
    (Updatable) A description of the connection.
    encProperties {[key: string]: any}
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    isDefault boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    catalog_id str
    Unique catalog identifier.
    data_asset_key str
    Unique data asset key.
    display_name str
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    properties Mapping[str, Any]
    type_key str

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    description str
    (Updatable) A description of the connection.
    enc_properties Mapping[str, Any]
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    is_default bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    catalogId String
    Unique catalog identifier.
    dataAssetKey String
    Unique data asset key.
    displayName String
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    properties Map<Any>
    typeKey String

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    description String
    (Updatable) A description of the connection.
    encProperties Map<Any>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    isDefault Boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.

    Outputs

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

    CreatedById string
    OCID of the user who created the connection.
    ExternalKey string
    Unique external key of this object from the source system.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    Unique connection key that is immutable.
    State string
    The current state of the connection.
    TimeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    TimeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    UpdatedById string
    OCID of the user who modified the connection.
    Uri string
    URI to the connection instance in the API.
    CreatedById string
    OCID of the user who created the connection.
    ExternalKey string
    Unique external key of this object from the source system.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    Unique connection key that is immutable.
    State string
    The current state of the connection.
    TimeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    TimeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    UpdatedById string
    OCID of the user who modified the connection.
    Uri string
    URI to the connection instance in the API.
    createdById String
    OCID of the user who created the connection.
    externalKey String
    Unique external key of this object from the source system.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    Unique connection key that is immutable.
    state String
    The current state of the connection.
    timeCreated String
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated String
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    updatedById String
    OCID of the user who modified the connection.
    uri String
    URI to the connection instance in the API.
    createdById string
    OCID of the user who created the connection.
    externalKey string
    Unique external key of this object from the source system.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    Unique connection key that is immutable.
    state string
    The current state of the connection.
    timeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    updatedById string
    OCID of the user who modified the connection.
    uri string
    URI to the connection instance in the API.
    created_by_id str
    OCID of the user who created the connection.
    external_key str
    Unique external key of this object from the source system.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    Unique connection key that is immutable.
    state str
    The current state of the connection.
    time_created str
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    time_status_updated str
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    time_updated str
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    updated_by_id str
    OCID of the user who modified the connection.
    uri str
    URI to the connection instance in the API.
    createdById String
    OCID of the user who created the connection.
    externalKey String
    Unique external key of this object from the source system.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    Unique connection key that is immutable.
    state String
    The current state of the connection.
    timeCreated String
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated String
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    updatedById String
    OCID of the user who modified the connection.
    uri String
    URI to the connection instance in the API.

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        created_by_id: Optional[str] = None,
        data_asset_key: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enc_properties: Optional[Mapping[str, Any]] = None,
        external_key: Optional[str] = None,
        is_default: Optional[bool] = None,
        key: Optional[str] = None,
        properties: Optional[Mapping[str, Any]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_status_updated: Optional[str] = None,
        time_updated: Optional[str] = None,
        type_key: Optional[str] = None,
        updated_by_id: Optional[str] = None,
        uri: Optional[str] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState 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 connection.
    DataAssetKey string
    Unique data asset key.
    Description string
    (Updatable) A description of the connection.
    DisplayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncProperties Dictionary<string, object>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    ExternalKey string
    Unique external key of this object from the source system.
    IsDefault bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    Key string
    Unique connection key that is immutable.
    Properties Dictionary<string, object>
    State string
    The current state of the connection.
    TimeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    TimeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    TypeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    UpdatedById string
    OCID of the user who modified the connection.
    Uri string
    URI to the connection instance in the API.
    CatalogId string
    Unique catalog identifier.
    CreatedById string
    OCID of the user who created the connection.
    DataAssetKey string
    Unique data asset key.
    Description string
    (Updatable) A description of the connection.
    DisplayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncProperties map[string]interface{}
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    ExternalKey string
    Unique external key of this object from the source system.
    IsDefault bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    Key string
    Unique connection key that is immutable.
    Properties map[string]interface{}
    State string
    The current state of the connection.
    TimeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    TimeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    TypeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    UpdatedById string
    OCID of the user who modified the connection.
    Uri string
    URI to the connection instance in the API.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the connection.
    dataAssetKey String
    Unique data asset key.
    description String
    (Updatable) A description of the connection.
    displayName String
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encProperties Map<String,Object>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    externalKey String
    Unique external key of this object from the source system.
    isDefault Boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    key String
    Unique connection key that is immutable.
    properties Map<String,Object>
    state String
    The current state of the connection.
    timeCreated String
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated String
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    typeKey String

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    updatedById String
    OCID of the user who modified the connection.
    uri String
    URI to the connection instance in the API.
    catalogId string
    Unique catalog identifier.
    createdById string
    OCID of the user who created the connection.
    dataAssetKey string
    Unique data asset key.
    description string
    (Updatable) A description of the connection.
    displayName string
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encProperties {[key: string]: any}
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    externalKey string
    Unique external key of this object from the source system.
    isDefault boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    key string
    Unique connection key that is immutable.
    properties {[key: string]: any}
    state string
    The current state of the connection.
    timeCreated string
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated string
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated string
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    typeKey string

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    updatedById string
    OCID of the user who modified the connection.
    uri string
    URI to the connection instance in the API.
    catalog_id str
    Unique catalog identifier.
    created_by_id str
    OCID of the user who created the connection.
    data_asset_key str
    Unique data asset key.
    description str
    (Updatable) A description of the connection.
    display_name str
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    enc_properties Mapping[str, Any]
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    external_key str
    Unique external key of this object from the source system.
    is_default bool
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    key str
    Unique connection key that is immutable.
    properties Mapping[str, Any]
    state str
    The current state of the connection.
    time_created str
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    time_status_updated str
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    time_updated str
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    type_key str

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    updated_by_id str
    OCID of the user who modified the connection.
    uri str
    URI to the connection instance in the API.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the connection.
    dataAssetKey String
    Unique data asset key.
    description String
    (Updatable) A description of the connection.
    displayName String
    (Updatable) A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encProperties Map<Any>
    (Updatable) A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {"encProperties": { "default": { "password": "example-password"}}}
    externalKey String
    Unique external key of this object from the source system.
    isDefault Boolean
    (Updatable) Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
    key String
    Unique connection key that is immutable.
    properties Map<Any>
    state String
    The current state of the connection.
    timeCreated String
    The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    timeStatusUpdated String
    Time that the connections status was last updated. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time that any change was made to the connection. An RFC3339 formatted datetime string.
    typeKey String

    The key of the object type. Type key's can be found via the '/types' endpoint.

    ** 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

    updatedById String
    OCID of the user who modified the connection.
    uri String
    URI to the connection instance in the API.

    Import

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

    $ pulumi import oci:DataCatalog/connection:Connection test_connection "catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}"

    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.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci