1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseTools
  5. DatabaseToolsConnection
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DatabaseTools.DatabaseToolsConnection

This resource provides the Database Tools Connection resource in Oracle Cloud Infrastructure Database Tools service.

Creates a new Database Tools connection.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDatabaseToolsConnection = new Oci.DatabaseTools.DatabaseToolsConnection("testDatabaseToolsConnection", new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Database_tools_connection_display_name,
        Type = @var.Database_tools_connection_type,
        AdvancedProperties = @var.Database_tools_connection_advanced_properties,
        ConnectionString = @var.Database_tools_connection_connection_string,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        KeyStores = new[]
        {
            new Oci.DatabaseTools.Inputs.DatabaseToolsConnectionKeyStoreArgs
            {
                KeyStoreContent = new Oci.DatabaseTools.Inputs.DatabaseToolsConnectionKeyStoreKeyStoreContentArgs
                {
                    ValueType = @var.Database_tools_connection_key_stores_key_store_content_value_type,
                    SecretId = oci_vault_secret.Test_secret.Id,
                },
                KeyStorePassword = new Oci.DatabaseTools.Inputs.DatabaseToolsConnectionKeyStoreKeyStorePasswordArgs
                {
                    ValueType = @var.Database_tools_connection_key_stores_key_store_password_value_type,
                    SecretId = oci_vault_secret.Test_secret.Id,
                },
                KeyStoreType = @var.Database_tools_connection_key_stores_key_store_type,
            },
        },
        PrivateEndpointId = oci_dataflow_private_endpoint.Test_private_endpoint.Id,
        RelatedResource = new Oci.DatabaseTools.Inputs.DatabaseToolsConnectionRelatedResourceArgs
        {
            EntityType = @var.Database_tools_connection_related_resource_entity_type,
            Identifier = @var.Database_tools_connection_related_resource_identifier,
        },
        UserName = oci_identity_user.Test_user.Name,
        UserPassword = new Oci.DatabaseTools.Inputs.DatabaseToolsConnectionUserPasswordArgs
        {
            SecretId = oci_vault_secret.Test_secret.Id,
            ValueType = @var.Database_tools_connection_user_password_value_type,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseTools.NewDatabaseToolsConnection(ctx, "testDatabaseToolsConnection", &DatabaseTools.DatabaseToolsConnectionArgs{
			CompartmentId:      pulumi.Any(_var.Compartment_id),
			DisplayName:        pulumi.Any(_var.Database_tools_connection_display_name),
			Type:               pulumi.Any(_var.Database_tools_connection_type),
			AdvancedProperties: pulumi.Any(_var.Database_tools_connection_advanced_properties),
			ConnectionString:   pulumi.Any(_var.Database_tools_connection_connection_string),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			KeyStores: databasetools.DatabaseToolsConnectionKeyStoreArray{
				&databasetools.DatabaseToolsConnectionKeyStoreArgs{
					KeyStoreContent: &databasetools.DatabaseToolsConnectionKeyStoreKeyStoreContentArgs{
						ValueType: pulumi.Any(_var.Database_tools_connection_key_stores_key_store_content_value_type),
						SecretId:  pulumi.Any(oci_vault_secret.Test_secret.Id),
					},
					KeyStorePassword: &databasetools.DatabaseToolsConnectionKeyStoreKeyStorePasswordArgs{
						ValueType: pulumi.Any(_var.Database_tools_connection_key_stores_key_store_password_value_type),
						SecretId:  pulumi.Any(oci_vault_secret.Test_secret.Id),
					},
					KeyStoreType: pulumi.Any(_var.Database_tools_connection_key_stores_key_store_type),
				},
			},
			PrivateEndpointId: pulumi.Any(oci_dataflow_private_endpoint.Test_private_endpoint.Id),
			RelatedResource: &databasetools.DatabaseToolsConnectionRelatedResourceArgs{
				EntityType: pulumi.Any(_var.Database_tools_connection_related_resource_entity_type),
				Identifier: pulumi.Any(_var.Database_tools_connection_related_resource_identifier),
			},
			UserName: pulumi.Any(oci_identity_user.Test_user.Name),
			UserPassword: &databasetools.DatabaseToolsConnectionUserPasswordArgs{
				SecretId:  pulumi.Any(oci_vault_secret.Test_secret.Id),
				ValueType: pulumi.Any(_var.Database_tools_connection_user_password_value_type),
			},
		})
		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.DatabaseTools.DatabaseToolsConnection;
import com.pulumi.oci.DatabaseTools.DatabaseToolsConnectionArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsConnectionKeyStoreArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsConnectionKeyStoreKeyStoreContentArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsConnectionKeyStoreKeyStorePasswordArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsConnectionRelatedResourceArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsConnectionUserPasswordArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var testDatabaseToolsConnection = new DatabaseToolsConnection("testDatabaseToolsConnection", DatabaseToolsConnectionArgs.builder()        
            .compartmentId(var_.compartment_id())
            .displayName(var_.database_tools_connection_display_name())
            .type(var_.database_tools_connection_type())
            .advancedProperties(var_.database_tools_connection_advanced_properties())
            .connectionString(var_.database_tools_connection_connection_string())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .keyStores(DatabaseToolsConnectionKeyStoreArgs.builder()
                .keyStoreContent(DatabaseToolsConnectionKeyStoreKeyStoreContentArgs.builder()
                    .valueType(var_.database_tools_connection_key_stores_key_store_content_value_type())
                    .secretId(oci_vault_secret.test_secret().id())
                    .build())
                .keyStorePassword(DatabaseToolsConnectionKeyStoreKeyStorePasswordArgs.builder()
                    .valueType(var_.database_tools_connection_key_stores_key_store_password_value_type())
                    .secretId(oci_vault_secret.test_secret().id())
                    .build())
                .keyStoreType(var_.database_tools_connection_key_stores_key_store_type())
                .build())
            .privateEndpointId(oci_dataflow_private_endpoint.test_private_endpoint().id())
            .relatedResource(DatabaseToolsConnectionRelatedResourceArgs.builder()
                .entityType(var_.database_tools_connection_related_resource_entity_type())
                .identifier(var_.database_tools_connection_related_resource_identifier())
                .build())
            .userName(oci_identity_user.test_user().name())
            .userPassword(DatabaseToolsConnectionUserPasswordArgs.builder()
                .secretId(oci_vault_secret.test_secret().id())
                .valueType(var_.database_tools_connection_user_password_value_type())
                .build())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_database_tools_connection = oci.database_tools.DatabaseToolsConnection("testDatabaseToolsConnection",
    compartment_id=var["compartment_id"],
    display_name=var["database_tools_connection_display_name"],
    type=var["database_tools_connection_type"],
    advanced_properties=var["database_tools_connection_advanced_properties"],
    connection_string=var["database_tools_connection_connection_string"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    key_stores=[oci.database_tools.DatabaseToolsConnectionKeyStoreArgs(
        key_store_content=oci.database_tools.DatabaseToolsConnectionKeyStoreKeyStoreContentArgs(
            value_type=var["database_tools_connection_key_stores_key_store_content_value_type"],
            secret_id=oci_vault_secret["test_secret"]["id"],
        ),
        key_store_password=oci.database_tools.DatabaseToolsConnectionKeyStoreKeyStorePasswordArgs(
            value_type=var["database_tools_connection_key_stores_key_store_password_value_type"],
            secret_id=oci_vault_secret["test_secret"]["id"],
        ),
        key_store_type=var["database_tools_connection_key_stores_key_store_type"],
    )],
    private_endpoint_id=oci_dataflow_private_endpoint["test_private_endpoint"]["id"],
    related_resource=oci.database_tools.DatabaseToolsConnectionRelatedResourceArgs(
        entity_type=var["database_tools_connection_related_resource_entity_type"],
        identifier=var["database_tools_connection_related_resource_identifier"],
    ),
    user_name=oci_identity_user["test_user"]["name"],
    user_password=oci.database_tools.DatabaseToolsConnectionUserPasswordArgs(
        secret_id=oci_vault_secret["test_secret"]["id"],
        value_type=var["database_tools_connection_user_password_value_type"],
    ))

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

const testDatabaseToolsConnection = new oci.databasetools.DatabaseToolsConnection("testDatabaseToolsConnection", {
    compartmentId: _var.compartment_id,
    displayName: _var.database_tools_connection_display_name,
    type: _var.database_tools_connection_type,
    advancedProperties: _var.database_tools_connection_advanced_properties,
    connectionString: _var.database_tools_connection_connection_string,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    keyStores: [{
        keyStoreContent: {
            valueType: _var.database_tools_connection_key_stores_key_store_content_value_type,
            secretId: oci_vault_secret.test_secret.id,
        },
        keyStorePassword: {
            valueType: _var.database_tools_connection_key_stores_key_store_password_value_type,
            secretId: oci_vault_secret.test_secret.id,
        },
        keyStoreType: _var.database_tools_connection_key_stores_key_store_type,
    }],
    privateEndpointId: oci_dataflow_private_endpoint.test_private_endpoint.id,
    relatedResource: {
        entityType: _var.database_tools_connection_related_resource_entity_type,
        identifier: _var.database_tools_connection_related_resource_identifier,
    },
    userName: oci_identity_user.test_user.name,
    userPassword: {
        secretId: oci_vault_secret.test_secret.id,
        valueType: _var.database_tools_connection_user_password_value_type,
    },
});

resources:
  testDatabaseToolsConnection:
    type: oci:DatabaseTools:DatabaseToolsConnection
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      displayName: ${var.database_tools_connection_display_name}
      type: ${var.database_tools_connection_type}
      #Optional
      advancedProperties: ${var.database_tools_connection_advanced_properties}
      connectionString: ${var.database_tools_connection_connection_string}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      keyStores:
        - keyStoreContent:
            valueType: ${var.database_tools_connection_key_stores_key_store_content_value_type}
            secretId: ${oci_vault_secret.test_secret.id}
          keyStorePassword:
            valueType: ${var.database_tools_connection_key_stores_key_store_password_value_type}
            secretId: ${oci_vault_secret.test_secret.id}
          keyStoreType: ${var.database_tools_connection_key_stores_key_store_type}
      privateEndpointId: ${oci_dataflow_private_endpoint.test_private_endpoint.id}
      relatedResource:
        entityType: ${var.database_tools_connection_related_resource_entity_type}
        identifier: ${var.database_tools_connection_related_resource_identifier}
      userName: ${oci_identity_user.test_user.name}
      userPassword:
        secretId: ${oci_vault_secret.test_secret.id}
        valueType: ${var.database_tools_connection_user_password_value_type}

Create DatabaseToolsConnection Resource

new DatabaseToolsConnection(name: string, args: DatabaseToolsConnectionArgs, opts?: CustomResourceOptions);
@overload
def DatabaseToolsConnection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            advanced_properties: Optional[Mapping[str, Any]] = None,
                            compartment_id: Optional[str] = None,
                            connection_string: Optional[str] = None,
                            defined_tags: Optional[Mapping[str, Any]] = None,
                            display_name: Optional[str] = None,
                            freeform_tags: Optional[Mapping[str, Any]] = None,
                            key_stores: Optional[Sequence[_databasetools.DatabaseToolsConnectionKeyStoreArgs]] = None,
                            private_endpoint_id: Optional[str] = None,
                            related_resource: Optional[_databasetools.DatabaseToolsConnectionRelatedResourceArgs] = None,
                            type: Optional[str] = None,
                            user_name: Optional[str] = None,
                            user_password: Optional[_databasetools.DatabaseToolsConnectionUserPasswordArgs] = None)
@overload
def DatabaseToolsConnection(resource_name: str,
                            args: DatabaseToolsConnectionArgs,
                            opts: Optional[ResourceOptions] = None)
func NewDatabaseToolsConnection(ctx *Context, name string, args DatabaseToolsConnectionArgs, opts ...ResourceOption) (*DatabaseToolsConnection, error)
public DatabaseToolsConnection(string name, DatabaseToolsConnectionArgs args, CustomResourceOptions? opts = null)
public DatabaseToolsConnection(String name, DatabaseToolsConnectionArgs args)
public DatabaseToolsConnection(String name, DatabaseToolsConnectionArgs args, CustomResourceOptions options)

type: oci:DatabaseTools:DatabaseToolsConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseToolsConnectionArgs
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 DatabaseToolsConnectionArgs
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 DatabaseToolsConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseToolsConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatabaseToolsConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DatabaseToolsConnection Resource Properties

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

Inputs

The DatabaseToolsConnection resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

DisplayName string

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

Type string

(Updatable) The DatabaseToolsConnection type.

AdvancedProperties Dictionary<string, object>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

ConnectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

KeyStores List<DatabaseToolsConnectionKeyStoreArgs>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

PrivateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

RelatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

UserName string

(Updatable) The database user name.

UserPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

CompartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

DisplayName string

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

Type string

(Updatable) The DatabaseToolsConnection type.

AdvancedProperties map[string]interface{}

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

ConnectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

KeyStores []DatabaseToolsConnectionKeyStoreArgs

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

PrivateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

RelatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

UserName string

(Updatable) The database user name.

UserPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

compartmentId String

(Updatable) The OCID of the compartment containing the Database Tools connection.

displayName String

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

type String

(Updatable) The DatabaseToolsConnection type.

advancedProperties Map<String,Object>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

connectionString String

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores List<ConnectionKeyStoreArgs>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

privateEndpointId String

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource ConnectionRelatedResourceArgs

(Updatable) The related resource

userName String

(Updatable) The database user name.

userPassword ConnectionUserPasswordArgs

(Updatable) The user password.

compartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

displayName string

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

type string

(Updatable) The DatabaseToolsConnection type.

advancedProperties {[key: string]: any}

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

connectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores DatabaseToolsConnectionKeyStoreArgs[]

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

privateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

userName string

(Updatable) The database user name.

userPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

compartment_id str

(Updatable) The OCID of the compartment containing the Database Tools connection.

display_name str

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

type str

(Updatable) The DatabaseToolsConnection type.

advanced_properties Mapping[str, Any]

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

connection_string str

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

key_stores DatabaseToolsConnectionKeyStoreArgs]

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

private_endpoint_id str

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

related_resource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

user_name str

(Updatable) The database user name.

user_password DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

compartmentId String

(Updatable) The OCID of the compartment containing the Database Tools connection.

displayName String

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

type String

(Updatable) The DatabaseToolsConnection type.

advancedProperties Map<Any>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

connectionString String

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores List<Property Map>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

privateEndpointId String

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource Property Map

(Updatable) The related resource

userName String

(Updatable) The database user name.

userPassword Property Map

(Updatable) The user password.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

State string

The current state of the Database Tools connection.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

State string

The current state of the Database Tools connection.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

state String

The current state of the Database Tools connection.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

state string

The current state of the Database Tools connection.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

state str

The current state of the Database Tools connection.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

time_updated str

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

state String

The current state of the Database Tools connection.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

Look up Existing DatabaseToolsConnection Resource

Get an existing DatabaseToolsConnection 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?: DatabaseToolsConnectionState, opts?: CustomResourceOptions): DatabaseToolsConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_properties: Optional[Mapping[str, Any]] = None,
        compartment_id: Optional[str] = None,
        connection_string: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        key_stores: Optional[Sequence[_databasetools.DatabaseToolsConnectionKeyStoreArgs]] = None,
        lifecycle_details: Optional[str] = None,
        private_endpoint_id: Optional[str] = None,
        related_resource: Optional[_databasetools.DatabaseToolsConnectionRelatedResourceArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        type: Optional[str] = None,
        user_name: Optional[str] = None,
        user_password: Optional[_databasetools.DatabaseToolsConnectionUserPasswordArgs] = None) -> DatabaseToolsConnection
func GetDatabaseToolsConnection(ctx *Context, name string, id IDInput, state *DatabaseToolsConnectionState, opts ...ResourceOption) (*DatabaseToolsConnection, error)
public static DatabaseToolsConnection Get(string name, Input<string> id, DatabaseToolsConnectionState? state, CustomResourceOptions? opts = null)
public static DatabaseToolsConnection get(String name, Output<String> id, DatabaseToolsConnectionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdvancedProperties Dictionary<string, object>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

CompartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

ConnectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

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

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

KeyStores List<DatabaseToolsConnectionKeyStoreArgs>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

LifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

PrivateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

RelatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

State string

The current state of the Database Tools connection.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

Type string

(Updatable) The DatabaseToolsConnection type.

UserName string

(Updatable) The database user name.

UserPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

AdvancedProperties map[string]interface{}

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

CompartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

ConnectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

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

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

KeyStores []DatabaseToolsConnectionKeyStoreArgs

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

LifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

PrivateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

RelatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

State string

The current state of the Database Tools connection.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

Type string

(Updatable) The DatabaseToolsConnection type.

UserName string

(Updatable) The database user name.

UserPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

advancedProperties Map<String,Object>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

compartmentId String

(Updatable) The OCID of the compartment containing the Database Tools connection.

connectionString String

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

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

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores List<ConnectionKeyStoreArgs>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

lifecycleDetails String

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

privateEndpointId String

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource ConnectionRelatedResourceArgs

(Updatable) The related resource

state String

The current state of the Database Tools connection.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

type String

(Updatable) The DatabaseToolsConnection type.

userName String

(Updatable) The database user name.

userPassword ConnectionUserPasswordArgs

(Updatable) The user password.

advancedProperties {[key: string]: any}

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

compartmentId string

(Updatable) The OCID of the compartment containing the Database Tools connection.

connectionString string

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

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

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores DatabaseToolsConnectionKeyStoreArgs[]

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

lifecycleDetails string

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

privateEndpointId string

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

state string

The current state of the Database Tools connection.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

type string

(Updatable) The DatabaseToolsConnection type.

userName string

(Updatable) The database user name.

userPassword DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

advanced_properties Mapping[str, Any]

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

compartment_id str

(Updatable) The OCID of the compartment containing the Database Tools connection.

connection_string str

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

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

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

key_stores DatabaseToolsConnectionKeyStoreArgs]

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

lifecycle_details str

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

private_endpoint_id str

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

related_resource DatabaseToolsConnectionRelatedResourceArgs

(Updatable) The related resource

state str

The current state of the Database Tools connection.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

time_updated str

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

type str

(Updatable) The DatabaseToolsConnection type.

user_name str

(Updatable) The database user name.

user_password DatabaseToolsConnectionUserPasswordArgs

(Updatable) The user password.

advancedProperties Map<Any>

(Updatable) The advanced connection properties key-value pair (e.g., oracle.net.ssl_server_dn_match).

compartmentId String

(Updatable) The OCID of the compartment containing the Database Tools connection.

connectionString String

(Updatable) The connect descriptor or Easy Connect Naming method use to connect to the database.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

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

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

keyStores List<Property Map>

(Updatable) Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication.

lifecycleDetails String

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

privateEndpointId String

(Updatable) The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

relatedResource Property Map

(Updatable) The related resource

state String

The current state of the Database Tools connection.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the Database Tools connection was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.

type String

(Updatable) The DatabaseToolsConnection type.

userName String

(Updatable) The database user name.

userPassword Property Map

(Updatable) The user password.

Supporting Types

DatabaseToolsConnectionKeyStore

KeyStoreContent DatabaseToolsConnectionKeyStoreKeyStoreContent

(Updatable) The key store content.

KeyStorePassword DatabaseToolsConnectionKeyStoreKeyStorePassword

(Updatable) The key store password.

KeyStoreType string

(Updatable) The key store type.

KeyStoreContent DatabaseToolsConnectionKeyStoreKeyStoreContent

(Updatable) The key store content.

KeyStorePassword DatabaseToolsConnectionKeyStoreKeyStorePassword

(Updatable) The key store password.

KeyStoreType string

(Updatable) The key store type.

keyStoreContent ConnectionKeyStoreKeyStoreContent

(Updatable) The key store content.

keyStorePassword ConnectionKeyStoreKeyStorePassword

(Updatable) The key store password.

keyStoreType String

(Updatable) The key store type.

keyStoreContent DatabaseToolsConnectionKeyStoreKeyStoreContent

(Updatable) The key store content.

keyStorePassword DatabaseToolsConnectionKeyStoreKeyStorePassword

(Updatable) The key store password.

keyStoreType string

(Updatable) The key store type.

key_store_content DatabaseToolsConnectionKeyStoreKeyStoreContent

(Updatable) The key store content.

key_store_password DatabaseToolsConnectionKeyStoreKeyStorePassword

(Updatable) The key store password.

key_store_type str

(Updatable) The key store type.

keyStoreContent Property Map

(Updatable) The key store content.

keyStorePassword Property Map

(Updatable) The key store password.

keyStoreType String

(Updatable) The key store type.

DatabaseToolsConnectionKeyStoreKeyStoreContent

ValueType string

(Updatable) The value type of the user password.

SecretId string

(Updatable) The OCID of the secret containing the user password.

ValueType string

(Updatable) The value type of the user password.

SecretId string

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

valueType string

(Updatable) The value type of the user password.

secretId string

(Updatable) The OCID of the secret containing the user password.

value_type str

(Updatable) The value type of the user password.

secret_id str

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

DatabaseToolsConnectionKeyStoreKeyStorePassword

ValueType string

(Updatable) The value type of the user password.

SecretId string

(Updatable) The OCID of the secret containing the user password.

ValueType string

(Updatable) The value type of the user password.

SecretId string

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

valueType string

(Updatable) The value type of the user password.

secretId string

(Updatable) The OCID of the secret containing the user password.

value_type str

(Updatable) The value type of the user password.

secret_id str

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

DatabaseToolsConnectionRelatedResource

EntityType string

(Updatable) The resource entity type.

Identifier string

(Updatable) The OCID of the related resource.

EntityType string

(Updatable) The resource entity type.

Identifier string

(Updatable) The OCID of the related resource.

entityType String

(Updatable) The resource entity type.

identifier String

(Updatable) The OCID of the related resource.

entityType string

(Updatable) The resource entity type.

identifier string

(Updatable) The OCID of the related resource.

entity_type str

(Updatable) The resource entity type.

identifier str

(Updatable) The OCID of the related resource.

entityType String

(Updatable) The resource entity type.

identifier String

(Updatable) The OCID of the related resource.

DatabaseToolsConnectionUserPassword

SecretId string

(Updatable) The OCID of the secret containing the user password.

ValueType string

(Updatable) The value type of the user password.

SecretId string

(Updatable) The OCID of the secret containing the user password.

ValueType string

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

secretId string

(Updatable) The OCID of the secret containing the user password.

valueType string

(Updatable) The value type of the user password.

secret_id str

(Updatable) The OCID of the secret containing the user password.

value_type str

(Updatable) The value type of the user password.

secretId String

(Updatable) The OCID of the secret containing the user password.

valueType String

(Updatable) The value type of the user password.

Import

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

 $ pulumi import oci:DatabaseTools/databaseToolsConnection:DatabaseToolsConnection test_database_tools_connection "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.