Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. DatabaseTools
  6. getDatabaseToolsDatabaseApiGatewayConfig
Viewing docs for Oracle Cloud Infrastructure v4.13.0
published on Thursday, May 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.DatabaseTools.getDatabaseToolsDatabaseApiGatewayConfig

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

    This data source provides details about a specific Database Tools Database Api Gateway Config resource in Oracle Cloud Infrastructure Database Tools service.

    Gets details of the specified Database Tools database API gateway config.

    Example Usage

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

const testDatabaseToolsDatabaseApiGatewayConfig = oci.databasetools.getDatabaseToolsDatabaseApiGatewayConfig({
    databaseToolsDatabaseApiGatewayConfigId: testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.id,
});

    import pulumi
import pulumi_oci as oci

test_database_tools_database_api_gateway_config = oci.databasetools.get_database_tools_database_api_gateway_config(database_tools_database_api_gateway_config_id=test_database_tools_database_api_gateway_config_oci_database_tools_database_tools_database_api_gateway_config["id"])

    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.GetDatabaseToolsDatabaseApiGatewayConfig(ctx, &databasetools.GetDatabaseToolsDatabaseApiGatewayConfigArgs{
			DatabaseToolsDatabaseApiGatewayConfigId: testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.Id,
		}, 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 testDatabaseToolsDatabaseApiGatewayConfig = Oci.DatabaseTools.GetDatabaseToolsDatabaseApiGatewayConfig.Invoke(new()
    {
        DatabaseToolsDatabaseApiGatewayConfigId = testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.Id,
    });

});

    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.GetDatabaseToolsDatabaseApiGatewayConfigArgs;
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 testDatabaseToolsDatabaseApiGatewayConfig = DatabaseToolsFunctions.getDatabaseToolsDatabaseApiGatewayConfig(GetDatabaseToolsDatabaseApiGatewayConfigArgs.builder()
            .databaseToolsDatabaseApiGatewayConfigId(testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.id())
            .build());

    }
}

    variables:
  testDatabaseToolsDatabaseApiGatewayConfig:
    fn::invoke:
      function: oci:DatabaseTools:getDatabaseToolsDatabaseApiGatewayConfig
      arguments:
        databaseToolsDatabaseApiGatewayConfigId: ${testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.id}

    pulumi {
  required_providers {
    oci = {
      source = "pulumi/oci"
    }
  }
}

data "oci_databasetools_getdatabasetoolsdatabaseapigatewayconfig" "testDatabaseToolsDatabaseApiGatewayConfig" {
  database_tools_database_api_gateway_config_id = testDatabaseToolsDatabaseApiGatewayConfigOciDatabaseToolsDatabaseToolsDatabaseApiGatewayConfig.id
}

    Using getDatabaseToolsDatabaseApiGatewayConfig

    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 getDatabaseToolsDatabaseApiGatewayConfig(args: GetDatabaseToolsDatabaseApiGatewayConfigArgs, opts?: InvokeOptions): Promise<GetDatabaseToolsDatabaseApiGatewayConfigResult>
