Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DataCatalog.getConnections

This data source provides the list of Connections in Oracle Cloud Infrastructure Data Catalog service.

Returns a list of all Connections for a data asset.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testConnections = Oci.DataCatalog.GetConnections.Invoke(new()
    {
        CatalogId = oci_datacatalog_catalog.Test_catalog.Id,
        DataAssetKey = @var.Connection_data_asset_key,
        CreatedById = oci_datacatalog_created_by.Test_created_by.Id,
        DisplayName = @var.Connection_display_name,
        DisplayNameContains = @var.Connection_display_name_contains,
        ExternalKey = @var.Connection_external_key,
        Fields = @var.Connection_fields,
        IsDefault = @var.Connection_is_default,
        State = @var.Connection_state,
        TimeCreated = @var.Connection_time_created,
        TimeStatusUpdated = @var.Connection_time_status_updated,
        TimeUpdated = @var.Connection_time_updated,
        UpdatedById = oci_datacatalog_updated_by.Test_updated_by.Id,
    });

});

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.GetConnections(ctx, &datacatalog.GetConnectionsArgs{
			CatalogId:           oci_datacatalog_catalog.Test_catalog.Id,
			DataAssetKey:        _var.Connection_data_asset_key,
			CreatedById:         pulumi.StringRef(oci_datacatalog_created_by.Test_created_by.Id),
			DisplayName:         pulumi.StringRef(_var.Connection_display_name),
			DisplayNameContains: pulumi.StringRef(_var.Connection_display_name_contains),
			ExternalKey:         pulumi.StringRef(_var.Connection_external_key),
			Fields:              _var.Connection_fields,
			IsDefault:           pulumi.BoolRef(_var.Connection_is_default),
			State:               pulumi.StringRef(_var.Connection_state),
			TimeCreated:         pulumi.StringRef(_var.Connection_time_created),
			TimeStatusUpdated:   pulumi.StringRef(_var.Connection_time_status_updated),
			TimeUpdated:         pulumi.StringRef(_var.Connection_time_updated),
			UpdatedById:         pulumi.StringRef(oci_datacatalog_updated_by.Test_updated_by.Id),
		}, 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.GetConnectionsArgs;
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 testConnections = DataCatalogFunctions.getConnections(GetConnectionsArgs.builder()
            .catalogId(oci_datacatalog_catalog.test_catalog().id())
            .dataAssetKey(var_.connection_data_asset_key())
            .createdById(oci_datacatalog_created_by.test_created_by().id())
            .displayName(var_.connection_display_name())
            .displayNameContains(var_.connection_display_name_contains())
            .externalKey(var_.connection_external_key())
            .fields(var_.connection_fields())
            .isDefault(var_.connection_is_default())
            .state(var_.connection_state())
            .timeCreated(var_.connection_time_created())
            .timeStatusUpdated(var_.connection_time_status_updated())
            .timeUpdated(var_.connection_time_updated())
            .updatedById(oci_datacatalog_updated_by.test_updated_by().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_connections = oci.DataCatalog.get_connections(catalog_id=oci_datacatalog_catalog["test_catalog"]["id"],
    data_asset_key=var["connection_data_asset_key"],
    created_by_id=oci_datacatalog_created_by["test_created_by"]["id"],
    display_name=var["connection_display_name"],
    display_name_contains=var["connection_display_name_contains"],
    external_key=var["connection_external_key"],
    fields=var["connection_fields"],
    is_default=var["connection_is_default"],
    state=var["connection_state"],
    time_created=var["connection_time_created"],
    time_status_updated=var["connection_time_status_updated"],
    time_updated=var["connection_time_updated"],
    updated_by_id=oci_datacatalog_updated_by["test_updated_by"]["id"])

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

const testConnections = oci.DataCatalog.getConnections({
    catalogId: oci_datacatalog_catalog.test_catalog.id,
    dataAssetKey: _var.connection_data_asset_key,
    createdById: oci_datacatalog_created_by.test_created_by.id,
    displayName: _var.connection_display_name,
    displayNameContains: _var.connection_display_name_contains,
    externalKey: _var.connection_external_key,
    fields: _var.connection_fields,
    isDefault: _var.connection_is_default,
    state: _var.connection_state,
    timeCreated: _var.connection_time_created,
    timeStatusUpdated: _var.connection_time_status_updated,
    timeUpdated: _var.connection_time_updated,
    updatedById: oci_datacatalog_updated_by.test_updated_by.id,
});

variables:
  testConnections:
    fn::invoke:
      Function: oci:DataCatalog:getConnections
      Arguments:
        catalogId: ${oci_datacatalog_catalog.test_catalog.id}
        dataAssetKey: ${var.connection_data_asset_key}
        createdById: ${oci_datacatalog_created_by.test_created_by.id}
        displayName: ${var.connection_display_name}
        displayNameContains: ${var.connection_display_name_contains}
        externalKey: ${var.connection_external_key}
        fields: ${var.connection_fields}
        isDefault: ${var.connection_is_default}
        state: ${var.connection_state}
        timeCreated: ${var.connection_time_created}
        timeStatusUpdated: ${var.connection_time_status_updated}
        timeUpdated: ${var.connection_time_updated}
        updatedById: ${oci_datacatalog_updated_by.test_updated_by.id}

Using getConnections

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 getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>
function getConnectionsOutput(args: GetConnectionsOutputArgs, opts?: InvokeOptions): Output<GetConnectionsResult>

def get_connections(catalog_id: Optional[str] = None,
                    created_by_id: Optional[str] = None,
                    data_asset_key: Optional[str] = None,
                    display_name: Optional[str] = None,
                    display_name_contains: Optional[str] = None,
                    external_key: Optional[str] = None,
                    fields: Optional[Sequence[str]] = None,
                    filters: Optional[Sequence[_datacatalog.GetConnectionsFilter]] = None,
                    is_default: Optional[bool] = None,
                    state: Optional[str] = None,
                    time_created: Optional[str] = None,
                    time_status_updated: Optional[str] = None,
                    time_updated: Optional[str] = None,
                    updated_by_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetConnectionsResult
def get_connections_output(catalog_id: Optional[pulumi.Input[str]] = None,
                    created_by_id: Optional[pulumi.Input[str]] = None,
                    data_asset_key: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    display_name_contains: Optional[pulumi.Input[str]] = None,
                    external_key: Optional[pulumi.Input[str]] = None,
                    fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datacatalog.GetConnectionsFilterArgs]]]] = None,
                    is_default: Optional[pulumi.Input[bool]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    time_created: Optional[pulumi.Input[str]] = None,
                    time_status_updated: Optional[pulumi.Input[str]] = None,
                    time_updated: Optional[pulumi.Input[str]] = None,
                    updated_by_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetConnectionsResult]

func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)
func GetConnectionsOutput(ctx *Context, args *GetConnectionsOutputArgs, opts ...InvokeOption) GetConnectionsResultOutput

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

public static class GetConnections 
{
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionsResult> Invoke(GetConnectionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataCatalog/getConnections:getConnections
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string: Unique catalog identifier.
DataAssetKey string: Unique data asset key.
CreatedById string: OCID of the user who created the resource.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayNameContains string: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
ExternalKey string: Unique external identifier of this resource in the external source system.
Fields List<string>: Specifies the fields to return in a connection summary response.
Filters List<GetConnectionsFilter>
IsDefault bool: Indicates whether this connection is the default connection.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
TimeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
TimeUpdated string: Time that the resource was updated. An RFC3339 formatted datetime string.
UpdatedById string: OCID of the user who updated the resource.

CatalogId string: Unique catalog identifier.
DataAssetKey string: Unique data asset key.
CreatedById string: OCID of the user who created the resource.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayNameContains string: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
ExternalKey string: Unique external identifier of this resource in the external source system.
Fields []string: Specifies the fields to return in a connection summary response.
Filters []GetConnectionsFilter
IsDefault bool: Indicates whether this connection is the default connection.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
TimeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
TimeUpdated string: Time that the resource was updated. An RFC3339 formatted datetime string.
UpdatedById string: OCID of the user who updated the resource.

catalogId String: Unique catalog identifier.
dataAssetKey String: Unique data asset key.
createdById String: OCID of the user who created the resource.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
displayNameContains String: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
externalKey String: Unique external identifier of this resource in the external source system.
fields List<String>: Specifies the fields to return in a connection summary response.
filters List<GetConnectionsFilter>
isDefault Boolean: Indicates whether this connection is the default connection.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated String: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated String: Time that the resource was updated. An RFC3339 formatted datetime string.
updatedById String: OCID of the user who updated the resource.

catalogId string: Unique catalog identifier.
dataAssetKey string: Unique data asset key.
createdById string: OCID of the user who created the resource.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
displayNameContains string: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
externalKey string: Unique external identifier of this resource in the external source system.
fields string[]: Specifies the fields to return in a connection summary response.
filters GetConnectionsFilter[]
isDefault boolean: Indicates whether this connection is the default connection.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated string: Time that the resource was updated. An RFC3339 formatted datetime string.
updatedById string: OCID of the user who updated the resource.

catalog_id str: Unique catalog identifier.
data_asset_key str: Unique data asset key.
created_by_id str: OCID of the user who created the resource.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
display_name_contains str: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
external_key str: Unique external identifier of this resource in the external source system.
fields Sequence[str]: Specifies the fields to return in a connection summary response.
filters GetConnectionsFilter]
is_default bool: Indicates whether this connection is the default connection.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
time_created str: Time that the resource was created. An RFC3339 formatted datetime string.
time_status_updated str: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
time_updated str: Time that the resource was updated. An RFC3339 formatted datetime string.
updated_by_id str: OCID of the user who updated the resource.

catalogId String: Unique catalog identifier.
dataAssetKey String: Unique data asset key.
createdById String: OCID of the user who created the resource.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
displayNameContains String: A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
externalKey String: Unique external identifier of this resource in the external source system.
fields List<String>: Specifies the fields to return in a connection summary response.
filters List<Property Map>
isDefault Boolean: Indicates whether this connection is the default connection.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated String: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated String: Time that the resource was updated. An RFC3339 formatted datetime string.
updatedById String: OCID of the user who updated the resource.

getConnections Result

The following output properties are available:

CatalogId string
ConnectionCollections List<GetConnectionsConnectionCollection>: The list of connection_collection.
DataAssetKey string: Unique key of the parent data asset.
Id string: The provider-assigned unique ID for this managed resource.
CreatedById string: OCID of the user who created the connection.
DisplayName string: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayNameContains string
ExternalKey string: Unique external key of this object from the source system.
Fields List<string>
Filters List<GetConnectionsFilter>
IsDefault bool: Indicates whether this connection is the default connection.
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.

CatalogId string
ConnectionCollections []GetConnectionsConnectionCollection: The list of connection_collection.
DataAssetKey string: Unique key of the parent data asset.
Id string: The provider-assigned unique ID for this managed resource.
CreatedById string: OCID of the user who created the connection.
DisplayName string: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayNameContains string
ExternalKey string: Unique external key of this object from the source system.
Fields []string
Filters []GetConnectionsFilter
IsDefault bool: Indicates whether this connection is the default connection.
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.

catalogId String
connectionCollections List<GetConnectionsConnectionCollection>: The list of connection_collection.
dataAssetKey String: Unique key of the parent data asset.
id String: The provider-assigned unique ID for this managed resource.
createdById String: OCID of the user who created the connection.
displayName String: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
displayNameContains String
externalKey String: Unique external key of this object from the source system.
fields List<String>
filters List<GetConnectionsFilter>
isDefault Boolean: Indicates whether this connection is the default connection.
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.

catalogId string
connectionCollections GetConnectionsConnectionCollection[]: The list of connection_collection.
dataAssetKey string: Unique key of the parent data asset.
id string: The provider-assigned unique ID for this managed resource.
createdById string: OCID of the user who created the connection.
displayName string: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
displayNameContains string
externalKey string: Unique external key of this object from the source system.
fields string[]
filters GetConnectionsFilter[]
isDefault boolean: Indicates whether this connection is the default connection.
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.

catalog_id str
connection_collections GetConnectionsConnectionCollection]: The list of connection_collection.
data_asset_key str: Unique key of the parent data asset.
id str: The provider-assigned unique ID for this managed resource.
created_by_id str: OCID of the user who created the connection.
display_name str: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
display_name_contains str
external_key str: Unique external key of this object from the source system.
fields Sequence[str]
filters GetConnectionsFilter]
is_default bool: Indicates whether this connection is the default connection.
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.

