1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. DatabaseTools
  6. getRuntimeDatabaseToolsConnectionPropertySet
Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.DatabaseTools.getRuntimeDatabaseToolsConnectionPropertySet

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Database Tools Connection Property Set resource in Oracle Cloud Infrastructure Database Tools Runtime service.

    Get a property set

    Example Usage

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

const testDatabaseToolsConnectionPropertySet = oci.databasetools.getRuntimeDatabaseToolsConnectionPropertySet({
    databaseToolsConnectionId: testDatabaseToolsConnection.id,
    propertySetKey: databaseToolsConnectionPropertySetPropertySetKey,
});

    import pulumi
import pulumi_oci as oci

test_database_tools_connection_property_set = oci.databasetools.get_runtime_database_tools_connection_property_set(database_tools_connection_id=test_database_tools_connection["id"],
    property_set_key=database_tools_connection_property_set_property_set_key)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasetools.GetRuntimeDatabaseToolsConnectionPropertySet(ctx, &databasetools.GetRuntimeDatabaseToolsConnectionPropertySetArgs{
			DatabaseToolsConnectionId: testDatabaseToolsConnection.Id,
			PropertySetKey:            databaseToolsConnectionPropertySetPropertySetKey,
		}, nil)
		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 testDatabaseToolsConnectionPropertySet = Oci.DatabaseTools.GetRuntimeDatabaseToolsConnectionPropertySet.Invoke(new()
    {
        DatabaseToolsConnectionId = testDatabaseToolsConnection.Id,
        PropertySetKey = databaseToolsConnectionPropertySetPropertySetKey,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.DatabaseToolsFunctions;
import com.pulumi.oci.DatabaseTools.inputs.GetRuntimeDatabaseToolsConnectionPropertySetArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 testDatabaseToolsConnectionPropertySet = DatabaseToolsFunctions.getRuntimeDatabaseToolsConnectionPropertySet(GetRuntimeDatabaseToolsConnectionPropertySetArgs.builder()
            .databaseToolsConnectionId(testDatabaseToolsConnection.id())
            .propertySetKey(databaseToolsConnectionPropertySetPropertySetKey)
            .build());

    }
}

    variables:
  testDatabaseToolsConnectionPropertySet:
    fn::invoke:
      function: oci:DatabaseTools:getRuntimeDatabaseToolsConnectionPropertySet
      arguments:
        databaseToolsConnectionId: ${testDatabaseToolsConnection.id}
        propertySetKey: ${databaseToolsConnectionPropertySetPropertySetKey}

    Example coming soon!

    Using getRuntimeDatabaseToolsConnectionPropertySet

    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 getRuntimeDatabaseToolsConnectionPropertySet(args: GetRuntimeDatabaseToolsConnectionPropertySetArgs, opts?: InvokeOptions): Promise<GetRuntimeDatabaseToolsConnectionPropertySetResult>
function getRuntimeDatabaseToolsConnectionPropertySetOutput(args: GetRuntimeDatabaseToolsConnectionPropertySetOutputArgs, opts?: InvokeOptions): Output<GetRuntimeDatabaseToolsConnectionPropertySetResult>
    def get_runtime_database_tools_connection_property_set(database_tools_connection_id: Optional[str] = None,
                                                       property_set_key: Optional[str] = None,
                                                       opts: Optional[InvokeOptions] = None) -> GetRuntimeDatabaseToolsConnectionPropertySetResult
def get_runtime_database_tools_connection_property_set_output(database_tools_connection_id: pulumi.Input[Optional[str]] = None,
                                                       property_set_key: pulumi.Input[Optional[str]] = None,
                                                       opts: Optional[InvokeOptions] = None) -> Output[GetRuntimeDatabaseToolsConnectionPropertySetResult]
    func LookupRuntimeDatabaseToolsConnectionPropertySet(ctx *Context, args *LookupRuntimeDatabaseToolsConnectionPropertySetArgs, opts ...InvokeOption) (*LookupRuntimeDatabaseToolsConnectionPropertySetResult, error)
func LookupRuntimeDatabaseToolsConnectionPropertySetOutput(ctx *Context, args *LookupRuntimeDatabaseToolsConnectionPropertySetOutputArgs, opts ...InvokeOption) LookupRuntimeDatabaseToolsConnectionPropertySetResultOutput

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

    public static class GetRuntimeDatabaseToolsConnectionPropertySet 
{
    public static Task<GetRuntimeDatabaseToolsConnectionPropertySetResult> InvokeAsync(GetRuntimeDatabaseToolsConnectionPropertySetArgs args, InvokeOptions? opts = null)
    public static Output<GetRuntimeDatabaseToolsConnectionPropertySetResult> Invoke(GetRuntimeDatabaseToolsConnectionPropertySetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuntimeDatabaseToolsConnectionPropertySetResult> getRuntimeDatabaseToolsConnectionPropertySet(GetRuntimeDatabaseToolsConnectionPropertySetArgs args, InvokeOptions options)
public static Output<GetRuntimeDatabaseToolsConnectionPropertySetResult> getRuntimeDatabaseToolsConnectionPropertySet(GetRuntimeDatabaseToolsConnectionPropertySetArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DatabaseTools/getRuntimeDatabaseToolsConnectionPropertySet:getRuntimeDatabaseToolsConnectionPropertySet
  arguments:
    # arguments dictionary
    data "oci_databasetools_getruntimedatabasetoolsconnectionpropertyset" "name" {
    # arguments
}

    The following arguments are supported:

    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    PropertySetKey string
    The name of the property set
    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    PropertySetKey string
    The name of the property set
    database_tools_connection_id string
    The OCID of a Database Tools connection.
    property_set_key string
    The name of the property set
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    propertySetKey String
    The name of the property set
    databaseToolsConnectionId string
    The OCID of a Database Tools connection.
    propertySetKey string
    The name of the property set
    database_tools_connection_id str
    The OCID of a Database Tools connection.
    property_set_key str
    The name of the property set
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    propertySetKey String
    The name of the property set

    getRuntimeDatabaseToolsConnectionPropertySet Result

    The following output properties are available:

    AuthenticationSubstitutions Dictionary<string, string>
    APEX FA Integration key-value pairs.
    AutonomousDatabaseResourcePrincipalStatus string
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    CredentialKey string
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    DatabaseToolsConnectionId string
    FunctionId string
    The OCID of the Document Generator function
    Id string
    IdentityProviders List<GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider>
    External identity type provider
    InstanceDbmsCredentialEnabled string
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    InvokeEndpoint string
    The base endpoint URL to use to invoke the Document Generator function
    IsMutable bool
    Indicates whether the property set is mutable or not
    Key string
    The name of the property set
    ObjectStorageBucketCompartmentId string
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    ObjectStorageEndpoint string
    Object Storage Endpoint
    ObjectStorageNamespace string
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    PrerequisitesChecks List<GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck>
    The results of a prerequisites check for APEX FA integration
    PrintServerType string
    The print server type
    PropertySetKey string
    UserKey string
    The APEX engine schema name
    Version string
    The version of APEX
    AuthenticationSubstitutions map[string]string
    APEX FA Integration key-value pairs.
    AutonomousDatabaseResourcePrincipalStatus string
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    CredentialKey string
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    DatabaseToolsConnectionId string
    FunctionId string
    The OCID of the Document Generator function
    Id string
    IdentityProviders []GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider
    External identity type provider
    InstanceDbmsCredentialEnabled string
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    InvokeEndpoint string
    The base endpoint URL to use to invoke the Document Generator function
    IsMutable bool
    Indicates whether the property set is mutable or not
    Key string
    The name of the property set
    ObjectStorageBucketCompartmentId string
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    ObjectStorageEndpoint string
    Object Storage Endpoint
    ObjectStorageNamespace string
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    PrerequisitesChecks []GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck
    The results of a prerequisites check for APEX FA integration
    PrintServerType string
    The print server type
    PropertySetKey string
    UserKey string
    The APEX engine schema name
    Version string
    The version of APEX
    authentication_substitutions map(string)
    APEX FA Integration key-value pairs.
    autonomous_database_resource_principal_status string
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    credential_key string
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    database_tools_connection_id string
    function_id string
    The OCID of the Document Generator function
    id string
    identity_providers list(object)
    External identity type provider
    instance_dbms_credential_enabled string
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    invoke_endpoint string
    The base endpoint URL to use to invoke the Document Generator function
    is_mutable bool
    Indicates whether the property set is mutable or not
    key string
    The name of the property set
    object_storage_bucket_compartment_id string
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    object_storage_endpoint string
    Object Storage Endpoint
    object_storage_namespace string
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    prerequisites_checks list(object)
    The results of a prerequisites check for APEX FA integration
    print_server_type string
    The print server type
    property_set_key string
    user_key string
    The APEX engine schema name
    version string
    The version of APEX
    authenticationSubstitutions Map<String,String>
    APEX FA Integration key-value pairs.
    autonomousDatabaseResourcePrincipalStatus String
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    credentialKey String
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    databaseToolsConnectionId String
    functionId String
    The OCID of the Document Generator function
    id String
    identityProviders List<GetRuntimeConnectionPropertySetIdentityProvider>
    External identity type provider
    instanceDbmsCredentialEnabled String
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    invokeEndpoint String
    The base endpoint URL to use to invoke the Document Generator function
    isMutable Boolean
    Indicates whether the property set is mutable or not
    key String
    The name of the property set
    objectStorageBucketCompartmentId String
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    objectStorageEndpoint String
    Object Storage Endpoint
    objectStorageNamespace String
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    prerequisitesChecks List<GetRuntimeConnectionPropertySetPrerequisitesCheck>
    The results of a prerequisites check for APEX FA integration
    printServerType String
    The print server type
    propertySetKey String
    userKey String
    The APEX engine schema name
    version String
    The version of APEX
    authenticationSubstitutions {[key: string]: string}
    APEX FA Integration key-value pairs.
    autonomousDatabaseResourcePrincipalStatus string
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    credentialKey string
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    databaseToolsConnectionId string
    functionId string
    The OCID of the Document Generator function
    id string
    identityProviders GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider[]
    External identity type provider
    instanceDbmsCredentialEnabled string
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    invokeEndpoint string
    The base endpoint URL to use to invoke the Document Generator function
    isMutable boolean
    Indicates whether the property set is mutable or not
    key string
    The name of the property set
    objectStorageBucketCompartmentId string
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    objectStorageEndpoint string
    Object Storage Endpoint
    objectStorageNamespace string
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    prerequisitesChecks GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck[]
    The results of a prerequisites check for APEX FA integration
    printServerType string
    The print server type
    propertySetKey string
    userKey string
    The APEX engine schema name
    version string
    The version of APEX
    authentication_substitutions Mapping[str, str]
    APEX FA Integration key-value pairs.
    autonomous_database_resource_principal_status str
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    credential_key str
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    database_tools_connection_id str
    function_id str
    The OCID of the Document Generator function
    id str
    identity_providers Sequence[GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider]
    External identity type provider
    instance_dbms_credential_enabled str
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    invoke_endpoint str
    The base endpoint URL to use to invoke the Document Generator function
    is_mutable bool
    Indicates whether the property set is mutable or not
    key str
    The name of the property set
    object_storage_bucket_compartment_id str
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    object_storage_endpoint str
    Object Storage Endpoint
    object_storage_namespace str
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    prerequisites_checks Sequence[GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck]
    The results of a prerequisites check for APEX FA integration
    print_server_type str
    The print server type
    property_set_key str
    user_key str
    The APEX engine schema name
    version str
    The version of APEX
    authenticationSubstitutions Map<String>
    APEX FA Integration key-value pairs.
    autonomousDatabaseResourcePrincipalStatus String
    The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
    credentialKey String
    The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
    databaseToolsConnectionId String
    functionId String
    The OCID of the Document Generator function
    id String
    identityProviders List<Property Map>
    External identity type provider
    instanceDbmsCredentialEnabled String
    Specifies whether database credentials can be used in all workspaces on the APEX instance. Supported values include: "Y", "N" and empty string.
    invokeEndpoint String
    The base endpoint URL to use to invoke the Document Generator function
    isMutable Boolean
    Indicates whether the property set is mutable or not
    key String
    The name of the property set
    objectStorageBucketCompartmentId String
    The OCID of the compartment containing the Object Storage Buckets managed by APEX
    objectStorageEndpoint String
    Object Storage Endpoint
    objectStorageNamespace String
    The Object Storage Namespace containing the Object Storage Buckets managed by APEX
    prerequisitesChecks List<Property Map>
    The results of a prerequisites check for APEX FA integration
    printServerType String
    The print server type
    propertySetKey String
    userKey String
    The APEX engine schema name
    version String
    The version of APEX

    Supporting Types

    GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider

    Configs Dictionary<string, string>
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    Type string
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    Configs map[string]string
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    Type string
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    configs map(string)
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    type string
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    configs Map<String,String>
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    type String
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    configs {[key: string]: string}
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    type string
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    configs Mapping[str, str]
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    type str
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.
    configs Map<String>
    External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... }
    type String
    External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE.

    GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck

    Status string
    Status indicating the outcome of the prerequisites check.
    StatusDetails List<string>
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    Status string
    Status indicating the outcome of the prerequisites check.
    StatusDetails []string
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    status string
    Status indicating the outcome of the prerequisites check.
    status_details list(string)
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    status String
    Status indicating the outcome of the prerequisites check.
    statusDetails List<String>
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    status string
    Status indicating the outcome of the prerequisites check.
    statusDetails string[]
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    status str
    Status indicating the outcome of the prerequisites check.
    status_details Sequence[str]
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
    status String
    Status indicating the outcome of the prerequisites check.
    statusDetails List<String>
    Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.11.0
    published on Friday, May 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.