oci.DatabaseTools.getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool

Oracle Cloud Infrastructure v4.11.0, May 15 26

Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.11.0
published on Friday, May 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testDatabaseToolsDatabaseApiGatewayConfigPool = oci.databasetools.getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool({
    databaseToolsDatabaseApiGatewayConfigId: testConfig.id,
    poolKey: databaseToolsDatabaseApiGatewayConfigPoolPoolKey,
});

import pulumi
import pulumi_oci as oci

test_database_tools_database_api_gateway_config_pool = oci.databasetools.get_runtime_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id=test_config["id"],
    pool_key=database_tools_database_api_gateway_config_pool_pool_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.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx, &databasetools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs{
			DatabaseToolsDatabaseApiGatewayConfigId: testConfig.Id,
			PoolKey:                                 databaseToolsDatabaseApiGatewayConfigPoolPoolKey,
		}, 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 testDatabaseToolsDatabaseApiGatewayConfigPool = Oci.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPool.Invoke(new()
    {
        DatabaseToolsDatabaseApiGatewayConfigId = testConfig.Id,
        PoolKey = databaseToolsDatabaseApiGatewayConfigPoolPoolKey,
    });

});

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.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs;
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 testDatabaseToolsDatabaseApiGatewayConfigPool = DatabaseToolsFunctions.getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs.builder()
            .databaseToolsDatabaseApiGatewayConfigId(testConfig.id())
            .poolKey(databaseToolsDatabaseApiGatewayConfigPoolPoolKey)
            .build());

    }
}

variables:
  testDatabaseToolsDatabaseApiGatewayConfigPool:
    fn::invoke:
      function: oci:DatabaseTools:getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool
      arguments:
        databaseToolsDatabaseApiGatewayConfigId: ${testConfig.id}
        poolKey: ${databaseToolsDatabaseApiGatewayConfigPoolPoolKey}

Example coming soon!

Using getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool

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 getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(args: GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs, opts?: InvokeOptions): Promise<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult>
function getRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolOutput(args: GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolOutputArgs, opts?: InvokeOptions): Output<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult>

def get_runtime_database_tools_database_api_gateway_config_pool(database_tools_database_api_gateway_config_id: Optional[str] = None,
                                                                pool_key: Optional[str] = None,
                                                                opts: Optional[InvokeOptions] = None) -> GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult
def get_runtime_database_tools_database_api_gateway_config_pool_output(database_tools_database_api_gateway_config_id: pulumi.Input[Optional[str]] = None,
                                                                pool_key: pulumi.Input[Optional[str]] = None,
                                                                opts: Optional[InvokeOptions] = None) -> Output[GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult]

func LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx *Context, args *LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs, opts ...InvokeOption) (*LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult, error)
func LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolOutput(ctx *Context, args *LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolOutputArgs, opts ...InvokeOption) LookupRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResultOutput

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

public static class GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPool 
{
    public static Task<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult> InvokeAsync(GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult> Invoke(GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult> getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args, InvokeOptions options)
public static Output<GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolResult> getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DatabaseTools/getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool:getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool
  arguments:
    # arguments dictionary

data "oci_databasetools_getruntimedatabasetoolsdatabaseapigatewayconfigpool" "name" {
    # arguments
}

The following arguments are supported:

DatabaseToolsDatabaseApiGatewayConfigId string: The OCID of a Database Tools database API gateway config.
PoolKey string: The key of the pool config.

DatabaseToolsDatabaseApiGatewayConfigId string: The OCID of a Database Tools database API gateway config.
PoolKey string: The key of the pool config.

database_tools_database_api_gateway_config_id string: The OCID of a Database Tools database API gateway config.
pool_key string: The key of the pool config.

databaseToolsDatabaseApiGatewayConfigId String: The OCID of a Database Tools database API gateway config.
poolKey String: The key of the pool config.

databaseToolsDatabaseApiGatewayConfigId string: The OCID of a Database Tools database API gateway config.
poolKey string: The key of the pool config.

database_tools_database_api_gateway_config_id str: The OCID of a Database Tools database API gateway config.
pool_key str: The key of the pool config.

databaseToolsDatabaseApiGatewayConfigId String: The OCID of a Database Tools database API gateway config.
poolKey String: The key of the pool config.

getRuntimeDatabaseToolsDatabaseApiGatewayConfigPool Result

The following output properties are available:

AdvancedProperties Dictionary<string, string>: Advanced pool properties.
DatabaseActionsStatus string: Specifies to enable the Database Actions feature.
DatabaseToolsConnectionId string: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
DatabaseToolsDatabaseApiGatewayConfigId string
DisplayName string: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Id string
InitialPoolSize int: Specifies the initial size for the number of database connections that will be created for the pool.
JwtProfileAudience string: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
JwtProfileIssuer string: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
JwtProfileJwkUrl string: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
JwtProfileRoleClaimName string: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
Key string: A system generated string that uniquely identifies a pool sub resource.
MaxPoolSize int: Specifies the maximum number of database connections allowed for the pool.
MinPoolSize int: Specifies the minimum number of database connections allowed for the pool.
PoolKey string
PoolRouteValue string: The pool route value provided in requests to target this pool.
RestEnabledSqlStatus string: Specifies whether the REST-Enabled SQL service is active.
TimeCreated string: The time the resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the resource was updated. An RFC3339 formatted datetime string.
Type string: The type of the Database Tools database API gateway config pool sub resource.

AdvancedProperties map[string]string: Advanced pool properties.
DatabaseActionsStatus string: Specifies to enable the Database Actions feature.
DatabaseToolsConnectionId string: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
DatabaseToolsDatabaseApiGatewayConfigId string
DisplayName string: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Id string
InitialPoolSize int: Specifies the initial size for the number of database connections that will be created for the pool.
JwtProfileAudience string: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
JwtProfileIssuer string: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
JwtProfileJwkUrl string: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
JwtProfileRoleClaimName string: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
Key string: A system generated string that uniquely identifies a pool sub resource.
MaxPoolSize int: Specifies the maximum number of database connections allowed for the pool.
MinPoolSize int: Specifies the minimum number of database connections allowed for the pool.
PoolKey string
PoolRouteValue string: The pool route value provided in requests to target this pool.
RestEnabledSqlStatus string: Specifies whether the REST-Enabled SQL service is active.
TimeCreated string: The time the resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the resource was updated. An RFC3339 formatted datetime string.
Type string: The type of the Database Tools database API gateway config pool sub resource.

advanced_properties map(string): Advanced pool properties.
database_actions_status string: Specifies to enable the Database Actions feature.
database_tools_connection_id string: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
database_tools_database_api_gateway_config_id string
display_name string: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
id string
initial_pool_size number: Specifies the initial size for the number of database connections that will be created for the pool.
jwt_profile_audience string: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
jwt_profile_issuer string: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
jwt_profile_jwk_url string: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
jwt_profile_role_claim_name string: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
key string: A system generated string that uniquely identifies a pool sub resource.
max_pool_size number: Specifies the maximum number of database connections allowed for the pool.
min_pool_size number: Specifies the minimum number of database connections allowed for the pool.
pool_key string
pool_route_value string: The pool route value provided in requests to target this pool.
rest_enabled_sql_status string: Specifies whether the REST-Enabled SQL service is active.
time_created string: The time the resource was created. An RFC3339 formatted datetime string.
time_updated string: The time the resource was updated. An RFC3339 formatted datetime string.
type string: The type of the Database Tools database API gateway config pool sub resource.

advancedProperties Map<String,String>: Advanced pool properties.
databaseActionsStatus String: Specifies to enable the Database Actions feature.
databaseToolsConnectionId String: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
databaseToolsDatabaseApiGatewayConfigId String
displayName String: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
id String
initialPoolSize Integer: Specifies the initial size for the number of database connections that will be created for the pool.
jwtProfileAudience String: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
jwtProfileIssuer String: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
jwtProfileJwkUrl String: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
jwtProfileRoleClaimName String: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
key String: A system generated string that uniquely identifies a pool sub resource.
maxPoolSize Integer: Specifies the maximum number of database connections allowed for the pool.
minPoolSize Integer: Specifies the minimum number of database connections allowed for the pool.
poolKey String
poolRouteValue String: The pool route value provided in requests to target this pool.
restEnabledSqlStatus String: Specifies whether the REST-Enabled SQL service is active.
timeCreated String: The time the resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the resource was updated. An RFC3339 formatted datetime string.
type String: The type of the Database Tools database API gateway config pool sub resource.

advancedProperties {[key: string]: string}: Advanced pool properties.
databaseActionsStatus string: Specifies to enable the Database Actions feature.
databaseToolsConnectionId string: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
databaseToolsDatabaseApiGatewayConfigId string
displayName string: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
id string
initialPoolSize number: Specifies the initial size for the number of database connections that will be created for the pool.
jwtProfileAudience string: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
jwtProfileIssuer string: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
jwtProfileJwkUrl string: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
jwtProfileRoleClaimName string: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
key string: A system generated string that uniquely identifies a pool sub resource.
maxPoolSize number: Specifies the maximum number of database connections allowed for the pool.
minPoolSize number: Specifies the minimum number of database connections allowed for the pool.
poolKey string
poolRouteValue string: The pool route value provided in requests to target this pool.
restEnabledSqlStatus string: Specifies whether the REST-Enabled SQL service is active.
timeCreated string: The time the resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time the resource was updated. An RFC3339 formatted datetime string.
type string: The type of the Database Tools database API gateway config pool sub resource.

advanced_properties Mapping[str, str]: Advanced pool properties.
database_actions_status str: Specifies to enable the Database Actions feature.
database_tools_connection_id str: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
database_tools_database_api_gateway_config_id str
display_name str: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
id str
initial_pool_size int: Specifies the initial size for the number of database connections that will be created for the pool.
jwt_profile_audience str: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
jwt_profile_issuer str: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
jwt_profile_jwk_url str: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
jwt_profile_role_claim_name str: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
key str: A system generated string that uniquely identifies a pool sub resource.
max_pool_size int: Specifies the maximum number of database connections allowed for the pool.
min_pool_size int: Specifies the minimum number of database connections allowed for the pool.
pool_key str
pool_route_value str: The pool route value provided in requests to target this pool.
rest_enabled_sql_status str: Specifies whether the REST-Enabled SQL service is active.
time_created str: The time the resource was created. An RFC3339 formatted datetime string.
time_updated str: The time the resource was updated. An RFC3339 formatted datetime string.
type str: The type of the Database Tools database API gateway config pool sub resource.

advancedProperties Map<String>: Advanced pool properties.
databaseActionsStatus String: Specifies to enable the Database Actions feature.
databaseToolsConnectionId String: The OCID of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from.
databaseToolsDatabaseApiGatewayConfigId String
displayName String: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
id String
initialPoolSize Number: Specifies the initial size for the number of database connections that will be created for the pool.
jwtProfileAudience String: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
jwtProfileIssuer String: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
jwtProfileJwkUrl String: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
jwtProfileRoleClaimName String: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
key String: A system generated string that uniquely identifies a pool sub resource.
maxPoolSize Number: Specifies the maximum number of database connections allowed for the pool.
minPoolSize Number: Specifies the minimum number of database connections allowed for the pool.
poolKey String
poolRouteValue String: The pool route value provided in requests to target this pool.
restEnabledSqlStatus String: Specifies whether the REST-Enabled SQL service is active.
timeCreated String: The time the resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the resource was updated. An RFC3339 formatted datetime string.
type String: The type of the Database Tools database API gateway config pool sub resource.