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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseToolsPrivateEndpoint = new oci.databasetools.DatabaseToolsPrivateEndpoint("test_database_tools_private_endpoint", {
compartmentId: compartmentId,
displayName: databaseToolsPrivateEndpointDisplayName,
endpointServiceId: testService.id,
subnetId: testSubnet.id,
definedTags: {
"foo-namespace.bar-key": "value",
},
description: databaseToolsPrivateEndpointDescription,
freeformTags: {
"bar-key": "value",
},
locks: [{
type: databaseToolsPrivateEndpointLocksType,
message: databaseToolsPrivateEndpointLocksMessage,
relatedResourceId: testResource.id,
timeCreated: databaseToolsPrivateEndpointLocksTimeCreated,
}],
nsgIds: databaseToolsPrivateEndpointNsgIds,
privateEndpointIp: databaseToolsPrivateEndpointPrivateEndpointIp,
});
import pulumi
import pulumi_oci as oci
test_database_tools_private_endpoint = oci.database_tools.DatabaseToolsPrivateEndpoint("test_database_tools_private_endpoint",
compartment_id=compartment_id,
display_name=database_tools_private_endpoint_display_name,
endpoint_service_id=test_service["id"],
subnet_id=test_subnet["id"],
defined_tags={
"foo-namespace.bar-key": "value",
},
description=database_tools_private_endpoint_description,
freeform_tags={
"bar-key": "value",
},
locks=[{
"type": database_tools_private_endpoint_locks_type,
"message": database_tools_private_endpoint_locks_message,
"related_resource_id": test_resource["id"],
"time_created": database_tools_private_endpoint_locks_time_created,
}],
nsg_ids=database_tools_private_endpoint_nsg_ids,
private_endpoint_ip=database_tools_private_endpoint_private_endpoint_ip)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DatabaseTools"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DatabaseTools.NewDatabaseToolsPrivateEndpoint(ctx, "test_database_tools_private_endpoint", &DatabaseTools.DatabaseToolsPrivateEndpointArgs{
CompartmentId: pulumi.Any(compartmentId),
DisplayName: pulumi.Any(databaseToolsPrivateEndpointDisplayName),
EndpointServiceId: pulumi.Any(testService.Id),
SubnetId: pulumi.Any(testSubnet.Id),
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
Description: pulumi.Any(databaseToolsPrivateEndpointDescription),
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
Locks: databasetools.DatabaseToolsPrivateEndpointLockArray{
&databasetools.DatabaseToolsPrivateEndpointLockArgs{
Type: pulumi.Any(databaseToolsPrivateEndpointLocksType),
Message: pulumi.Any(databaseToolsPrivateEndpointLocksMessage),
RelatedResourceId: pulumi.Any(testResource.Id),
TimeCreated: pulumi.Any(databaseToolsPrivateEndpointLocksTimeCreated),
},
},
NsgIds: pulumi.Any(databaseToolsPrivateEndpointNsgIds),
PrivateEndpointIp: pulumi.Any(databaseToolsPrivateEndpointPrivateEndpointIp),
})
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 testDatabaseToolsPrivateEndpoint = new Oci.DatabaseTools.DatabaseToolsPrivateEndpoint("test_database_tools_private_endpoint", new()
{
CompartmentId = compartmentId,
DisplayName = databaseToolsPrivateEndpointDisplayName,
EndpointServiceId = testService.Id,
SubnetId = testSubnet.Id,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
Description = databaseToolsPrivateEndpointDescription,
FreeformTags =
{
{ "bar-key", "value" },
},
Locks = new[]
{
new Oci.DatabaseTools.Inputs.DatabaseToolsPrivateEndpointLockArgs
{
Type = databaseToolsPrivateEndpointLocksType,
Message = databaseToolsPrivateEndpointLocksMessage,
RelatedResourceId = testResource.Id,
TimeCreated = databaseToolsPrivateEndpointLocksTimeCreated,
},
},
NsgIds = databaseToolsPrivateEndpointNsgIds,
PrivateEndpointIp = databaseToolsPrivateEndpointPrivateEndpointIp,
});
});
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 com.pulumi.oci.DatabaseTools.inputs.DatabaseToolsPrivateEndpointLockArgs;
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(compartmentId)
.displayName(databaseToolsPrivateEndpointDisplayName)
.endpointServiceId(testService.id())
.subnetId(testSubnet.id())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.description(databaseToolsPrivateEndpointDescription)
.freeformTags(Map.of("bar-key", "value"))
.locks(DatabaseToolsPrivateEndpointLockArgs.builder()
.type(databaseToolsPrivateEndpointLocksType)
.message(databaseToolsPrivateEndpointLocksMessage)
.relatedResourceId(testResource.id())
.timeCreated(databaseToolsPrivateEndpointLocksTimeCreated)
.build())
.nsgIds(databaseToolsPrivateEndpointNsgIds)
.privateEndpointIp(databaseToolsPrivateEndpointPrivateEndpointIp)
.build());
}
}
resources:
testDatabaseToolsPrivateEndpoint:
type: oci:DatabaseTools:DatabaseToolsPrivateEndpoint
name: test_database_tools_private_endpoint
properties:
compartmentId: ${compartmentId}
displayName: ${databaseToolsPrivateEndpointDisplayName}
endpointServiceId: ${testService.id}
subnetId: ${testSubnet.id}
definedTags:
foo-namespace.bar-key: value
description: ${databaseToolsPrivateEndpointDescription}
freeformTags:
bar-key: value
locks:
- type: ${databaseToolsPrivateEndpointLocksType}
message: ${databaseToolsPrivateEndpointLocksMessage}
relatedResourceId: ${testResource.id}
timeCreated: ${databaseToolsPrivateEndpointLocksTimeCreated}
nsgIds: ${databaseToolsPrivateEndpointNsgIds}
privateEndpointIp: ${databaseToolsPrivateEndpointPrivateEndpointIp}
Create DatabaseToolsPrivateEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatabaseToolsPrivateEndpoint(name: string, args: DatabaseToolsPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def DatabaseToolsPrivateEndpoint(resource_name: str,
args: DatabaseToolsPrivateEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DatabaseToolsPrivateEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
endpoint_service_id: Optional[str] = None,
subnet_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
locks: Optional[Sequence[_databasetools.DatabaseToolsPrivateEndpointLockArgs]] = None,
nsg_ids: Optional[Sequence[str]] = None,
private_endpoint_ip: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var databaseToolsPrivateEndpointResource = new Oci.DatabaseTools.DatabaseToolsPrivateEndpoint("databaseToolsPrivateEndpointResource", new()
{
CompartmentId = "string",
DisplayName = "string",
EndpointServiceId = "string",
SubnetId = "string",
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
FreeformTags =
{
{ "string", "string" },
},
Locks = new[]
{
new Oci.DatabaseTools.Inputs.DatabaseToolsPrivateEndpointLockArgs
{
Type = "string",
Message = "string",
RelatedResourceId = "string",
TimeCreated = "string",
},
},
NsgIds = new[]
{
"string",
},
PrivateEndpointIp = "string",
});
example, err := DatabaseTools.NewDatabaseToolsPrivateEndpoint(ctx, "databaseToolsPrivateEndpointResource", &DatabaseTools.DatabaseToolsPrivateEndpointArgs{
CompartmentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EndpointServiceId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Locks: databasetools.DatabaseToolsPrivateEndpointLockArray{
&databasetools.DatabaseToolsPrivateEndpointLockArgs{
Type: pulumi.String("string"),
Message: pulumi.String("string"),
RelatedResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
},
},
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateEndpointIp: pulumi.String("string"),
})
var databaseToolsPrivateEndpointResource = new DatabaseToolsPrivateEndpoint("databaseToolsPrivateEndpointResource", DatabaseToolsPrivateEndpointArgs.builder()
.compartmentId("string")
.displayName("string")
.endpointServiceId("string")
.subnetId("string")
.definedTags(Map.of("string", "string"))
.description("string")
.freeformTags(Map.of("string", "string"))
.locks(DatabaseToolsPrivateEndpointLockArgs.builder()
.type("string")
.message("string")
.relatedResourceId("string")
.timeCreated("string")
.build())
.nsgIds("string")
.privateEndpointIp("string")
.build());
database_tools_private_endpoint_resource = oci.database_tools.DatabaseToolsPrivateEndpoint("databaseToolsPrivateEndpointResource",
compartment_id="string",
display_name="string",
endpoint_service_id="string",
subnet_id="string",
defined_tags={
"string": "string",
},
description="string",
freeform_tags={
"string": "string",
},
locks=[{
"type": "string",
"message": "string",
"related_resource_id": "string",
"time_created": "string",
}],
nsg_ids=["string"],
private_endpoint_ip="string")
const databaseToolsPrivateEndpointResource = new oci.databasetools.DatabaseToolsPrivateEndpoint("databaseToolsPrivateEndpointResource", {
compartmentId: "string",
displayName: "string",
endpointServiceId: "string",
subnetId: "string",
definedTags: {
string: "string",
},
description: "string",
freeformTags: {
string: "string",
},
locks: [{
type: "string",
message: "string",
relatedResourceId: "string",
timeCreated: "string",
}],
nsgIds: ["string"],
privateEndpointIp: "string",
});
type: oci:DatabaseTools:DatabaseToolsPrivateEndpoint
properties:
compartmentId: string
definedTags:
string: string
description: string
displayName: string
endpointServiceId: string
freeformTags:
string: string
locks:
- message: string
relatedResourceId: string
timeCreated: string
type: string
nsgIds:
- string
privateEndpointIp: string
subnetId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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, string>
- (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, 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<Database
Tools Private Endpoint Lock> - Locks associated with this resource.
- 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]string
- (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]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
[]Database
Tools Private Endpoint Lock Args - Locks associated with this resource.
- 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,String>
- (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,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<Private
Endpoint Lock> - Locks associated with this resource.
- 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]: string}
- (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]: 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
Database
Tools Private Endpoint Lock[] - Locks associated with this resource.
- 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, str]
- (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, 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[databasetools.
Database Tools Private Endpoint Lock Args] - Locks associated with this resource.
- 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<String>
- (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>
- (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.
- 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, 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 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]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 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,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 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]: 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 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_ Sequence[databasetools.configurations Database 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, 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 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<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 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, str]] = 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, str]] = None,
lifecycle_details: Optional[str] = None,
locks: Optional[Sequence[_databasetools.DatabaseToolsPrivateEndpointLockArgs]] = 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, str]] = 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, string>
- (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, 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, can be used to provide actionable information for a resource in Failed state.
- Locks
List<Database
Tools Private Endpoint Lock> - Locks associated with this resource.
- 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, 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 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]string
- (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]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, can be used to provide actionable information for a resource in Failed state.
- Locks
[]Database
Tools Private Endpoint Lock Args - Locks associated with this resource.
- 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]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 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,String>
- (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,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, can be used to provide actionable information for a resource in Failed state.
- locks
List<Private
Endpoint Lock> - Locks associated with this resource.
- 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,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 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]: string}
- (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]: 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, can be used to provide actionable information for a resource in Failed state.
- locks
Database
Tools Private Endpoint Lock[] - Locks associated with this resource.
- 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]: 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 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, str]
- (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, 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, can be used to provide actionable information for a resource in Failed state.
- locks
Sequence[databasetools.
Database Tools Private Endpoint Lock Args] - Locks associated with this resource.
- 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_ Sequence[databasetools.configurations Database 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, 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 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<String>
- (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>
- (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.
- locks List<Property Map>
- Locks associated with this resource.
- 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<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 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
DatabaseToolsPrivateEndpointLock, DatabaseToolsPrivateEndpointLockArgs
- 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.
- 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.
- 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.
- 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.
- 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 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.
- 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.
- 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.
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_ Sequence[databasetools.source_ ips Database 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"
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.