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 Auto Api Spec 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 auto API spec resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec = new oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("test_database_tools_database_api_gateway_config_pool_auto_api_spec", {
databaseObjectName: testObject.name,
databaseObjectType: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDatabaseObjectType,
databaseToolsDatabaseApiGatewayConfigId: testConfig.id,
displayName: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDisplayName,
poolKey: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecPoolKey,
type: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecType,
alias: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecAlias,
description: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDescription,
operations: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecOperations,
roles: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRoles,
scope: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecScope,
securitySchemes: databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSecuritySchemes,
});
import pulumi
import pulumi_oci as oci
test_database_tools_database_api_gateway_config_pool_auto_api_spec = oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("test_database_tools_database_api_gateway_config_pool_auto_api_spec",
database_object_name=test_object["name"],
database_object_type=database_tools_database_api_gateway_config_pool_auto_api_spec_database_object_type,
database_tools_database_api_gateway_config_id=test_config["id"],
display_name=database_tools_database_api_gateway_config_pool_auto_api_spec_display_name,
pool_key=database_tools_database_api_gateway_config_pool_auto_api_spec_pool_key,
type=database_tools_database_api_gateway_config_pool_auto_api_spec_type,
alias=database_tools_database_api_gateway_config_pool_auto_api_spec_alias,
description=database_tools_database_api_gateway_config_pool_auto_api_spec_description,
operations=database_tools_database_api_gateway_config_pool_auto_api_spec_operations,
roles=database_tools_database_api_gateway_config_pool_auto_api_spec_roles,
scope=database_tools_database_api_gateway_config_pool_auto_api_spec_scope,
security_schemes=database_tools_database_api_gateway_config_pool_auto_api_spec_security_schemes)
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.NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(ctx, "test_database_tools_database_api_gateway_config_pool_auto_api_spec", &databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs{
DatabaseObjectName: pulumi.Any(testObject.Name),
DatabaseObjectType: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDatabaseObjectType),
DatabaseToolsDatabaseApiGatewayConfigId: pulumi.Any(testConfig.Id),
DisplayName: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDisplayName),
PoolKey: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecPoolKey),
Type: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecType),
Alias: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecAlias),
Description: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDescription),
Operations: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecOperations),
Roles: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRoles),
Scope: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecScope),
SecuritySchemes: pulumi.Any(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSecuritySchemes),
})
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 testDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec = new Oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("test_database_tools_database_api_gateway_config_pool_auto_api_spec", new()
{
DatabaseObjectName = testObject.Name,
DatabaseObjectType = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDatabaseObjectType,
DatabaseToolsDatabaseApiGatewayConfigId = testConfig.Id,
DisplayName = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDisplayName,
PoolKey = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecPoolKey,
Type = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecType,
Alias = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecAlias,
Description = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDescription,
Operations = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecOperations,
Roles = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRoles,
Scope = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecScope,
SecuritySchemes = databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSecuritySchemes,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec;
import com.pulumi.oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs;
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 testDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec = new RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("testDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec", RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs.builder()
.databaseObjectName(testObject.name())
.databaseObjectType(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDatabaseObjectType)
.databaseToolsDatabaseApiGatewayConfigId(testConfig.id())
.displayName(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDisplayName)
.poolKey(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecPoolKey)
.type(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecType)
.alias(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecAlias)
.description(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDescription)
.operations(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecOperations)
.roles(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRoles)
.scope(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecScope)
.securitySchemes(databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSecuritySchemes)
.build());
}
}
resources:
testDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec:
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
name: test_database_tools_database_api_gateway_config_pool_auto_api_spec
properties:
databaseObjectName: ${testObject.name}
databaseObjectType: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDatabaseObjectType}
databaseToolsDatabaseApiGatewayConfigId: ${testConfig.id}
displayName: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDisplayName}
poolKey: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecPoolKey}
type: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecType}
alias: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecAlias}
description: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDescription}
operations: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecOperations}
roles: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRoles}
scope: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecScope}
securitySchemes: ${databaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSecuritySchemes}
Example coming soon!
Create RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(name: string, args: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs, opts?: CustomResourceOptions);@overload
def RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(resource_name: str,
args: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_object_name: Optional[str] = None,
database_object_type: Optional[str] = None,
database_tools_database_api_gateway_config_id: Optional[str] = None,
display_name: Optional[str] = None,
pool_key: Optional[str] = None,
type: Optional[str] = None,
alias: Optional[str] = None,
description: Optional[str] = None,
operations: Optional[Sequence[str]] = None,
roles: Optional[Sequence[str]] = None,
scope: Optional[str] = None,
security_schemes: Optional[Sequence[str]] = None)func NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(ctx *Context, name string, args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs, opts ...ResourceOption) (*RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec, error)public RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(string name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs args, CustomResourceOptions? opts = null)
public RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(String name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs args)
public RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(String name, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs args, CustomResourceOptions options)
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpoolautoapispec" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs
- 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs
- 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs
- 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 runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource = new Oci.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource", new()
{
DatabaseObjectName = "string",
DatabaseObjectType = "string",
DatabaseToolsDatabaseApiGatewayConfigId = "string",
DisplayName = "string",
PoolKey = "string",
Type = "string",
Alias = "string",
Description = "string",
Operations = new[]
{
"string",
},
Roles = new[]
{
"string",
},
Scope = "string",
SecuritySchemes = new[]
{
"string",
},
});
example, err := databasetools.NewRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(ctx, "runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource", &databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs{
DatabaseObjectName: pulumi.String("string"),
DatabaseObjectType: pulumi.String("string"),
DatabaseToolsDatabaseApiGatewayConfigId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
PoolKey: pulumi.String("string"),
Type: pulumi.String("string"),
Alias: pulumi.String("string"),
Description: pulumi.String("string"),
Operations: pulumi.StringArray{
pulumi.String("string"),
},
Roles: pulumi.StringArray{
pulumi.String("string"),
},
Scope: pulumi.String("string"),
SecuritySchemes: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpoolautoapispec" "runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource" {
database_object_name = "string"
database_object_type = "string"
database_tools_database_api_gateway_config_id = "string"
display_name = "string"
pool_key = "string"
type = "string"
alias = "string"
description = "string"
operations = ["string"]
roles = ["string"]
scope = "string"
security_schemes = ["string"]
}
var runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource = new RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource", RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecArgs.builder()
.databaseObjectName("string")
.databaseObjectType("string")
.databaseToolsDatabaseApiGatewayConfigId("string")
.displayName("string")
.poolKey("string")
.type("string")
.alias("string")
.description("string")
.operations("string")
.roles("string")
.scope("string")
.securitySchemes("string")
.build());
runtime_database_tools_database_api_gateway_config_pool_auto_api_spec_resource = oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource",
database_object_name="string",
database_object_type="string",
database_tools_database_api_gateway_config_id="string",
display_name="string",
pool_key="string",
type="string",
alias="string",
description="string",
operations=["string"],
roles=["string"],
scope="string",
security_schemes=["string"])
const runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource = new oci.databasetools.RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec("runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResource", {
databaseObjectName: "string",
databaseObjectType: "string",
databaseToolsDatabaseApiGatewayConfigId: "string",
displayName: "string",
poolKey: "string",
type: "string",
alias: "string",
description: "string",
operations: ["string"],
roles: ["string"],
scope: "string",
securitySchemes: ["string"],
});
type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
properties:
alias: string
databaseObjectName: string
databaseObjectType: string
databaseToolsDatabaseApiGatewayConfigId: string
description: string
displayName: string
operations:
- string
poolKey: string
roles:
- string
scope: string
securitySchemes:
- string
type: string
RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec resource accepts the following input properties:
- Database
Object stringName - (Updatable) The name of the database object.
- Database
Object stringType - (Updatable) The type of the database object.
- 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
Key string - The key of the pool config.
- Type string
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- Alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- Description string
- (Updatable) Description of the autoApiSpec.
- Operations List<string>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- Roles List<string>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- Scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- Security
Schemes List<string> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- Database
Object stringName - (Updatable) The name of the database object.
- Database
Object stringType - (Updatable) The type of the database object.
- 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
Key string - The key of the pool config.
- Type string
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- Alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- Description string
- (Updatable) Description of the autoApiSpec.
- Operations []string
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- Roles []string
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- Scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- Security
Schemes []string - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- database_
object_ stringname - (Updatable) The name of the database object.
- database_
object_ stringtype - (Updatable) The type of the database object.
- 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_
key string - The key of the pool config.
- type string
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- description string
- (Updatable) Description of the autoApiSpec.
- operations list(string)
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- roles list(string)
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security_
schemes list(string) - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- database
Object StringName - (Updatable) The name of the database object.
- database
Object StringType - (Updatable) The type of the database object.
- 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
Key String - The key of the pool config.
- type String
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- alias String
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- description String
- (Updatable) Description of the autoApiSpec.
- operations List<String>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- roles List<String>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope String
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes List<String> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- database
Object stringName - (Updatable) The name of the database object.
- database
Object stringType - (Updatable) The type of the database object.
- 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
Key string - The key of the pool config.
- type string
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- description string
- (Updatable) Description of the autoApiSpec.
- operations string[]
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- roles string[]
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes string[] - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- database_
object_ strname - (Updatable) The name of the database object.
- database_
object_ strtype - (Updatable) The type of the database object.
- 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_
key str - The key of the pool config.
- type str
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- alias str
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- description str
- (Updatable) Description of the autoApiSpec.
- operations Sequence[str]
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- roles Sequence[str]
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope str
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security_
schemes Sequence[str] - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- database
Object StringName - (Updatable) The name of the database object.
- database
Object StringType - (Updatable) The type of the database object.
- 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
Key String - The key of the pool config.
- type String
(Updatable) The type of the Database Tools database API gateway config auto API spec 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
- alias String
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- description String
- (Updatable) Description of the autoApiSpec.
- operations List<String>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- roles List<String>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope String
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes List<String> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
Outputs
All input properties are implicitly available as output properties. Additionally, the RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 an auto API spec sub resource within a given pool.
- 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 RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec Resource
Get an existing RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 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?: RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecState, opts?: CustomResourceOptions): RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alias: Optional[str] = None,
database_object_name: Optional[str] = None,
database_object_type: Optional[str] = None,
database_tools_database_api_gateway_config_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
key: Optional[str] = None,
operations: Optional[Sequence[str]] = None,
pool_key: Optional[str] = None,
roles: Optional[Sequence[str]] = None,
scope: Optional[str] = None,
security_schemes: Optional[Sequence[str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
type: Optional[str] = None) -> RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecfunc GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(ctx *Context, name string, id IDInput, state *RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecState, opts ...ResourceOption) (*RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec, error)public static RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec Get(string name, Input<string> id, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecState? state, CustomResourceOptions? opts = null)public static RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec get(String name, Output<String> id, RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecState state, CustomResourceOptions options)resources: _: type: oci:DatabaseTools:RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec get: id: ${id}import {
to = oci_databasetools_runtimedatabasetoolsdatabaseapigatewayconfigpoolautoapispec.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.
- Alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- Database
Object stringName - (Updatable) The name of the database object.
- Database
Object stringType - (Updatable) The type of the database object.
- Database
Tools stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Description string
- (Updatable) Description of the autoApiSpec.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Key string
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- Operations List<string>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- Pool
Key string - The key of the pool config.
- Roles List<string>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- Scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- Security
Schemes List<string> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- Alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- Database
Object stringName - (Updatable) The name of the database object.
- Database
Object stringType - (Updatable) The type of the database object.
- Database
Tools stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- Description string
- (Updatable) Description of the autoApiSpec.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Key string
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- Operations []string
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- Pool
Key string - The key of the pool config.
- Roles []string
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- Scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- Security
Schemes []string - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- database_
object_ stringname - (Updatable) The name of the database object.
- database_
object_ stringtype - (Updatable) The type of the database object.
- database_
tools_ stringdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- description string
- (Updatable) Description of the autoApiSpec.
- display_
name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- key string
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- operations list(string)
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- pool_
key string - The key of the pool config.
- roles list(string)
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security_
schemes list(string) - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- alias String
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- database
Object StringName - (Updatable) The name of the database object.
- database
Object StringType - (Updatable) The type of the database object.
- database
Tools StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- description String
- (Updatable) Description of the autoApiSpec.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- key String
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- operations List<String>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- pool
Key String - The key of the pool config.
- roles List<String>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope String
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes List<String> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- alias string
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- database
Object stringName - (Updatable) The name of the database object.
- database
Object stringType - (Updatable) The type of the database object.
- database
Tools stringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- description string
- (Updatable) Description of the autoApiSpec.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- key string
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- operations string[]
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- pool
Key string - The key of the pool config.
- roles string[]
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope string
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes string[] - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- alias str
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- database_
object_ strname - (Updatable) The name of the database object.
- database_
object_ strtype - (Updatable) The type of the database object.
- database_
tools_ strdatabase_ api_ gateway_ config_ id - The OCID of a Database Tools database API gateway config.
- description str
- (Updatable) Description of the autoApiSpec.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- key str
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- operations Sequence[str]
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- pool_
key str - The key of the pool config.
- roles Sequence[str]
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope str
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security_
schemes Sequence[str] - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
- alias String
- (Updatable) Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
- database
Object StringName - (Updatable) The name of the database object.
- database
Object StringType - (Updatable) The type of the database object.
- database
Tools StringDatabase Api Gateway Config Id - The OCID of a Database Tools database API gateway config.
- description String
- (Updatable) Description of the autoApiSpec.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- key String
- A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
- operations List<String>
- (Updatable) The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
- pool
Key String - The key of the pool config.
- roles List<String>
- (Updatable) The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
- scope String
- (Updatable) The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
- security
Schemes List<String> - (Updatable) The security schemes that can access this resource. If not specified then the resource is public.
- 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 auto API spec 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
DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs can be imported using the id, e.g.
$ pulumi import oci:DatabaseTools/runtimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec:RuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec test_database_tools_database_api_gateway_config_pool_auto_api_spec "databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}"
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
