published on Friday, May 15, 2026 by Pulumi
published on Friday, May 15, 2026 by Pulumi
This resource provides the Database Tools Database Api Gateway Config Pool resource in Oracle Cloud Infrastructure Database Tools Runtime service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/database_tools_runtime
Create a Database Tools database API gateway config pool resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseToolsDatabaseApiGatewayConfigPool = new oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("test_database_tools_database_api_gateway_config_pool", {
databaseToolsConnectionId: testDatabaseToolsConnection.id,
databaseToolsDatabaseApiGatewayConfigId: testConfig.id,
displayName: databaseToolsDatabaseApiGatewayConfigPoolDisplayName,
poolRouteValue: databaseToolsDatabaseApiGatewayConfigPoolPoolRouteValue,
type: databaseToolsDatabaseApiGatewayConfigPoolType,
advancedProperties: databaseToolsDatabaseApiGatewayConfigPoolAdvancedProperties,
databaseActionsStatus: databaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatus,
initialPoolSize: Number(databaseToolsDatabaseApiGatewayConfigPoolInitialPoolSize),
jwtProfileAudience: databaseToolsDatabaseApiGatewayConfigPoolJwtProfileAudience,
jwtProfileIssuer: databaseToolsDatabaseApiGatewayConfigPoolJwtProfileIssuer,
jwtProfileJwkUrl: databaseToolsDatabaseApiGatewayConfigPoolJwtProfileJwkUrl,
jwtProfileRoleClaimName: databaseToolsDatabaseApiGatewayConfigPoolJwtProfileRoleClaimName,
maxPoolSize: Number(databaseToolsDatabaseApiGatewayConfigPoolMaxPoolSize),
minPoolSize: Number(databaseToolsDatabaseApiGatewayConfigPoolMinPoolSize),
restEnabledSqlStatus: databaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatus,
});
import pulumi
import pulumi_oci as oci
test_database_tools_database_api_gateway_config_pool = oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("test_database_tools_database_api_gateway_config_pool",
database_tools_connection_id=test_database_tools_connection["id"],
database_tools_database_api_gateway_config_id=test_config["id"],
display_name=database_tools_database_api_gateway_config_pool_display_name,
pool_route_value=database_tools_database_api_gateway_config_pool_pool_route_value,
type=database_tools_database_api_gateway_config_pool_type,
advanced_properties=database_tools_database_api_gateway_config_pool_advanced_properties,
database_actions_status=database_tools_database_api_gateway_config_pool_database_actions_status,
initial_pool_size=int(database_tools_database_api_gateway_config_pool_initial_pool_size),
jwt_profile_audience=database_tools_database_api_gateway_config_pool_jwt_profile_audience,
jwt_profile_issuer=database_tools_database_api_gateway_config_pool_jwt_profile_issuer,
jwt_profile_jwk_url=database_tools_database_api_gateway_config_pool_jwt_profile_jwk_url,
jwt_profile_role_claim_name=database_tools_database_api_gateway_config_pool_jwt_profile_role_claim_name,
max_pool_size=int(database_tools_database_api_gateway_config_pool_max_pool_size),
min_pool_size=int(database_tools_database_api_gateway_config_pool_min_pool_size),
rest_enabled_sql_status=database_tools_database_api_gateway_config_pool_rest_enabled_sql_status)
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.NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx, "test_database_tools_database_api_gateway_config_pool", &databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs{
DatabaseToolsConnectionId: pulumi.Any(testDatabaseToolsConnection.Id),
DatabaseToolsDatabaseApiGatewayConfigId: pulumi.Any(testConfig.Id),
DisplayName: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolDisplayName),
PoolRouteValue: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolPoolRouteValue),
Type: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolType),
AdvancedProperties: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAdvancedProperties),
DatabaseActionsStatus: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatus),
InitialPoolSize: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolInitialPoolSize),
JwtProfileAudience: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileAudience),
JwtProfileIssuer: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileIssuer),
JwtProfileJwkUrl: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileJwkUrl),
JwtProfileRoleClaimName: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileRoleClaimName),
MaxPoolSize: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolMaxPoolSize),
MinPoolSize: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolMinPoolSize),
RestEnabledSqlStatus: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatus),
})
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 = new Oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("test_database_tools_database_api_gateway_config_pool", new()
{
DatabaseToolsConnectionId = testDatabaseToolsConnection.Id,
DatabaseToolsDatabaseApiGatewayConfigId = testConfig.Id,
DisplayName = databaseToolsDatabaseApiGatewayConfigPoolDisplayName,
PoolRouteValue = databaseToolsDatabaseApiGatewayConfigPoolPoolRouteValue,
Type = databaseToolsDatabaseApiGatewayConfigPoolType,
AdvancedProperties = databaseToolsDatabaseApiGatewayConfigPoolAdvancedProperties,
DatabaseActionsStatus = databaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatus,
InitialPoolSize = databaseToolsDatabaseApiGatewayConfigPoolInitialPoolSize,
JwtProfileAudience = databaseToolsDatabaseApiGatewayConfigPoolJwtProfileAudience,
JwtProfileIssuer = databaseToolsDatabaseApiGatewayConfigPoolJwtProfileIssuer,
JwtProfileJwkUrl = databaseToolsDatabaseApiGatewayConfigPoolJwtProfileJwkUrl,
JwtProfileRoleClaimName = databaseToolsDatabaseApiGatewayConfigPoolJwtProfileRoleClaimName,
MaxPoolSize = databaseToolsDatabaseApiGatewayConfigPoolMaxPoolSize,
MinPoolSize = databaseToolsDatabaseApiGatewayConfigPoolMinPoolSize,
RestEnabledSqlStatus = databaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatus,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDatabaseToolsDatabaseApiGatewayConfigPool = new RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("testDatabaseToolsDatabaseApiGatewayConfigPool", RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs.builder()
.databaseToolsConnectionId(testDatabaseToolsConnection.id())
.databaseToolsDatabaseApiGatewayConfigId(testConfig.id())
.displayName(databaseToolsDatabaseApiGatewayConfigPoolDisplayName)
.poolRouteValue(databaseToolsDatabaseApiGatewayConfigPoolPoolRouteValue)
.type(databaseToolsDatabaseApiGatewayConfigPoolType)
.advancedProperties(databaseToolsDatabaseApiGatewayConfigPoolAdvancedProperties)
.databaseActionsStatus(databaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatus)
.initialPoolSize(databaseToolsDatabaseApiGatewayConfigPoolInitialPoolSize)
.jwtProfileAudience(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileAudience)
.jwtProfileIssuer(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileIssuer)
.jwtProfileJwkUrl(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileJwkUrl)
.jwtProfileRoleClaimName(databaseToolsDatabaseApiGatewayConfigPoolJwtProfileRoleClaimName)
.maxPoolSize(databaseToolsDatabaseApiGatewayConfigPoolMaxPoolSize)
.minPoolSize(databaseToolsDatabaseApiGatewayConfigPoolMinPoolSize)
.restEnabledSqlStatus(databaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatus)
.build());
}
}
resources:
testDatabaseToolsDatabaseApiGatewayConfigPool:
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPool
name: test_database_tools_database_api_gateway_config_pool
properties:
databaseToolsConnectionId: ${testDatabaseToolsConnection.id}
databaseToolsDatabaseApiGatewayConfigId: ${testConfig.id}
displayName: ${databaseToolsDatabaseApiGatewayConfigPoolDisplayName}
poolRouteValue: ${databaseToolsDatabaseApiGatewayConfigPoolPoolRouteValue}
type: ${databaseToolsDatabaseApiGatewayConfigPoolType}
advancedProperties: ${databaseToolsDatabaseApiGatewayConfigPoolAdvancedProperties}
databaseActionsStatus: ${databaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatus}
initialPoolSize: ${databaseToolsDatabaseApiGatewayConfigPoolInitialPoolSize}
jwtProfileAudience: ${databaseToolsDatabaseApiGatewayConfigPoolJwtProfileAudience}
jwtProfileIssuer: ${databaseToolsDatabaseApiGatewayConfigPoolJwtProfileIssuer}
jwtProfileJwkUrl: ${databaseToolsDatabaseApiGatewayConfigPoolJwtProfileJwkUrl}
jwtProfileRoleClaimName: ${databaseToolsDatabaseApiGatewayConfigPoolJwtProfileRoleClaimName}
maxPoolSize: ${databaseToolsDatabaseApiGatewayConfigPoolMaxPoolSize}
minPoolSize: ${databaseToolsDatabaseApiGatewayConfigPoolMinPoolSize}
restEnabledSqlStatus: ${databaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatus}
Example coming soon!
Create RuntimeDatabaseToolsDatabaseApiGatewayConfigPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(name: string, args: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs, opts?: CustomResourceOptions);@overload
def RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(resource_name: str,
args: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
pool_route_value: Optional[str] = None,
type: Optional[str] = None,
database_tools_connection_id: Optional[str] = None,
database_tools_database_api_gateway_config_id: Optional[str] = None,
display_name: Optional[str] = None,
jwt_profile_audience: Optional[str] = None,
advanced_properties: Optional[Mapping[str, str]] = None,
jwt_profile_issuer: Optional[str] = None,
jwt_profile_jwk_url: Optional[str] = None,
jwt_profile_role_claim_name: Optional[str] = None,
max_pool_size: Optional[int] = None,
min_pool_size: Optional[int] = None,
initial_pool_size: Optional[int] = None,
rest_enabled_sql_status: Optional[str] = None,
database_actions_status: Optional[str] = None)func NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx *Context, name string, args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs, opts ...ResourceOption) (*RuntimeDatabaseToolsDatabaseApiGatewayConfigPool, error)public RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(string name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args, CustomResourceOptions? opts = null)
public RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(String name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args)
public RuntimeDatabaseToolsDatabaseApiGatewayConfigPool(String name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs args, CustomResourceOptions options)
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpool" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs
- 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs
- 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource = new Oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource", new()
{
PoolRouteValue = "string",
Type = "string",
DatabaseToolsConnectionId = "string",
DatabaseToolsDatabaseApiGatewayConfigId = "string",
DisplayName = "string",
JwtProfileAudience = "string",
AdvancedProperties =
{
{ "string", "string" },
},
JwtProfileIssuer = "string",
JwtProfileJwkUrl = "string",
JwtProfileRoleClaimName = "string",
MaxPoolSize = 0,
MinPoolSize = 0,
InitialPoolSize = 0,
RestEnabledSqlStatus = "string",
DatabaseActionsStatus = "string",
});
example, err := databasetools.NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx, "runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource", &databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs{
PoolRouteValue: pulumi.String("string"),
Type: pulumi.String("string"),
DatabaseToolsConnectionId: pulumi.String("string"),
DatabaseToolsDatabaseApiGatewayConfigId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
JwtProfileAudience: pulumi.String("string"),
AdvancedProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
JwtProfileIssuer: pulumi.String("string"),
JwtProfileJwkUrl: pulumi.String("string"),
JwtProfileRoleClaimName: pulumi.String("string"),
MaxPoolSize: pulumi.Int(0),
MinPoolSize: pulumi.Int(0),
InitialPoolSize: pulumi.Int(0),
RestEnabledSqlStatus: pulumi.String("string"),
DatabaseActionsStatus: pulumi.String("string"),
})
resource "oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpool" "runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource" {
pool_route_value = "string"
type = "string"
database_tools_connection_id = "string"
database_tools_database_api_gateway_config_id = "string"
display_name = "string"
jwt_profile_audience = "string"
advanced_properties = {
"string" = "string"
}
jwt_profile_issuer = "string"
jwt_profile_jwk_url = "string"
jwt_profile_role_claim_name = "string"
max_pool_size = 0
min_pool_size = 0
initial_pool_size = 0
rest_enabled_sql_status = "string"
database_actions_status = "string"
}
var runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource = new RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource", RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolArgs.builder()
.poolRouteValue("string")
.type("string")
.databaseToolsConnectionId("string")
.databaseToolsDatabaseApiGatewayConfigId("string")
.displayName("string")
.jwtProfileAudience("string")
.advancedProperties(Map.of("string", "string"))
.jwtProfileIssuer("string")
.jwtProfileJwkUrl("string")
.jwtProfileRoleClaimName("string")
.maxPoolSize(0)
.minPoolSize(0)
.initialPoolSize(0)
.restEnabledSqlStatus("string")
.databaseActionsStatus("string")
.build());
runtime_database_tools_database_api_gateway_config_pool_resource = oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource",
pool_route_value="string",
type="string",
database_tools_connection_id="string",
database_tools_database_api_gateway_config_id="string",
display_name="string",
jwt_profile_audience="string",
advanced_properties={
"string": "string",
},
jwt_profile_issuer="string",
jwt_profile_jwk_url="string",
jwt_profile_role_claim_name="string",
max_pool_size=0,
min_pool_size=0,
initial_pool_size=0,
rest_enabled_sql_status="string",
database_actions_status="string")
const runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource = new oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPool("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolResource", {
poolRouteValue: "string",
type: "string",
databaseToolsConnectionId: "string",
databaseToolsDatabaseApiGatewayConfigId: "string",
displayName: "string",
jwtProfileAudience: "string",
advancedProperties: {
string: "string",
},
jwtProfileIssuer: "string",
jwtProfileJwkUrl: "string",
jwtProfileRoleClaimName: "string",
maxPoolSize: 0,
minPoolSize: 0,
initialPoolSize: 0,
restEnabledSqlStatus: "string",
databaseActionsStatus: "string",
});
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPool
properties:
advancedProperties:
string: string
databaseActionsStatus: string
databaseToolsConnectionId: string
databaseToolsDatabaseApiGatewayConfigId: string
displayName: string
initialPoolSize: 0
jwtProfileAudience: string
jwtProfileIssuer: string
jwtProfileJwkUrl: string
jwtProfileRoleClaimName: string
maxPoolSize: 0
minPoolSize: 0
poolRouteValue: string
restEnabledSqlStatus: string
type: string
RuntimeDatabaseToolsDatabaseApiGatewayConfigPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RuntimeDatabaseToolsDatabaseApiGatewayConfigPool resource accepts the following input properties:
- Database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- Type string
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Advanced
Properties Dictionary<string, string> - (Updatable) Advanced pool properties.
- Database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- Initial
Pool intSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- Jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- Jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- Jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- Jwt
Profile stringRole Claim Name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- Max
Pool intSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- Min
Pool intSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- Rest
Enabled stringSql Status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- Database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- Type string
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Advanced
Properties map[string]string - (Updatable) Advanced pool properties.
- Database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- Initial
Pool intSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- Jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- Jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- Jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- Jwt
Profile stringRole Claim Name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- Max
Pool intSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- Min
Pool intSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- Rest
Enabled stringSql Status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- database_
tools_ stringconnection_ id - (Updatable) 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_ stringdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- display_
name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- pool_
route_ stringvalue - (Updatable) The pool route value provided in requests to target this pool.
- type string
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced_
properties map(string) - (Updatable) Advanced pool properties.
- database_
actions_ stringstatus - (Updatable) Specifies to enable the Database Actions feature.
- initial_
pool_ numbersize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt_
profile_ stringaudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt_
profile_ stringissuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt_
profile_ stringjwk_ url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt_
profile_ stringrole_ claim_ name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- max_
pool_ numbersize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min_
pool_ numbersize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- rest_
enabled_ stringsql_ status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- database
Tools StringConnection Id - (Updatable) 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 StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- pool
Route StringValue - (Updatable) The pool route value provided in requests to target this pool.
- type String
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties Map<String,String> - (Updatable) Advanced pool properties.
- database
Actions StringStatus - (Updatable) Specifies to enable the Database Actions feature.
- initial
Pool IntegerSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile StringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile StringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile StringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile StringRole Claim Name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- max
Pool IntegerSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool IntegerSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- rest
Enabled StringSql Status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- type string
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties {[key: string]: string} - (Updatable) Advanced pool properties.
- database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- initial
Pool numberSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile stringRole Claim Name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- max
Pool numberSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool numberSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- rest
Enabled stringSql Status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- database_
tools_ strconnection_ id - (Updatable) 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_ strdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- pool_
route_ strvalue - (Updatable) The pool route value provided in requests to target this pool.
- type str
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced_
properties Mapping[str, str] - (Updatable) Advanced pool properties.
- database_
actions_ strstatus - (Updatable) Specifies to enable the Database Actions feature.
- initial_
pool_ intsize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt_
profile_ straudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt_
profile_ strissuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt_
profile_ strjwk_ url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt_
profile_ strrole_ claim_ name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- max_
pool_ intsize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min_
pool_ intsize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- rest_
enabled_ strsql_ status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
- database
Tools StringConnection Id - (Updatable) 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 StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- pool
Route StringValue - (Updatable) The pool route value provided in requests to target this pool.
- type String
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties Map<String> - (Updatable) Advanced pool properties.
- database
Actions StringStatus - (Updatable) Specifies to enable the Database Actions feature.
- initial
Pool NumberSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile StringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile StringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile StringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile StringRole Claim Name - (Updatable) Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- max
Pool NumberSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool NumberSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- rest
Enabled StringSql Status - (Updatable) Specifies whether the REST-Enabled SQL service is active.
Outputs
All input properties are implicitly available as output properties. Additionally, the RuntimeDatabaseToolsDatabaseApiGatewayConfigPool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- key string
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- key string
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- key str
- A system generated string that uniquely identifies a pool sub resource.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- A system generated string that uniquely identifies a pool sub resource.
- 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.
Look up Existing RuntimeDatabaseToolsDatabaseApiGatewayConfigPool Resource
Get an existing RuntimeDatabaseToolsDatabaseApiGatewayConfigPool 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?: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolState, opts?: CustomResourceOptions): RuntimeDatabaseToolsDatabaseApiGatewayConfigPool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_properties: Optional[Mapping[str, str]] = None,
database_actions_status: Optional[str] = None,
database_tools_connection_id: Optional[str] = None,
database_tools_database_api_gateway_config_id: Optional[str] = None,
display_name: Optional[str] = None,
initial_pool_size: Optional[int] = None,
jwt_profile_audience: Optional[str] = None,
jwt_profile_issuer: Optional[str] = None,
jwt_profile_jwk_url: Optional[str] = None,
jwt_profile_role_claim_name: Optional[str] = None,
key: Optional[str] = None,
max_pool_size: Optional[int] = None,
min_pool_size: Optional[int] = None,
pool_route_value: Optional[str] = None,
rest_enabled_sql_status: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
type: Optional[str] = None) -> RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolfunc GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPool(ctx *Context, name string, id IDInput, state *RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolState, opts ...ResourceOption) (*RuntimeDatabaseToolsDatabaseApiGatewayConfigPool, error)public static RuntimeDatabaseToolsDatabaseApiGatewayConfigPool Get(string name, Input<string> id, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolState? state, CustomResourceOptions? opts = null)public static RuntimeDatabaseToolsDatabaseApiGatewayConfigPool get(String name, Output<String> id, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolState state, CustomResourceOptions options)resources: _: type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPool get: id: ${id}import {
to = oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpool.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Advanced
Properties Dictionary<string, string> - (Updatable) Advanced pool properties.
- Database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- Database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Initial
Pool intSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- Jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- Jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- Jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- Jwt
Profile stringRole Claim Name - (Updatable) 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 intSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- Min
Pool intSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- Pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- Rest
Enabled stringSql Status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Advanced
Properties map[string]string - (Updatable) Advanced pool properties.
- Database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- Database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Initial
Pool intSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- Jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- Jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- Jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- Jwt
Profile stringRole Claim Name - (Updatable) 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 intSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- Min
Pool intSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- Pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- Rest
Enabled stringSql Status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced_
properties map(string) - (Updatable) Advanced pool properties.
- database_
actions_ stringstatus - (Updatable) Specifies to enable the Database Actions feature.
- database_
tools_ stringconnection_ id - (Updatable) 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_ stringdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- display_
name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- initial_
pool_ numbersize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt_
profile_ stringaudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt_
profile_ stringissuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt_
profile_ stringjwk_ url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt_
profile_ stringrole_ claim_ name - (Updatable) 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_ numbersize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min_
pool_ numbersize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- pool_
route_ stringvalue - (Updatable) The pool route value provided in requests to target this pool.
- rest_
enabled_ stringsql_ status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties Map<String,String> - (Updatable) Advanced pool properties.
- database
Actions StringStatus - (Updatable) Specifies to enable the Database Actions feature.
- database
Tools StringConnection Id - (Updatable) 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 StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- initial
Pool IntegerSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile StringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile StringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile StringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile StringRole Claim Name - (Updatable) 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 IntegerSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool IntegerSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- pool
Route StringValue - (Updatable) The pool route value provided in requests to target this pool.
- rest
Enabled StringSql Status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties {[key: string]: string} - (Updatable) Advanced pool properties.
- database
Actions stringStatus - (Updatable) Specifies to enable the Database Actions feature.
- database
Tools stringConnection Id - (Updatable) 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 stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- initial
Pool numberSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile stringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile stringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile stringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile stringRole Claim Name - (Updatable) 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 numberSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool numberSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- pool
Route stringValue - (Updatable) The pool route value provided in requests to target this pool.
- rest
Enabled stringSql Status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced_
properties Mapping[str, str] - (Updatable) Advanced pool properties.
- database_
actions_ strstatus - (Updatable) Specifies to enable the Database Actions feature.
- database_
tools_ strconnection_ id - (Updatable) 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_ strdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- initial_
pool_ intsize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt_
profile_ straudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt_
profile_ strissuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt_
profile_ strjwk_ url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt_
profile_ strrole_ claim_ name - (Updatable) 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_ intsize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min_
pool_ intsize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- pool_
route_ strvalue - (Updatable) The pool route value provided in requests to target this pool.
- rest_
enabled_ strsql_ status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- advanced
Properties Map<String> - (Updatable) Advanced pool properties.
- database
Actions StringStatus - (Updatable) Specifies to enable the Database Actions feature.
- database
Tools StringConnection Id - (Updatable) 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 StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- initial
Pool NumberSize - (Updatable) Specifies the initial size for the number of database connections that will be created for the pool.
- jwt
Profile StringAudience - (Updatable) Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- jwt
Profile StringIssuer - (Updatable) Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- jwt
Profile StringJwk Url - (Updatable) Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- jwt
Profile StringRole Claim Name - (Updatable) 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 NumberSize - (Updatable) Specifies the maximum number of database connections allowed for the pool.
- min
Pool NumberSize - (Updatable) Specifies the minimum number of database connections allowed for the pool.
- pool
Route StringValue - (Updatable) The pool route value provided in requests to target this pool.
- rest
Enabled StringSql Status - (Updatable) 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
(Updatable) The type of the Database Tools database API gateway config pool sub resource.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Import
DatabaseToolsDatabaseApiGatewayConfigPools can be imported using the id, e.g.
$ pulumi import oci:DatabaseTools/runtimeDatabaseToolsDatabaseApiGatewayConfigPool:RuntimeDatabaseToolsDatabaseApiGatewayConfigPool test_database_tools_database_api_gateway_config_pool "databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
published on Friday, May 15, 2026 by Pulumi