catalogId String
connectionCollections List<Property Map>: The list of connection_collection.
dataAssetKey String: Unique key of the parent data asset.
id String: The provider-assigned unique ID for this managed resource.
createdById String: OCID of the user who created the connection.
displayName String: A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
displayNameContains String
externalKey String: Unique external key of this object from the source system.
fields List<String>
filters List<Property Map>
isDefault Boolean: Indicates whether this connection is the default connection.
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.

Supporting Types

GetConnectionsConnectionCollection

Count int
Items List<GetConnectionsConnectionCollectionItem>

Count int
Items []GetConnectionsConnectionCollectionItem

count Integer
items List<GetConnectionsConnectionCollectionItem>

count number
items GetConnectionsConnectionCollectionItem[]

count int
items GetConnectionsConnectionCollectionItem]

count Number
items List<Property Map>

GetConnectionsConnectionCollectionItem

CatalogId string: Unique catalog identifier.
CreatedById string: OCID of the user who created the resource.
DataAssetKey string: Unique data asset key.
Description string: A description of the connection.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
ExternalKey string: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
TimeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
TimeUpdated string: Time that the resource was updated. 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 updated the resource.
Uri string: URI to the connection instance in the API.
EncProperties Dictionary<string, object>

CatalogId string: Unique catalog identifier.
CreatedById string: OCID of the user who created the resource.
DataAssetKey string: Unique data asset key.
Description string: A description of the connection.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
ExternalKey string: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
TimeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
TimeUpdated string: Time that the resource was updated. 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 updated the resource.
Uri string: URI to the connection instance in the API.
EncProperties map[string]interface{}

