Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getConnection

This data source provides details about a specific Connection resource in Oracle Cloud Infrastructure Data Catalog service.

Gets a specific data asset connection by key.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testConnection = Oci.DataCatalog.GetConnection.Invoke(new()
    {
        CatalogId = oci_datacatalog_catalog.Test_catalog.Id,
        ConnectionKey = @var.Connection_connection_key,
        DataAssetKey = @var.Connection_data_asset_key,
        Fields = @var.Connection_fields,
    });

});
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.GetConnection(ctx, &datacatalog.GetConnectionArgs{
			CatalogId:     oci_datacatalog_catalog.Test_catalog.Id,
			ConnectionKey: _var.Connection_connection_key,
			DataAssetKey:  _var.Connection_data_asset_key,
			Fields:        _var.Connection_fields,
		}, nil)
		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.DataCatalogFunctions;
import com.pulumi.oci.DataCatalog.inputs.GetConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testConnection = DataCatalogFunctions.getConnection(GetConnectionArgs.builder()
            .catalogId(oci_datacatalog_catalog.test_catalog().id())
            .connectionKey(var_.connection_connection_key())
            .dataAssetKey(var_.connection_data_asset_key())
            .fields(var_.connection_fields())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_connection = oci.DataCatalog.get_connection(catalog_id=oci_datacatalog_catalog["test_catalog"]["id"],
    connection_key=var["connection_connection_key"],
    data_asset_key=var["connection_data_asset_key"],
    fields=var["connection_fields"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConnection = oci.DataCatalog.getConnection({
    catalogId: oci_datacatalog_catalog.test_catalog.id,
    connectionKey: _var.connection_connection_key,
    dataAssetKey: _var.connection_data_asset_key,
    fields: _var.connection_fields,
});
variables:
  testConnection:
    Fn::Invoke:
      Function: oci:DataCatalog:getConnection
      Arguments:
        catalogId: ${oci_datacatalog_catalog.test_catalog.id}
        connectionKey: ${var.connection_connection_key}
        dataAssetKey: ${var.connection_data_asset_key}
        fields: ${var.connection_fields}

Using getConnection

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

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
def get_connection(catalog_id: Optional[str] = None,
                   connection_key: Optional[str] = None,
                   data_asset_key: Optional[str] = None,
                   fields: Optional[Sequence[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(catalog_id: Optional[pulumi.Input[str]] = None,
                   connection_key: Optional[pulumi.Input[str]] = None,
                   data_asset_key: Optional[pulumi.Input[str]] = None,
                   fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
func GetConnection(ctx *Context, args *GetConnectionArgs, opts ...InvokeOption) (*GetConnectionResult, error)
func GetConnectionOutput(ctx *Context, args *GetConnectionOutputArgs, opts ...InvokeOption) GetConnectionResultOutput

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:DataCatalog/getConnection:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string

Unique catalog identifier.

ConnectionKey string

Unique connection key.

DataAssetKey string

Unique data asset key.

Fields List<string>

Specifies the fields to return in a connection response.

CatalogId string

Unique catalog identifier.

ConnectionKey string

Unique connection key.

DataAssetKey string

Unique data asset key.

Fields []string

Specifies the fields to return in a connection response.

catalogId String

Unique catalog identifier.

connectionKey String

Unique connection key.

dataAssetKey String

Unique data asset key.

fields List<String>

Specifies the fields to return in a connection response.

catalogId string

Unique catalog identifier.

connectionKey string

Unique connection key.

dataAssetKey string

Unique data asset key.

fields string[]

Specifies the fields to return in a connection response.

catalog_id str

Unique catalog identifier.

connection_key str

Unique connection key.

data_asset_key str

Unique data asset key.

fields Sequence[str]

Specifies the fields to return in a connection response.

catalogId String

Unique catalog identifier.

connectionKey String

Unique connection key.

dataAssetKey String

Unique data asset key.

fields List<String>

Specifies the fields to return in a connection response.

getConnection Result

The following output properties are available:

CatalogId string
ConnectionKey string
CreatedById string

OCID of the user who created the connection.

DataAssetKey string

Unique key of the parent data asset.

Description string

A description of the connection.

DisplayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

EncProperties Dictionary<string, object>
ExternalKey string

Unique external key of this object from the source system.

Id string
IsDefault bool

Indicates whether this connection is the default connection.

Key string

Unique connection key that is immutable.

Properties Dictionary<string, object>

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

UpdatedById string

OCID of the user who modified the connection.

Uri string

URI to the connection instance in the API.

Fields List<string>
CatalogId string
ConnectionKey string
CreatedById string

OCID of the user who created the connection.

DataAssetKey string

Unique key of the parent data asset.

Description string

A description of the connection.

DisplayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

EncProperties map[string]interface{}
ExternalKey string

Unique external key of this object from the source system.

Id string
IsDefault bool

Indicates whether this connection is the default connection.

Key string

Unique connection key that is immutable.

Properties map[string]interface{}

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

UpdatedById string

OCID of the user who modified the connection.

Uri string

URI to the connection instance in the API.

Fields []string
catalogId String
connectionKey String
createdById String

OCID of the user who created the connection.

dataAssetKey String

Unique key of the parent data asset.

description String

A description of the connection.

displayName String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

encProperties Map<String,Object>
externalKey String

Unique external key of this object from the source system.

id String
isDefault Boolean

Indicates whether this connection is the default connection.

key String

Unique connection key that is immutable.

properties Map<String,Object>

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

updatedById String

OCID of the user who modified the connection.

uri String

URI to the connection instance in the API.

fields List<String>
catalogId string
connectionKey string
createdById string

OCID of the user who created the connection.

dataAssetKey string

Unique key of the parent data asset.

description string

A description of the connection.

displayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

encProperties {[key: string]: any}
externalKey string

Unique external key of this object from the source system.

id string
isDefault boolean

Indicates whether this connection is the default connection.

key string

Unique connection key that is immutable.

properties {[key: string]: any}

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

updatedById string

OCID of the user who modified the connection.

uri string

URI to the connection instance in the API.

fields string[]
catalog_id str
connection_key str
created_by_id str

OCID of the user who created the connection.

data_asset_key str

Unique key of the parent data asset.

description str

A description of the connection.

display_name str

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

enc_properties Mapping[str, Any]
external_key str

Unique external key of this object from the source system.

id str
is_default bool

Indicates whether this connection is the default connection.

key str

Unique connection key that is immutable.

properties Mapping[str, Any]

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

updated_by_id str

OCID of the user who modified the connection.

uri str

URI to the connection instance in the API.

fields Sequence[str]
catalogId String
connectionKey String
createdById String

OCID of the user who created the connection.

dataAssetKey String

Unique key of the parent data asset.

description String

A description of the connection.

displayName String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

encProperties Map<Any>
externalKey String

Unique external key of this object from the source system.

id String
isDefault Boolean

Indicates whether this connection is the default connection.

key String

Unique connection key that is immutable.

properties Map<Any>

A map of maps that contains the 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. Example: {"properties": { "default": { "username": "user1"}}}

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.

updatedById String

OCID of the user who modified the connection.

uri String

URI to the connection instance in the API.

fields List<String>

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.