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

oci.DatabaseTools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym

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 resource provides the Database Tools Connection Credential Public Synonym resource in Oracle Cloud Infrastructure Database Tools Runtime service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/database_tools_runtime

    Creates a public synonym for the given credentials

    Example Usage

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

const testDatabaseToolsConnectionCredentialPublicSynonym = new oci.databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("test_database_tools_connection_credential_public_synonym", {
    credentialKey: databaseToolsConnectionCredentialPublicSynonymCredentialKey,
    databaseToolsConnectionId: testDatabaseToolsConnection.id,
    key: databaseToolsConnectionCredentialPublicSynonymKey,
});

    import pulumi
import pulumi_oci as oci

test_database_tools_connection_credential_public_synonym = oci.databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("test_database_tools_connection_credential_public_synonym",
    credential_key=database_tools_connection_credential_public_synonym_credential_key,
    database_tools_connection_id=test_database_tools_connection["id"],
    key=database_tools_connection_credential_public_synonym_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.NewRuntimeDatabaseToolsConnectionCredentialPublicSynonym(ctx, "test_database_tools_connection_credential_public_synonym", &databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs{
			CredentialKey:             pulumi.Any(databaseToolsConnectionCredentialPublicSynonymCredentialKey),
			DatabaseToolsConnectionId: pulumi.Any(testDatabaseToolsConnection.Id),
			Key:                       pulumi.Any(databaseToolsConnectionCredentialPublicSynonymKey),
		})
		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 testDatabaseToolsConnectionCredentialPublicSynonym = new Oci.DatabaseTools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("test_database_tools_connection_credential_public_synonym", new()
    {
        CredentialKey = databaseToolsConnectionCredentialPublicSynonymCredentialKey,
        DatabaseToolsConnectionId = testDatabaseToolsConnection.Id,
        Key = databaseToolsConnectionCredentialPublicSynonymKey,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs;
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) {
        var testDatabaseToolsConnectionCredentialPublicSynonym = new RuntimeDatabaseToolsConnectionCredentialPublicSynonym("testDatabaseToolsConnectionCredentialPublicSynonym", RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs.builder()
            .credentialKey(databaseToolsConnectionCredentialPublicSynonymCredentialKey)
            .databaseToolsConnectionId(testDatabaseToolsConnection.id())
            .key(databaseToolsConnectionCredentialPublicSynonymKey)
            .build());

    }
}

    resources:
  testDatabaseToolsConnectionCredentialPublicSynonym:
    type: oci:DatabaseTools:RuntimeDatabaseToolsConnectionCredentialPublicSynonym
    name: test_database_tools_connection_credential_public_synonym
    properties:
      credentialKey: ${databaseToolsConnectionCredentialPublicSynonymCredentialKey}
      databaseToolsConnectionId: ${testDatabaseToolsConnection.id}
      key: ${databaseToolsConnectionCredentialPublicSynonymKey}

    Example coming soon!

    Create RuntimeDatabaseToolsConnectionCredentialPublicSynonym Resource

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

    Constructor syntax

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

@overload
def RuntimeDatabaseToolsConnectionCredentialPublicSynonym(resource_name: str,
                                                          opts: Optional[ResourceOptions] = None,
                                                          credential_key: Optional[str] = None,
                                                          database_tools_connection_id: Optional[str] = None,
                                                          key: Optional[str] = None)
    func NewRuntimeDatabaseToolsConnectionCredentialPublicSynonym(ctx *Context, name string, args RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs, opts ...ResourceOption) (*RuntimeDatabaseToolsConnectionCredentialPublicSynonym, error)
    public RuntimeDatabaseToolsConnectionCredentialPublicSynonym(string name, RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs args, CustomResourceOptions? opts = null)
    public RuntimeDatabaseToolsConnectionCredentialPublicSynonym(String name, RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs args)
public RuntimeDatabaseToolsConnectionCredentialPublicSynonym(String name, RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs args, CustomResourceOptions options)

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


    resource "oci_databasetools_runtimedatabasetoolsconnectioncredentialpublicsynonym" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs
    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 RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs
    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 RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs
    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 runtimeDatabaseToolsConnectionCredentialPublicSynonymResource = new Oci.DatabaseTools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("runtimeDatabaseToolsConnectionCredentialPublicSynonymResource", new()
{
    CredentialKey = "string",
    DatabaseToolsConnectionId = "string",
    Key = "string",
});

    example, err := databasetools.NewRuntimeDatabaseToolsConnectionCredentialPublicSynonym(ctx, "runtimeDatabaseToolsConnectionCredentialPublicSynonymResource", &databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs{
	CredentialKey:             pulumi.String("string"),
	DatabaseToolsConnectionId: pulumi.String("string"),
	Key:                       pulumi.String("string"),
})

    resource "oci_databasetools_runtimedatabasetoolsconnectioncredentialpublicsynonym" "runtimeDatabaseToolsConnectionCredentialPublicSynonymResource" {
  credential_key               = "string"
  database_tools_connection_id = "string"
  key                          = "string"
}

    var runtimeDatabaseToolsConnectionCredentialPublicSynonymResource = new RuntimeDatabaseToolsConnectionCredentialPublicSynonym("runtimeDatabaseToolsConnectionCredentialPublicSynonymResource", RuntimeDatabaseToolsConnectionCredentialPublicSynonymArgs.builder()
    .credentialKey("string")
    .databaseToolsConnectionId("string")
    .key("string")
    .build());

    runtime_database_tools_connection_credential_public_synonym_resource = oci.databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("runtimeDatabaseToolsConnectionCredentialPublicSynonymResource",
    credential_key="string",
    database_tools_connection_id="string",
    key="string")

    const runtimeDatabaseToolsConnectionCredentialPublicSynonymResource = new oci.databasetools.RuntimeDatabaseToolsConnectionCredentialPublicSynonym("runtimeDatabaseToolsConnectionCredentialPublicSynonymResource", {
    credentialKey: "string",
    databaseToolsConnectionId: "string",
    key: "string",
});

    type: oci:DatabaseTools:RuntimeDatabaseToolsConnectionCredentialPublicSynonym
properties:
    credentialKey: string
    databaseToolsConnectionId: string
    key: string

    RuntimeDatabaseToolsConnectionCredentialPublicSynonym Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RuntimeDatabaseToolsConnectionCredentialPublicSynonym resource accepts the following input properties:

    CredentialKey string
    The name of the credential
    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    Key string

    The name of the public synonym for the credential

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

    CredentialKey string
    The name of the credential
    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    Key string

    The name of the public synonym for the credential

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

    credential_key string
    The name of the credential
    database_tools_connection_id string
    The OCID of a Database Tools connection.
    key string

    The name of the public synonym for the credential

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

    credentialKey String
    The name of the credential
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    key String

    The name of the public synonym for the credential

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

    credentialKey string
    The name of the credential
    databaseToolsConnectionId string
    The OCID of a Database Tools connection.
    key string

    The name of the public synonym for the credential

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

    credential_key str
    The name of the credential
    database_tools_connection_id str
    The OCID of a Database Tools connection.
    key str

    The name of the public synonym for the credential

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

    credentialKey String
    The name of the credential
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    key String

    The name of the public synonym for the credential

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RuntimeDatabaseToolsConnectionCredentialPublicSynonym Resource

    Get an existing RuntimeDatabaseToolsConnectionCredentialPublicSynonym 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?: RuntimeDatabaseToolsConnectionCredentialPublicSynonymState, opts?: CustomResourceOptions): RuntimeDatabaseToolsConnectionCredentialPublicSynonym
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_key: Optional[str] = None,
        database_tools_connection_id: Optional[str] = None,
        key: Optional[str] = None) -> RuntimeDatabaseToolsConnectionCredentialPublicSynonym
    func GetRuntimeDatabaseToolsConnectionCredentialPublicSynonym(ctx *Context, name string, id IDInput, state *RuntimeDatabaseToolsConnectionCredentialPublicSynonymState, opts ...ResourceOption) (*RuntimeDatabaseToolsConnectionCredentialPublicSynonym, error)
    public static RuntimeDatabaseToolsConnectionCredentialPublicSynonym Get(string name, Input<string> id, RuntimeDatabaseToolsConnectionCredentialPublicSynonymState? state, CustomResourceOptions? opts = null)
    public static RuntimeDatabaseToolsConnectionCredentialPublicSynonym get(String name, Output<String> id, RuntimeDatabaseToolsConnectionCredentialPublicSynonymState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseTools:RuntimeDatabaseToolsConnectionCredentialPublicSynonym    get:      id: ${id}
    import {
  to = oci_databasetools_runtimedatabasetoolsconnectioncredentialpublicsynonym.example
  id = "${id}"
}
    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:
    CredentialKey string
    The name of the credential
    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    Key string

    The name of the public synonym for the credential

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

    CredentialKey string
    The name of the credential
    DatabaseToolsConnectionId string
    The OCID of a Database Tools connection.
    Key string

    The name of the public synonym for the credential

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

    credential_key string
    The name of the credential
    database_tools_connection_id string
    The OCID of a Database Tools connection.
    key string

    The name of the public synonym for the credential

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

    credentialKey String
    The name of the credential
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    key String

    The name of the public synonym for the credential

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

    credentialKey string
    The name of the credential
    databaseToolsConnectionId string
    The OCID of a Database Tools connection.
    key string

    The name of the public synonym for the credential

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

    credential_key str
    The name of the credential
    database_tools_connection_id str
    The OCID of a Database Tools connection.
    key str

    The name of the public synonym for the credential

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

    credentialKey String
    The name of the credential
    databaseToolsConnectionId String
    The OCID of a Database Tools connection.
    key String

    The name of the public synonym for the credential

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

    Import

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

    $ pulumi import oci:DatabaseTools/runtimeDatabaseToolsConnectionCredentialPublicSynonym:RuntimeDatabaseToolsConnectionCredentialPublicSynonym test_database_tools_connection_credential_public_synonym "databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}"

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