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

oci.DatabaseTools.DatabaseToolsDatabaseApiGatewayConfig

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

    This resource provides the Database Tools Database Api Gateway Config resource in Oracle Cloud Infrastructure Database Tools service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/database-tools/latest/DatabaseToolsDatabaseApiGatewayConfig

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/databaseTools

    Creates a new Database Tools database API gateway config.

    Example Usage

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

const testDatabaseToolsDatabaseApiGatewayConfig = new oci.databasetools.DatabaseToolsDatabaseApiGatewayConfig("test_database_tools_database_api_gateway_config", {
    compartmentId: compartmentId,
    displayName: databaseToolsDatabaseApiGatewayConfigDisplayName,
    metadataSource: databaseToolsDatabaseApiGatewayConfigMetadataSource,
    type: databaseToolsDatabaseApiGatewayConfigType,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    locks: [{
        type: databaseToolsDatabaseApiGatewayConfigLocksType,
        message: databaseToolsDatabaseApiGatewayConfigLocksMessage,
        relatedResourceId: testResource.id,
        timeCreated: databaseToolsDatabaseApiGatewayConfigLocksTimeCreated,
    }],
});

    import pulumi
import pulumi_oci as oci

test_database_tools_database_api_gateway_config = oci.databasetools.DatabaseToolsDatabaseApiGatewayConfig("test_database_tools_database_api_gateway_config",
    compartment_id=compartment_id,
    display_name=database_tools_database_api_gateway_config_display_name,
    metadata_source=database_tools_database_api_gateway_config_metadata_source,
    type=database_tools_database_api_gateway_config_type,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    locks=[{
        "type": database_tools_database_api_gateway_config_locks_type,
        "message": database_tools_database_api_gateway_config_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": database_tools_database_api_gateway_config_locks_time_created,
    }])

    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.NewDatabaseToolsDatabaseApiGatewayConfig(ctx, "test_database_tools_database_api_gateway_config", &databasetools.DatabaseToolsDatabaseApiGatewayConfigArgs{
			CompartmentId:  pulumi.Any(compartmentId),
			DisplayName:    pulumi.Any(databaseToolsDatabaseApiGatewayConfigDisplayName),
			MetadataSource: pulumi.Any(databaseToolsDatabaseApiGatewayConfigMetadataSource),
			Type:           pulumi.Any(databaseToolsDatabaseApiGatewayConfigType),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			Locks: databasetools.DatabaseToolsDatabaseApiGatewayConfigLockArray{
				&databasetools.DatabaseToolsDatabaseApiGatewayConfigLockArgs{
					Type:              pulumi.Any(databaseToolsDatabaseApiGatewayConfigLocksType),
					Message:           pulumi.Any(databaseToolsDatabaseApiGatewayConfigLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(databaseToolsDatabaseApiGatewayConfigLocksTimeCreated),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDatabaseToolsDatabaseApiGatewayConfig = new Oci.DatabaseTools.DatabaseToolsDatabaseApiGatewayConfig("test_database_tools_database_api_gateway_config", new()
    {
        CompartmentId = compartmentId,
        DisplayName = databaseToolsDatabaseApiGatewayConfigDisplayName,
        MetadataSource = databaseToolsDatabaseApiGatewayConfigMetadataSource,
        Type = databaseToolsDatabaseApiGatewayConfigType,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        Locks = new[]
        {
            new Oci.DatabaseTools.Inputs.DatabaseToolsDatabaseApiGatewayConfigLockArgs
            {
                Type = databaseToolsDatabaseApiGatewayConfigLocksType,
                Message = databaseToolsDatabaseApiGatewayConfigLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = databaseToolsDatabaseApiGatewayConfigLocksTimeCreated,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.DatabaseToolsDatabaseApiGatewayConfig;
import com.pulumi.oci.DatabaseTools.DatabaseToolsDatabaseApiGatewayConfigArgs;
import com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsDatabaseApiGatewayConfigLockArgs;
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 testDatabaseToolsDatabaseApiGatewayConfig = new DatabaseToolsDatabaseApiGatewayConfig("testDatabaseToolsDatabaseApiGatewayConfig", DatabaseToolsDatabaseApiGatewayConfigArgs.builder()
            .compartmentId(compartmentId)
            .displayName(databaseToolsDatabaseApiGatewayConfigDisplayName)
            .metadataSource(databaseToolsDatabaseApiGatewayConfigMetadataSource)
            .type(databaseToolsDatabaseApiGatewayConfigType)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .locks(DatabaseToolsDatabaseApiGatewayConfigLockArgs.builder()
                .type(databaseToolsDatabaseApiGatewayConfigLocksType)
                .message(databaseToolsDatabaseApiGatewayConfigLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(databaseToolsDatabaseApiGatewayConfigLocksTimeCreated)
                .build())
            .build());

    }
}

    resources:
  testDatabaseToolsDatabaseApiGatewayConfig:
    type: oci:DatabaseTools:DatabaseToolsDatabaseApiGatewayConfig
    name: test_database_tools_database_api_gateway_config
    properties:
      compartmentId: ${compartmentId}
      displayName: ${databaseToolsDatabaseApiGatewayConfigDisplayName}
      metadataSource: ${databaseToolsDatabaseApiGatewayConfigMetadataSource}
      type: ${databaseToolsDatabaseApiGatewayConfigType}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      locks:
        - type: ${databaseToolsDatabaseApiGatewayConfigLocksType}
          message: ${databaseToolsDatabaseApiGatewayConfigLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${databaseToolsDatabaseApiGatewayConfigLocksTimeCreated}

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

resource "oci_databasetools_databasetoolsdatabaseapigatewayconfig" "test_database_tools_database_api_gateway_config" {
  compartment_id  = compartmentId
  display_name    = databaseToolsDatabaseApiGatewayConfigDisplayName
  metadata_source = databaseToolsDatabaseApiGatewayConfigMetadataSource
  type            = databaseToolsDatabaseApiGatewayConfigType
  defined_tags = {
    "foo-namespace.bar-key" = "value"
  }
  freeform_tags = {
    "bar-key" = "value"
  }
  locks {
    type                = databaseToolsDatabaseApiGatewayConfigLocksType
    message             = databaseToolsDatabaseApiGatewayConfigLocksMessage
    related_resource_id = testResource.id
    time_created        = databaseToolsDatabaseApiGatewayConfigLocksTimeCreated
  }
}

    Create DatabaseToolsDatabaseApiGatewayConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatabaseToolsDatabaseApiGatewayConfig(name: string, args: DatabaseToolsDatabaseApiGatewayConfigArgs, opts?: CustomResourceOptions);
    @overload
def DatabaseToolsDatabaseApiGatewayConfig(resource_name: str,
                                          args: DatabaseToolsDatabaseApiGatewayConfigArgs,
                                          opts: Optional[ResourceOptions] = None)

@overload
def DatabaseToolsDatabaseApiGatewayConfig(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          compartment_id: Optional[str] = None,
                                          display_name: Optional[str] = None,
                                          metadata_source: Optional[str] = None,
                                          type: Optional[str] = None,
                                          defined_tags: Optional[Mapping[str, str]] = None,
                                          freeform_tags: Optional[Mapping[str, str]] = None,
                                          locks: Optional[Sequence[DatabaseToolsDatabaseApiGatewayConfigLockArgs]] = None)
    func NewDatabaseToolsDatabaseApiGatewayConfig(ctx *Context, name string, args DatabaseToolsDatabaseApiGatewayConfigArgs, opts ...ResourceOption) (*DatabaseToolsDatabaseApiGatewayConfig, error)
    public DatabaseToolsDatabaseApiGatewayConfig(string name, DatabaseToolsDatabaseApiGatewayConfigArgs args, CustomResourceOptions? opts = null)
    public DatabaseToolsDatabaseApiGatewayConfig(String name, DatabaseToolsDatabaseApiGatewayConfigArgs args)
public DatabaseToolsDatabaseApiGatewayConfig(String name, DatabaseToolsDatabaseApiGatewayConfigArgs args, CustomResourceOptions options)

    type: oci:DatabaseTools:DatabaseToolsDatabaseApiGatewayConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "oci_databasetools_databasetoolsdatabaseapigatewayconfig" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DatabaseToolsDatabaseApiGatewayConfigArgs
    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 DatabaseToolsDatabaseApiGatewayConfigArgs
    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 DatabaseToolsDatabaseApiGatewayConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseToolsDatabaseApiGatewayConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseToolsDatabaseApiGatewayConfigArgs
    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 databaseToolsDatabaseApiGatewayConfigResource = new Oci.DatabaseTools.DatabaseToolsDatabaseApiGatewayConfig("databaseToolsDatabaseApiGatewayConfigResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    MetadataSource = "string",
    Type = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    Locks = new[]
    {
        new Oci.DatabaseTools.Inputs.DatabaseToolsDatabaseApiGatewayConfigLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
});

    example, err := databasetools.NewDatabaseToolsDatabaseApiGatewayConfig(ctx, "databaseToolsDatabaseApiGatewayConfigResource", &databasetools.DatabaseToolsDatabaseApiGatewayConfigArgs{
	CompartmentId:  pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	MetadataSource: pulumi.String("string"),
	Type:           pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Locks: databasetools.DatabaseToolsDatabaseApiGatewayConfigLockArray{
		&databasetools.DatabaseToolsDatabaseApiGatewayConfigLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
})

    resource "oci_databasetools_databasetoolsdatabaseapigatewayconfig" "databaseToolsDatabaseApiGatewayConfigResource" {
  compartment_id  = "string"
  display_name    = "string"
  metadata_source = "string"
  type            = "string"
  defined_tags = {
    "string" = "string"
  }
  freeform_tags = {
    "string" = "string"
  }
  locks {
    type                = "string"
    message             = "string"
    related_resource_id = "string"
    time_created        = "string"
  }
}

    var databaseToolsDatabaseApiGatewayConfigResource = new DatabaseToolsDatabaseApiGatewayConfig("databaseToolsDatabaseApiGatewayConfigResource", DatabaseToolsDatabaseApiGatewayConfigArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .metadataSource("string")
    .type("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .locks(DatabaseToolsDatabaseApiGatewayConfigLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .build());

    database_tools_database_api_gateway_config_resource = oci.databasetools.DatabaseToolsDatabaseApiGatewayConfig("databaseToolsDatabaseApiGatewayConfigResource",
    compartment_id="string",
    display_name="string",
    metadata_source="string",
    type="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }])

    const databaseToolsDatabaseApiGatewayConfigResource = new oci.databasetools.DatabaseToolsDatabaseApiGatewayConfig("databaseToolsDatabaseApiGatewayConfigResource", {
    compartmentId: "string",
    displayName: "string",
    metadataSource: "string",
    type: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
});

    type: oci:DatabaseTools:DatabaseToolsDatabaseApiGatewayConfig
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    metadataSource: string
    type: string

    DatabaseToolsDatabaseApiGatewayConfig 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 DatabaseToolsDatabaseApiGatewayConfig resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    MetadataSource string
    The RESTful service definition location.
    Type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Locks List<DatabaseToolsDatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    MetadataSource string
    The RESTful service definition location.
    Type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Locks []DatabaseToolsDatabaseApiGatewayConfigLockArgs
    Locks associated with this resource.
    compartment_id string
    (Updatable) The OCID of the compartment containing the 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.
    metadata_source string
    The RESTful service definition location.
    type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    defined_tags map(string)
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags map(string)
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks list(object)
    Locks associated with this resource.
    compartmentId String
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    metadataSource String
    The RESTful service definition location.
    type String

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks List<DatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    compartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    metadataSource string
    The RESTful service definition location.
    type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks DatabaseToolsDatabaseApiGatewayConfigLock[]
    Locks associated with this resource.
    compartment_id str
    (Updatable) The OCID of the compartment containing the 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.
    metadata_source str
    The RESTful service definition location.
    type str

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks Sequence[DatabaseToolsDatabaseApiGatewayConfigLockArgs]
    Locks associated with this resource.
    compartmentId String
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    metadataSource String
    The RESTful service definition location.
    type String

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks List<Property Map>
    Locks associated with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycle_details string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    state string
    The current state of the Database Tools database API gateway config.
    system_tags map(string)
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    state string
    The current state of the Database Tools database API gateway config.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    state str
    The current state of the Database Tools database API gateway config.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.

    Look up Existing DatabaseToolsDatabaseApiGatewayConfig Resource

    Get an existing DatabaseToolsDatabaseApiGatewayConfig 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?: DatabaseToolsDatabaseApiGatewayConfigState, opts?: CustomResourceOptions): DatabaseToolsDatabaseApiGatewayConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[DatabaseToolsDatabaseApiGatewayConfigLockArgs]] = None,
        metadata_source: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        type: Optional[str] = None) -> DatabaseToolsDatabaseApiGatewayConfig
    func GetDatabaseToolsDatabaseApiGatewayConfig(ctx *Context, name string, id IDInput, state *DatabaseToolsDatabaseApiGatewayConfigState, opts ...ResourceOption) (*DatabaseToolsDatabaseApiGatewayConfig, error)
    public static DatabaseToolsDatabaseApiGatewayConfig Get(string name, Input<string> id, DatabaseToolsDatabaseApiGatewayConfigState? state, CustomResourceOptions? opts = null)
    public static DatabaseToolsDatabaseApiGatewayConfig get(String name, Output<String> id, DatabaseToolsDatabaseApiGatewayConfigState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseTools:DatabaseToolsDatabaseApiGatewayConfig    get:      id: ${id}
    import {
  to = oci_databasetools_databasetoolsdatabaseapigatewayconfig.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.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    Locks List<DatabaseToolsDatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    MetadataSource string
    The RESTful service definition location.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    Type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    Locks []DatabaseToolsDatabaseApiGatewayConfigLockArgs
    Locks associated with this resource.
    MetadataSource string
    The RESTful service definition location.
    State string
    The current state of the Database Tools database API gateway config.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    Type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    compartment_id string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    defined_tags map(string)
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags map(string)
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    locks list(object)
    Locks associated with this resource.
    metadata_source string
    The RESTful service definition location.
    state string
    The current state of the Database Tools database API gateway config.
    system_tags map(string)
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    locks List<DatabaseApiGatewayConfigLock>
    Locks associated with this resource.
    metadataSource String
    The RESTful service definition location.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type String

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    compartmentId string
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails string
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    locks DatabaseToolsDatabaseApiGatewayConfigLock[]
    Locks associated with this resource.
    metadataSource string
    The RESTful service definition location.
    state string
    The current state of the Database Tools database API gateway config.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type string

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    compartment_id str
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details str
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    locks Sequence[DatabaseToolsDatabaseApiGatewayConfigLockArgs]
    Locks associated with this resource.
    metadata_source str
    The RESTful service definition location.
    state str
    The current state of the Database Tools database API gateway config.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type str

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the Database Tools database API gateway config.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
    locks List<Property Map>
    Locks associated with this resource.
    metadataSource String
    The RESTful service definition location.
    state String
    The current state of the Database Tools database API gateway config.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
    type String

    (Updatable) The Database Tools DP API gateway config type.

    ** 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

    Supporting Types

    DatabaseToolsDatabaseApiGatewayConfigLock, DatabaseToolsDatabaseApiGatewayConfigLockArgs

    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    When the lock was created.
    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    When the lock was created.
    type string
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created string
    When the lock was created.
    type String
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    When the lock was created.
    type string
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    When the lock was created.
    type str
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    When the lock was created.
    type String
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    When the lock was created.

    Import

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

    $ pulumi import oci:DatabaseTools/databaseToolsDatabaseApiGatewayConfig:DatabaseToolsDatabaseApiGatewayConfig test_database_tools_database_api_gateway_config "id"

    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 oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.13.0
    published on Thursday, May 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial