oci.DatabaseTools.DatabaseToolsPrivateEndpoint
Explore with Pulumi AI
This resource provides the Database Tools Private Endpoint resource in Oracle Cloud Infrastructure Database Tools service.
Creates a new Database Tools private endpoint.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDatabaseToolsPrivateEndpoint = new Oci.DatabaseTools.DatabaseToolsPrivateEndpoint("testDatabaseToolsPrivateEndpoint", new()
{
CompartmentId = @var.Compartment_id,
DisplayName = @var.Database_tools_private_endpoint_display_name,
EndpointServiceId = oci_core_service.Test_service.Id,
SubnetId = oci_core_subnet.Test_subnet.Id,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
Description = @var.Database_tools_private_endpoint_description,
FreeformTags =
{
{ "bar-key", "value" },
},
NsgIds = @var.Database_tools_private_endpoint_nsg_ids,
PrivateEndpointIp = @var.Database_tools_private_endpoint_private_endpoint_ip,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/DatabaseTools"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DatabaseTools.NewDatabaseToolsPrivateEndpoint(ctx, "testDatabaseToolsPrivateEndpoint", &DatabaseTools.DatabaseToolsPrivateEndpointArgs{
CompartmentId: pulumi.Any(_var.Compartment_id),
DisplayName: pulumi.Any(_var.Database_tools_private_endpoint_display_name),
EndpointServiceId: pulumi.Any(oci_core_service.Test_service.Id),
SubnetId: pulumi.Any(oci_core_subnet.Test_subnet.Id),
DefinedTags: pulumi.Map{
"foo-namespace.bar-key": pulumi.Any("value"),
},
Description: pulumi.Any(_var.Database_tools_private_endpoint_description),
FreeformTags: pulumi.Map{
"bar-key": pulumi.Any("value"),
},
NsgIds: pulumi.Any(_var.Database_tools_private_endpoint_nsg_ids),
PrivateEndpointIp: pulumi.Any(_var.Database_tools_private_endpoint_private_endpoint_ip),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.DatabaseToolsPrivateEndpoint;
import com.pulumi.oci.DatabaseTools.DatabaseToolsPrivateEndpointArgs;
import java.util.List;
import java.util.ArrayList;
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 testDatabaseToolsPrivateEndpoint = new DatabaseToolsPrivateEndpoint("testDatabaseToolsPrivateEndpoint", DatabaseToolsPrivateEndpointArgs.builder()
.compartmentId(var_.compartment_id())
.displayName(var_.database_tools_private_endpoint_display_name())
.endpointServiceId(oci_core_service.test_service().id())
.subnetId(oci_core_subnet.test_subnet().id())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.description(var_.database_tools_private_endpoint_description())
.freeformTags(Map.of("bar-key", "value"))
.nsgIds(var_.database_tools_private_endpoint_nsg_ids())
.privateEndpointIp(var_.database_tools_private_endpoint_private_endpoint_ip())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_database_tools_private_endpoint = oci.database_tools.DatabaseToolsPrivateEndpoint("testDatabaseToolsPrivateEndpoint",
compartment_id=var["compartment_id"],
display_name=var["database_tools_private_endpoint_display_name"],
endpoint_service_id=oci_core_service["test_service"]["id"],
subnet_id=oci_core_subnet["test_subnet"]["id"],
defined_tags={
"foo-namespace.bar-key": "value",
},
description=var["database_tools_private_endpoint_description"],
freeform_tags={
"bar-key": "value",
},
nsg_ids=var["database_tools_private_endpoint_nsg_ids"],
private_endpoint_ip=var["database_tools_private_endpoint_private_endpoint_ip"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseToolsPrivateEndpoint = new oci.databasetools.DatabaseToolsPrivateEndpoint("testDatabaseToolsPrivateEndpoint", {
compartmentId: _var.compartment_id,
displayName: _var.database_tools_private_endpoint_display_name,
endpointServiceId: oci_core_service.test_service.id,
subnetId: oci_core_subnet.test_subnet.id,
definedTags: {
"foo-namespace.bar-key": "value",
},
description: _var.database_tools_private_endpoint_description,
freeformTags: {
"bar-key": "value",
},
nsgIds: _var.database_tools_private_endpoint_nsg_ids,
privateEndpointIp: _var.database_tools_private_endpoint_private_endpoint_ip,
});
resources:
testDatabaseToolsPrivateEndpoint:
type: oci:DatabaseTools:DatabaseToolsPrivateEndpoint
properties:
#Required
compartmentId: ${var.compartment_id}
displayName: ${var.database_tools_private_endpoint_display_name}
endpointServiceId: ${oci_core_service.test_service.id}
subnetId: ${oci_core_subnet.test_subnet.id}
#Optional
definedTags:
foo-namespace.bar-key: value
description: ${var.database_tools_private_endpoint_description}
freeformTags:
bar-key: value
nsgIds: ${var.database_tools_private_endpoint_nsg_ids}
privateEndpointIp: ${var.database_tools_private_endpoint_private_endpoint_ip}
Create DatabaseToolsPrivateEndpoint Resource
new DatabaseToolsPrivateEndpoint(name: string, args: DatabaseToolsPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def DatabaseToolsPrivateEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
endpoint_service_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
nsg_ids: Optional[Sequence[str]] = None,
private_endpoint_ip: Optional[str] = None,
subnet_id: Optional[str] = None)
@overload
def DatabaseToolsPrivateEndpoint(resource_name: str,
args: DatabaseToolsPrivateEndpointArgs,
opts: Optional[ResourceOptions] = None)
func NewDatabaseToolsPrivateEndpoint(ctx *Context, name string, args DatabaseToolsPrivateEndpointArgs, opts ...ResourceOption) (*DatabaseToolsPrivateEndpoint, error)
public DatabaseToolsPrivateEndpoint(string name, DatabaseToolsPrivateEndpointArgs args, CustomResourceOptions? opts = null)
public DatabaseToolsPrivateEndpoint(String name, DatabaseToolsPrivateEndpointArgs args)
public DatabaseToolsPrivateEndpoint(String name, DatabaseToolsPrivateEndpointArgs args, CustomResourceOptions options)
type: oci:DatabaseTools:DatabaseToolsPrivateEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseToolsPrivateEndpointArgs
- 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 DatabaseToolsPrivateEndpointArgs
- 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 DatabaseToolsPrivateEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseToolsPrivateEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseToolsPrivateEndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DatabaseToolsPrivateEndpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DatabaseToolsPrivateEndpoint resource accepts the following input properties:
- Compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- Subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) A description of the Database Tools private endpoint.
- Dictionary<string, object>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Nsg
Ids List<string> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- Compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- Subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) A description of the Database Tools private endpoint.
- map[string]interface{}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Nsg
Ids []string (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- compartment
Id String (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Service StringId The OCID of the
DatabaseToolsEndpointService
.- subnet
Id String The OCID of the subnet that the private endpoint belongs to.
** 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
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) A description of the Database Tools private endpoint.
- Map<String,Object>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- nsg
Ids List<String> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp The private IP address that represents the access point for the associated endpoint service.
- compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
(Updatable) A description of the Database Tools private endpoint.
- {[key: string]: any}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- nsg
Ids string[] (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- compartment_
id str (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- display_
name str (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint_
service_ strid The OCID of the
DatabaseToolsEndpointService
.- subnet_
id str The OCID of the subnet that the private endpoint belongs to.
** 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
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
(Updatable) A description of the Database Tools private endpoint.
- Mapping[str, Any]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- nsg_
ids Sequence[str] (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private_
endpoint_ strip The private IP address that represents the access point for the associated endpoint service.
- compartment
Id String (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Service StringId The OCID of the
DatabaseToolsEndpointService
.- subnet
Id String The OCID of the subnet that the private endpoint belongs to.
** 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
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) A description of the Database Tools private endpoint.
- Map<Any>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- nsg
Ids List<String> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp The private IP address that represents the access point for the associated endpoint service.
Outputs
All input properties are implicitly available as output properties. Additionally, the DatabaseToolsPrivateEndpoint resource produces the following output properties:
- Additional
Fqdns List<string> A list of additional FQDNs that can be also be used for the private endpoint.
- Endpoint
Fqdn string Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- Private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- Reverse
Connection List<DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration> Reverse connection configuration details of the private endpoint.
- State string
The current state of the Database Tools private endpoint.
- Dictionary<string, object>
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 private endpoint was created. An RFC3339 formatted datetime string
- Time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- Vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- Additional
Fqdns []string A list of additional FQDNs that can be also be used for the private endpoint.
- Endpoint
Fqdn string Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- Private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- Reverse
Connection []DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration Reverse connection configuration details of the private endpoint.
- State string
The current state of the Database Tools private endpoint.
- map[string]interface{}
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 private endpoint was created. An RFC3339 formatted datetime string
- Time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- Vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns List<String> A list of additional FQDNs that can be also be used for the private endpoint.
- endpoint
Fqdn String Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- private
Endpoint StringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection List<PrivateConfigurations Endpoint Reverse Connection Configuration> Reverse connection configuration details of the private endpoint.
- state String
The current state of the Database Tools private endpoint.
- Map<String,Object>
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated String The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id String The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns string[] A list of additional FQDNs that can be also be used for the private endpoint.
- endpoint
Fqdn string Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration[] Reverse connection configuration details of the private endpoint.
- state string
The current state of the Database Tools private endpoint.
- {[key: string]: any}
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- additional_
fqdns Sequence[str] A list of additional FQDNs that can be also be used for the private endpoint.
- endpoint_
fqdn str Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- private_
endpoint_ strvnic_ id The OCID of the private endpoint's VNIC.
- reverse_
connection_ Databaseconfigurations Tools Private Endpoint Reverse Connection Configuration] Reverse connection configuration details of the private endpoint.
- state str
The current state of the Database Tools private endpoint.
- Mapping[str, Any]
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 private endpoint was created. An RFC3339 formatted datetime string
- time_
updated str The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn_
id str The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns List<String> A list of additional FQDNs that can be also be used for the private endpoint.
- endpoint
Fqdn String Then FQDN to use for the private endpoint.
- 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, can be used to provide actionable information for a resource in Failed state.
- private
Endpoint StringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection List<Property Map>Configurations Reverse connection configuration details of the private endpoint.
- state String
The current state of the Database Tools private endpoint.
- Map<Any>
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated String The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id String The OCID of the VCN that the private endpoint belongs to.
Look up Existing DatabaseToolsPrivateEndpoint Resource
Get an existing DatabaseToolsPrivateEndpoint 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?: DatabaseToolsPrivateEndpointState, opts?: CustomResourceOptions): DatabaseToolsPrivateEndpoint
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_fqdns: Optional[Sequence[str]] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
endpoint_fqdn: Optional[str] = None,
endpoint_service_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
lifecycle_details: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
private_endpoint_ip: Optional[str] = None,
private_endpoint_vnic_id: Optional[str] = None,
reverse_connection_configurations: Optional[Sequence[_databasetools.DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs]] = None,
state: Optional[str] = None,
subnet_id: Optional[str] = None,
system_tags: Optional[Mapping[str, Any]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
vcn_id: Optional[str] = None) -> DatabaseToolsPrivateEndpoint
func GetDatabaseToolsPrivateEndpoint(ctx *Context, name string, id IDInput, state *DatabaseToolsPrivateEndpointState, opts ...ResourceOption) (*DatabaseToolsPrivateEndpoint, error)
public static DatabaseToolsPrivateEndpoint Get(string name, Input<string> id, DatabaseToolsPrivateEndpointState? state, CustomResourceOptions? opts = null)
public static DatabaseToolsPrivateEndpoint get(String name, Output<String> id, DatabaseToolsPrivateEndpointState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Additional
Fqdns List<string> A list of additional FQDNs that can be also be used for the private endpoint.
- Compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) A description of the Database Tools private endpoint.
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Endpoint
Fqdn string Then FQDN to use for the private endpoint.
- Endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- Dictionary<string, object>
(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, can be used to provide actionable information for a resource in Failed state.
- Nsg
Ids List<string> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- Private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- Reverse
Connection List<DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration> Reverse connection configuration details of the private endpoint.
- State string
The current state of the Database Tools private endpoint.
- Subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- Dictionary<string, object>
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 private endpoint was created. An RFC3339 formatted datetime string
- Time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- Vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- Additional
Fqdns []string A list of additional FQDNs that can be also be used for the private endpoint.
- Compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) A description of the Database Tools private endpoint.
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Endpoint
Fqdn string Then FQDN to use for the private endpoint.
- Endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- map[string]interface{}
(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, can be used to provide actionable information for a resource in Failed state.
- Nsg
Ids []string (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- Private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- Reverse
Connection []DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration Args Reverse connection configuration details of the private endpoint.
- State string
The current state of the Database Tools private endpoint.
- Subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- map[string]interface{}
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 private endpoint was created. An RFC3339 formatted datetime string
- Time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- Vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns List<String> A list of additional FQDNs that can be also be used for the private endpoint.
- compartment
Id String (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) A description of the Database Tools private endpoint.
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Fqdn String Then FQDN to use for the private endpoint.
- endpoint
Service StringId The OCID of the
DatabaseToolsEndpointService
.- Map<String,Object>
(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, can be used to provide actionable information for a resource in Failed state.
- nsg
Ids List<String> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp The private IP address that represents the access point for the associated endpoint service.
- private
Endpoint StringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection List<PrivateConfigurations Endpoint Reverse Connection Configuration> Reverse connection configuration details of the private endpoint.
- state String
The current state of the Database Tools private endpoint.
- subnet
Id String The OCID of the subnet that the private endpoint belongs to.
** 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
- Map<String,Object>
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated String The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id String The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns string[] A list of additional FQDNs that can be also be used for the private endpoint.
- compartment
Id string (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
(Updatable) A description of the Database Tools private endpoint.
- display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Fqdn string Then FQDN to use for the private endpoint.
- endpoint
Service stringId The OCID of the
DatabaseToolsEndpointService
.- {[key: string]: any}
(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, can be used to provide actionable information for a resource in Failed state.
- nsg
Ids string[] (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint stringIp The private IP address that represents the access point for the associated endpoint service.
- private
Endpoint stringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection DatabaseConfigurations Tools Private Endpoint Reverse Connection Configuration[] Reverse connection configuration details of the private endpoint.
- state string
The current state of the Database Tools private endpoint.
- subnet
Id string The OCID of the subnet that the private endpoint belongs to.
** 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
- {[key: string]: any}
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated string The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id string The OCID of the VCN that the private endpoint belongs to.
- additional_
fqdns Sequence[str] A list of additional FQDNs that can be also be used for the private endpoint.
- compartment_
id str (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
(Updatable) A description of the Database Tools private endpoint.
- display_
name str (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint_
fqdn str Then FQDN to use for the private endpoint.
- endpoint_
service_ strid The OCID of the
DatabaseToolsEndpointService
.- Mapping[str, Any]
(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, can be used to provide actionable information for a resource in Failed state.
- nsg_
ids Sequence[str] (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private_
endpoint_ strip The private IP address that represents the access point for the associated endpoint service.
- private_
endpoint_ strvnic_ id The OCID of the private endpoint's VNIC.
- reverse_
connection_ Databaseconfigurations Tools Private Endpoint Reverse Connection Configuration Args] Reverse connection configuration details of the private endpoint.
- state str
The current state of the Database Tools private endpoint.
- subnet_
id str The OCID of the subnet that the private endpoint belongs to.
** 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
- Mapping[str, Any]
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 private endpoint was created. An RFC3339 formatted datetime string
- time_
updated str The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn_
id str The OCID of the VCN that the private endpoint belongs to.
- additional
Fqdns List<String> A list of additional FQDNs that can be also be used for the private endpoint.
- compartment
Id String (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) A description of the Database Tools private endpoint.
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- endpoint
Fqdn String Then FQDN to use for the private endpoint.
- endpoint
Service StringId The OCID of the
DatabaseToolsEndpointService
.- Map<Any>
(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, can be used to provide actionable information for a resource in Failed state.
- nsg
Ids List<String> (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp The private IP address that represents the access point for the associated endpoint service.
- private
Endpoint StringVnic Id The OCID of the private endpoint's VNIC.
- reverse
Connection List<Property Map>Configurations Reverse connection configuration details of the private endpoint.
- state String
The current state of the Database Tools private endpoint.
- subnet
Id String The OCID of the subnet that the private endpoint belongs to.
** 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
- Map<Any>
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 private endpoint was created. An RFC3339 formatted datetime string
- time
Updated String The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
- vcn
Id String The OCID of the VCN that the private endpoint belongs to.
Supporting Types
DatabaseToolsPrivateEndpointReverseConnectionConfiguration, DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs
- Reverse
Connections List<DatabaseSource Ips Tools Private Endpoint Reverse Connection Configuration Reverse Connections Source Ip> A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
- Reverse
Connections []DatabaseSource Ips Tools Private Endpoint Reverse Connection Configuration Reverse Connections Source Ip A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
- reverse
Connections List<PrivateSource Ips Endpoint Reverse Connection Configuration Reverse Connections Source Ip> A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
- reverse
Connections DatabaseSource Ips Tools Private Endpoint Reverse Connection Configuration Reverse Connections Source Ip[] A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
- reverse_
connections_ Databasesource_ ips Tools Private Endpoint Reverse Connection Configuration Reverse Connections Source Ip] A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
- reverse
Connections List<Property Map>Source Ips A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp, DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIpArgs
- Source
Ip string The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
- Source
Ip string The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
- source
Ip String The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
- source
Ip string The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
- source_
ip str The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
- source
Ip String The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
Import
DatabaseToolsPrivateEndpoints can be imported using the id
, e.g.
$ pulumi import oci:DatabaseTools/databaseToolsPrivateEndpoint:DatabaseToolsPrivateEndpoint test_database_tools_private_endpoint "id"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.