function getDatabaseToolsDatabaseApiGatewayConfigOutput(args: GetDatabaseToolsDatabaseApiGatewayConfigOutputArgs, opts?: InvokeOptions): Output<GetDatabaseToolsDatabaseApiGatewayConfigResult>
    def get_database_tools_database_api_gateway_config(database_tools_database_api_gateway_config_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetDatabaseToolsDatabaseApiGatewayConfigResult
def get_database_tools_database_api_gateway_config_output(database_tools_database_api_gateway_config_id: pulumi.Input[Optional[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseToolsDatabaseApiGatewayConfigResult]
    func LookupDatabaseToolsDatabaseApiGatewayConfig(ctx *Context, args *LookupDatabaseToolsDatabaseApiGatewayConfigArgs, opts ...InvokeOption) (*LookupDatabaseToolsDatabaseApiGatewayConfigResult, error)
func LookupDatabaseToolsDatabaseApiGatewayConfigOutput(ctx *Context, args *LookupDatabaseToolsDatabaseApiGatewayConfigOutputArgs, opts ...InvokeOption) LookupDatabaseToolsDatabaseApiGatewayConfigResultOutput

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

    public static class GetDatabaseToolsDatabaseApiGatewayConfig 
{
    public static Task<GetDatabaseToolsDatabaseApiGatewayConfigResult> InvokeAsync(GetDatabaseToolsDatabaseApiGatewayConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseToolsDatabaseApiGatewayConfigResult> Invoke(GetDatabaseToolsDatabaseApiGatewayConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseToolsDatabaseApiGatewayConfigResult> getDatabaseToolsDatabaseApiGatewayConfig(GetDatabaseToolsDatabaseApiGatewayConfigArgs args, InvokeOptions options)
public static Output<GetDatabaseToolsDatabaseApiGatewayConfigResult> getDatabaseToolsDatabaseApiGatewayConfig(GetDatabaseToolsDatabaseApiGatewayConfigArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DatabaseTools/getDatabaseToolsDatabaseApiGatewayConfig:getDatabaseToolsDatabaseApiGatewayConfig
  arguments:
    # arguments dictionary
    data "oci_databasetools_getdatabasetoolsdatabaseapigatewayconfig" "name" {
    # arguments
}

    The following arguments are supported:

    DatabaseToolsDatabaseApiGatewayConfigId string
    The OCID of a Database Tools database API gateway config.
    DatabaseToolsDatabaseApiGatewayConfigId string
    The OCID of a Database Tools database API gateway config.
    database_tools_database_api_gateway_config_id string
    The OCID of a Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId String
    The OCID of a Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId string
    The OCID of a Database Tools database API gateway config.
    database_tools_database_api_gateway_config_id str
    The OCID of a Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId String
    The OCID of a Database Tools database API gateway config.

    getDatabaseToolsDatabaseApiGatewayConfig Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the Database Tools database API gateway config.
    DatabaseToolsDatabaseApiGatewayConfigId string
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the Database Tools database API gateway config.
    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.
    Locks List<GetDatabaseToolsDatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    MetadataSource string
    The RESTful service definition location.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags Dictionary<string, string>
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    Type string
    The Database Tools database API gateway config type.
    CompartmentId string
    The OCID of the compartment containing the Database Tools database API gateway config.
    DatabaseToolsDatabaseApiGatewayConfigId string
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the Database Tools database API gateway config.
    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.
    Locks []GetDatabaseToolsDatabaseApiGatewayConfigLock
    Locks associated with this resource.
    MetadataSource string
    The RESTful service definition location.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags map[string]string
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    Type string
    The Database Tools database API gateway config type.
    compartment_id string
    The OCID of the compartment containing the Database Tools database API gateway config.
    database_tools_database_api_gateway_config_id string
    defined_tags map(string)
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags map(string)
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the Database Tools database API gateway config.
    lifecycle_details 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.
    locks list(object)
    Locks associated with this resource.
    metadata_source string
    The RESTful service definition location.
    state string
    The current state of the Database Tools database API gateway config.
    system_tags map(string)
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type string
    The Database Tools database API gateway config type.
    compartmentId String
    The OCID of the compartment containing the Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId String
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the Database Tools database API gateway config.
    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.
    locks List<GetDatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    metadataSource String
    The RESTful service definition location.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String,String>
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type String
    The Database Tools database API gateway config type.
    compartmentId string
    The OCID of the compartment containing the Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId string
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the Database Tools database API gateway config.
    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.
    locks GetDatabaseToolsDatabaseApiGatewayConfigLock[]
    Locks associated with this resource.
    metadataSource string
    The RESTful service definition location.
    state string
    The current state of the Database Tools database API gateway config.
    systemTags {[key: string]: string}
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type string
    The Database Tools database API gateway config type.
    compartment_id str
    The OCID of the compartment containing the Database Tools database API gateway config.
    database_tools_database_api_gateway_config_id str
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the Database Tools database API gateway config.
    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.
    locks Sequence[GetDatabaseToolsDatabaseApiGatewayConfigLock]
    Locks associated with this resource.
    metadata_source str
    The RESTful service definition location.
    state str
    The current state of the Database Tools database API gateway config.
    system_tags Mapping[str, str]
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type str
    The Database Tools database API gateway config type.
    compartmentId String
    The OCID of the compartment containing the Database Tools database API gateway config.
    databaseToolsDatabaseApiGatewayConfigId String
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the Database Tools database API gateway config.
    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.
    locks List<Property Map>
    Locks associated with this resource.
    metadataSource String
    The RESTful service definition location.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String>
    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 database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type String
    The Database Tools database API gateway config type.

    Supporting Types

    GetDatabaseToolsDatabaseApiGatewayConfigLock

    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    Type string
    The Database Tools database API gateway config type.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    Type string
    The Database Tools database API gateway config type.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    type string
    The Database Tools database API gateway config type.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    type String
    The Database Tools database API gateway config type.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    type string
    The Database Tools database API gateway config type.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    type str
    The Database Tools database API gateway config type.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    type String
    The Database Tools database API gateway config type.

    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.13.0
    published on Thursday, May 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial