Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseTools
  5. DatabaseToolsPrivateEndpoint
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi
pulumi/pulumi-oci

oci.DatabaseTools.DatabaseToolsPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi
pulumi/pulumi-oci

    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.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(_var.Database_tools_private_endpoint_description),
			FreeformTags: pulumi.AnyMap{
				"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:

    CompartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    DisplayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    EndpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    SubnetId 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

    DefinedTags 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.

    FreeformTags 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"}

    NsgIds 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.

    PrivateEndpointIp string

    The private IP address that represents the access point for the associated endpoint service.

    CompartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    DisplayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    EndpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    SubnetId 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

    DefinedTags 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.

    FreeformTags 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"}

    NsgIds []string

    (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

    PrivateEndpointIp string

    The private IP address that represents the access point for the associated endpoint service.

    compartmentId String

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    displayName String

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointServiceId String

    The OCID of the DatabaseToolsEndpointService.

    subnetId 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

    definedTags 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.

    freeformTags 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"}

    nsgIds 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.

    privateEndpointIp String

    The private IP address that represents the access point for the associated endpoint service.

    compartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    displayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    subnetId 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

    definedTags {[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.

    freeformTags {[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"}

    nsgIds string[]

    (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

    privateEndpointIp string

    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_id str

    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

    defined_tags 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.

    freeform_tags 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_ip str

    The private IP address that represents the access point for the associated endpoint service.

    compartmentId String

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    displayName String

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointServiceId String

    The OCID of the DatabaseToolsEndpointService.

    subnetId 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

    definedTags 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.

    freeformTags 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"}

    nsgIds 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.

    privateEndpointIp String

    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:

    AdditionalFqdns List<string>

    A list of additional FQDNs that can be also be used for the private endpoint.

    EndpointFqdn string

    Then FQDN to use for the private endpoint.

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleDetails 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.

    PrivateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    ReverseConnectionConfigurations List<DatabaseToolsPrivateEndpointReverseConnectionConfiguration>

    Reverse connection configuration details of the private endpoint.

    State string

    The current state of the Database Tools private endpoint.

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    TimeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    VcnId string

    The OCID of the VCN that the private endpoint belongs to.

    AdditionalFqdns []string

    A list of additional FQDNs that can be also be used for the private endpoint.

    EndpointFqdn string

    Then FQDN to use for the private endpoint.

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleDetails 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.

    PrivateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    ReverseConnectionConfigurations []DatabaseToolsPrivateEndpointReverseConnectionConfiguration

    Reverse connection configuration details of the private endpoint.

    State string

    The current state of the Database Tools private endpoint.

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    TimeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    VcnId string

    The OCID of the VCN that the private endpoint belongs to.

    additionalFqdns List<String>

    A list of additional FQDNs that can be also be used for the private endpoint.

    endpointFqdn String

    Then FQDN to use for the private endpoint.

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails 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.

    privateEndpointVnicId String

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations List<PrivateEndpointReverseConnectionConfiguration>

    Reverse connection configuration details of the private endpoint.

    state String

    The current state of the Database Tools private endpoint.

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated String

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId String

    The OCID of the VCN that the private endpoint belongs to.

    additionalFqdns string[]

    A list of additional FQDNs that can be also be used for the private endpoint.

    endpointFqdn string

    Then FQDN to use for the private endpoint.

    id string

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails 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.

    privateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations DatabaseToolsPrivateEndpointReverseConnectionConfiguration[]

    Reverse connection configuration details of the private endpoint.

    state string

    The current state of the Database Tools private endpoint.

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId 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_vnic_id str

    The OCID of the private endpoint's VNIC.

    reverse_connection_configurations DatabaseToolsPrivateEndpointReverseConnectionConfiguration]

    Reverse connection configuration details of the private endpoint.

    state str

    The current state of the Database Tools private endpoint.

    system_tags 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.

    additionalFqdns List<String>

    A list of additional FQDNs that can be also be used for the private endpoint.

    endpointFqdn String

    Then FQDN to use for the private endpoint.

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails 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.

    privateEndpointVnicId String

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations List<Property Map>

    Reverse connection configuration details of the private endpoint.

    state String

    The current state of the Database Tools private endpoint.

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated String

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId 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.
    The following state arguments are supported:
    AdditionalFqdns List<string>

    A list of additional FQDNs that can be also be used for the private endpoint.

    CompartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    DefinedTags 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.

    DisplayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    EndpointFqdn string

    Then FQDN to use for the private endpoint.

    EndpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    FreeformTags 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"}

    LifecycleDetails 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.

    NsgIds 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.

    PrivateEndpointIp string

    The private IP address that represents the access point for the associated endpoint service.

    PrivateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    ReverseConnectionConfigurations List<DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs>

    Reverse connection configuration details of the private endpoint.

    State string

    The current state of the Database Tools private endpoint.

    SubnetId 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

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    TimeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    VcnId string

    The OCID of the VCN that the private endpoint belongs to.

    AdditionalFqdns []string

    A list of additional FQDNs that can be also be used for the private endpoint.

    CompartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    DefinedTags 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.

    DisplayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    EndpointFqdn string

    Then FQDN to use for the private endpoint.

    EndpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    FreeformTags 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"}

    LifecycleDetails 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.

    NsgIds []string

    (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

    PrivateEndpointIp string

    The private IP address that represents the access point for the associated endpoint service.

    PrivateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    ReverseConnectionConfigurations []DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs

    Reverse connection configuration details of the private endpoint.

    State string

    The current state of the Database Tools private endpoint.

    SubnetId 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

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    TimeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    VcnId string

    The OCID of the VCN that the private endpoint belongs to.

    additionalFqdns List<String>

    A list of additional FQDNs that can be also be used for the private endpoint.

    compartmentId String

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    definedTags 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.

    displayName String

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointFqdn String

    Then FQDN to use for the private endpoint.

    endpointServiceId String

    The OCID of the DatabaseToolsEndpointService.

    freeformTags 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"}

    lifecycleDetails 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.

    nsgIds 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.

    privateEndpointIp String

    The private IP address that represents the access point for the associated endpoint service.

    privateEndpointVnicId String

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations List<PrivateEndpointReverseConnectionConfigurationArgs>

    Reverse connection configuration details of the private endpoint.

    state String

    The current state of the Database Tools private endpoint.

    subnetId 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

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated String

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId String

    The OCID of the VCN that the private endpoint belongs to.

    additionalFqdns string[]

    A list of additional FQDNs that can be also be used for the private endpoint.

    compartmentId string

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    definedTags {[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.

    displayName string

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointFqdn string

    Then FQDN to use for the private endpoint.

    endpointServiceId string

    The OCID of the DatabaseToolsEndpointService.

    freeformTags {[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"}

    lifecycleDetails 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.

    nsgIds string[]

    (Updatable) The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

    privateEndpointIp string

    The private IP address that represents the access point for the associated endpoint service.

    privateEndpointVnicId string

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs[]

    Reverse connection configuration details of the private endpoint.

    state string

    The current state of the Database Tools private endpoint.

    subnetId 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

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated string

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated string

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId 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.

    defined_tags 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_id str

    The OCID of the DatabaseToolsEndpointService.

    freeform_tags 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_ip str

    The private IP address that represents the access point for the associated endpoint service.

    private_endpoint_vnic_id str

    The OCID of the private endpoint's VNIC.

    reverse_connection_configurations DatabaseToolsPrivateEndpointReverseConnectionConfigurationArgs]

    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

    system_tags 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.

    additionalFqdns List<String>

    A list of additional FQDNs that can be also be used for the private endpoint.

    compartmentId String

    (Updatable) The OCID of the compartment containing the Database Tools private endpoint.

    definedTags 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.

    displayName String

    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

    endpointFqdn String

    Then FQDN to use for the private endpoint.

    endpointServiceId String

    The OCID of the DatabaseToolsEndpointService.

    freeformTags 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"}

    lifecycleDetails 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.

    nsgIds 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.

    privateEndpointIp String

    The private IP address that represents the access point for the associated endpoint service.

    privateEndpointVnicId String

    The OCID of the private endpoint's VNIC.

    reverseConnectionConfigurations List<Property Map>

    Reverse connection configuration details of the private endpoint.

    state String

    The current state of the Database Tools private endpoint.

    subnetId 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

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

    timeUpdated String

    The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

    vcnId String

    The OCID of the VCN that the private endpoint belongs to.

    Supporting Types

    DatabaseToolsPrivateEndpointReverseConnectionConfiguration

    ReverseConnectionsSourceIps List<DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp>

    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.

    ReverseConnectionsSourceIps []DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp

    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.

    reverseConnectionsSourceIps List<PrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp>

    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.

    reverseConnectionsSourceIps DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp[]

    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_source_ips DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp]

    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.

    reverseConnectionsSourceIps List<Property Map>

    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

    SourceIp 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.

    SourceIp 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.

    sourceIp 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.

    sourceIp 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.

    sourceIp 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.

    oci logo
    Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi
    pulumi/pulumi-oci