catalogId String: Unique catalog identifier.
createdById String: OCID of the user who created the resource.
dataAssetKey String: Unique data asset key.
description String: A description of the connection.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
externalKey String: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated String: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated String: Time that the resource was updated. 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 updated the resource.
uri String: URI to the connection instance in the API.
encProperties Map<String,Object>

catalogId string: Unique catalog identifier.
createdById string: OCID of the user who created the resource.
dataAssetKey string: Unique data asset key.
description string: A description of the connection.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
externalKey string: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated string: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated string: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated string: Time that the resource was updated. 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 updated the resource.
uri string: URI to the connection instance in the API.
encProperties {[key: string]: any}

catalog_id str: Unique catalog identifier.
created_by_id str: OCID of the user who created the resource.
data_asset_key str: Unique data asset key.
description str: A description of the connection.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
external_key str: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
time_created str: Time that the resource was created. An RFC3339 formatted datetime string.
time_status_updated str: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
time_updated str: Time that the resource was updated. 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 updated the resource.
uri str: URI to the connection instance in the API.
enc_properties Mapping[str, Any]

catalogId String: Unique catalog identifier.
createdById String: OCID of the user who created the resource.
dataAssetKey String: Unique data asset key.
description String: A description of the connection.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
externalKey String: Unique external identifier of this resource in the external source system.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: Time that the resource was created. An RFC3339 formatted datetime string.
timeStatusUpdated String: Time that the resource's status was last updated. An RFC3339 formatted datetime string.
timeUpdated String: Time that the resource was updated. 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 updated the resource.
uri String: URI to the connection instance in the API.
encProperties Map<Any>

GetConnectionsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

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