1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. DbManagementPrivateEndpoint
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.DatabaseManagement.DbManagementPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This resource provides the Db Management Private Endpoint resource in Oracle Cloud Infrastructure Database Management service.

    Creates a new Database Management private endpoint.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDbManagementPrivateEndpoint = new oci.databasemanagement.DbManagementPrivateEndpoint("test_db_management_private_endpoint", {
        compartmentId: compartmentId,
        name: dbManagementPrivateEndpointName,
        subnetId: testSubnet.id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: dbManagementPrivateEndpointDescription,
        freeformTags: {
            Department: "Finance",
        },
        isCluster: dbManagementPrivateEndpointIsCluster,
        isDnsResolutionEnabled: dbManagementPrivateEndpointIsDnsResolutionEnabled,
        nsgIds: dbManagementPrivateEndpointNsgIds,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_db_management_private_endpoint = oci.database_management.DbManagementPrivateEndpoint("test_db_management_private_endpoint",
        compartment_id=compartment_id,
        name=db_management_private_endpoint_name,
        subnet_id=test_subnet["id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=db_management_private_endpoint_description,
        freeform_tags={
            "Department": "Finance",
        },
        is_cluster=db_management_private_endpoint_is_cluster,
        is_dns_resolution_enabled=db_management_private_endpoint_is_dns_resolution_enabled,
        nsg_ids=db_management_private_endpoint_nsg_ids)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DatabaseManagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DatabaseManagement.NewDbManagementPrivateEndpoint(ctx, "test_db_management_private_endpoint", &DatabaseManagement.DbManagementPrivateEndpointArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			Name:          pulumi.Any(dbManagementPrivateEndpointName),
    			SubnetId:      pulumi.Any(testSubnet.Id),
    			DefinedTags: pulumi.StringMap{
    				"Operations.CostCenter": pulumi.String("42"),
    			},
    			Description: pulumi.Any(dbManagementPrivateEndpointDescription),
    			FreeformTags: pulumi.StringMap{
    				"Department": pulumi.String("Finance"),
    			},
    			IsCluster:              pulumi.Any(dbManagementPrivateEndpointIsCluster),
    			IsDnsResolutionEnabled: pulumi.Any(dbManagementPrivateEndpointIsDnsResolutionEnabled),
    			NsgIds:                 pulumi.Any(dbManagementPrivateEndpointNsgIds),
    		})
    		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 testDbManagementPrivateEndpoint = new Oci.DatabaseManagement.DbManagementPrivateEndpoint("test_db_management_private_endpoint", new()
        {
            CompartmentId = compartmentId,
            Name = dbManagementPrivateEndpointName,
            SubnetId = testSubnet.Id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = dbManagementPrivateEndpointDescription,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            IsCluster = dbManagementPrivateEndpointIsCluster,
            IsDnsResolutionEnabled = dbManagementPrivateEndpointIsDnsResolutionEnabled,
            NsgIds = dbManagementPrivateEndpointNsgIds,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DatabaseManagement.DbManagementPrivateEndpoint;
    import com.pulumi.oci.DatabaseManagement.DbManagementPrivateEndpointArgs;
    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 testDbManagementPrivateEndpoint = new DbManagementPrivateEndpoint("testDbManagementPrivateEndpoint", DbManagementPrivateEndpointArgs.builder()
                .compartmentId(compartmentId)
                .name(dbManagementPrivateEndpointName)
                .subnetId(testSubnet.id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(dbManagementPrivateEndpointDescription)
                .freeformTags(Map.of("Department", "Finance"))
                .isCluster(dbManagementPrivateEndpointIsCluster)
                .isDnsResolutionEnabled(dbManagementPrivateEndpointIsDnsResolutionEnabled)
                .nsgIds(dbManagementPrivateEndpointNsgIds)
                .build());
    
        }
    }
    
    resources:
      testDbManagementPrivateEndpoint:
        type: oci:DatabaseManagement:DbManagementPrivateEndpoint
        name: test_db_management_private_endpoint
        properties:
          compartmentId: ${compartmentId}
          name: ${dbManagementPrivateEndpointName}
          subnetId: ${testSubnet.id}
          definedTags:
            Operations.CostCenter: '42'
          description: ${dbManagementPrivateEndpointDescription}
          freeformTags:
            Department: Finance
          isCluster: ${dbManagementPrivateEndpointIsCluster}
          isDnsResolutionEnabled: ${dbManagementPrivateEndpointIsDnsResolutionEnabled}
          nsgIds: ${dbManagementPrivateEndpointNsgIds}
    

    Create DbManagementPrivateEndpoint Resource

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

    Constructor syntax

    new DbManagementPrivateEndpoint(name: string, args: DbManagementPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def DbManagementPrivateEndpoint(resource_name: str,
                                    args: DbManagementPrivateEndpointArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbManagementPrivateEndpoint(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    compartment_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,
                                    is_cluster: Optional[bool] = None,
                                    is_dns_resolution_enabled: Optional[bool] = None,
                                    name: Optional[str] = None,
                                    nsg_ids: Optional[Sequence[str]] = None)
    func NewDbManagementPrivateEndpoint(ctx *Context, name string, args DbManagementPrivateEndpointArgs, opts ...ResourceOption) (*DbManagementPrivateEndpoint, error)
    public DbManagementPrivateEndpoint(string name, DbManagementPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public DbManagementPrivateEndpoint(String name, DbManagementPrivateEndpointArgs args)
    public DbManagementPrivateEndpoint(String name, DbManagementPrivateEndpointArgs args, CustomResourceOptions options)
    
    type: oci:DatabaseManagement:DbManagementPrivateEndpoint
    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 DbManagementPrivateEndpointArgs
    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 DbManagementPrivateEndpointArgs
    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 DbManagementPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbManagementPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbManagementPrivateEndpointArgs
    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 dbManagementPrivateEndpointResource = new Oci.DatabaseManagement.DbManagementPrivateEndpoint("dbManagementPrivateEndpointResource", new()
    {
        CompartmentId = "string",
        SubnetId = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        IsCluster = false,
        IsDnsResolutionEnabled = false,
        Name = "string",
        NsgIds = new[]
        {
            "string",
        },
    });
    
    example, err := DatabaseManagement.NewDbManagementPrivateEndpoint(ctx, "dbManagementPrivateEndpointResource", &DatabaseManagement.DbManagementPrivateEndpointArgs{
    	CompartmentId: 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"),
    	},
    	IsCluster:              pulumi.Bool(false),
    	IsDnsResolutionEnabled: pulumi.Bool(false),
    	Name:                   pulumi.String("string"),
    	NsgIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var dbManagementPrivateEndpointResource = new DbManagementPrivateEndpoint("dbManagementPrivateEndpointResource", DbManagementPrivateEndpointArgs.builder()
        .compartmentId("string")
        .subnetId("string")
        .definedTags(Map.of("string", "string"))
        .description("string")
        .freeformTags(Map.of("string", "string"))
        .isCluster(false)
        .isDnsResolutionEnabled(false)
        .name("string")
        .nsgIds("string")
        .build());
    
    db_management_private_endpoint_resource = oci.database_management.DbManagementPrivateEndpoint("dbManagementPrivateEndpointResource",
        compartment_id="string",
        subnet_id="string",
        defined_tags={
            "string": "string",
        },
        description="string",
        freeform_tags={
            "string": "string",
        },
        is_cluster=False,
        is_dns_resolution_enabled=False,
        name="string",
        nsg_ids=["string"])
    
    const dbManagementPrivateEndpointResource = new oci.databasemanagement.DbManagementPrivateEndpoint("dbManagementPrivateEndpointResource", {
        compartmentId: "string",
        subnetId: "string",
        definedTags: {
            string: "string",
        },
        description: "string",
        freeformTags: {
            string: "string",
        },
        isCluster: false,
        isDnsResolutionEnabled: false,
        name: "string",
        nsgIds: ["string"],
    });
    
    type: oci:DatabaseManagement:DbManagementPrivateEndpoint
    properties:
        compartmentId: string
        definedTags:
            string: string
        description: string
        freeformTags:
            string: string
        isCluster: false
        isDnsResolutionEnabled: false
        name: string
        nsgIds:
            - string
        subnetId: string
    

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

    CompartmentId string
    (Updatable) The OCID of the compartment.
    SubnetId string

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the private endpoint.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    IsDnsResolutionEnabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    Name string
    (Updatable) The display name of the Database Management private endpoint.
    NsgIds List<string>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    SubnetId string

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the private endpoint.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    IsDnsResolutionEnabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    Name string
    (Updatable) The display name of the Database Management private endpoint.
    NsgIds []string
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    compartmentId String
    (Updatable) The OCID of the compartment.
    subnetId String

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the private endpoint.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster Boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled Boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name String
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds List<String>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    compartmentId string
    (Updatable) The OCID of the compartment.
    subnetId string

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the private endpoint.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name string
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds string[]
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    compartment_id str
    (Updatable) The OCID of the compartment.
    subnet_id str

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the private endpoint.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_cluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    is_dns_resolution_enabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name str
    (Updatable) The display name of the Database Management private endpoint.
    nsg_ids Sequence[str]
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    compartmentId String
    (Updatable) The OCID of the compartment.
    subnetId String

    The OCID of the subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the private endpoint.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster Boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled Boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name String
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds List<String>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIp string
    The IP addresses assigned to the Database Management private endpoint.
    State string
    The current lifecycle state of the Database Management private endpoint.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    VcnId string
    The OCID of the VCN.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIp string
    The IP addresses assigned to the Database Management private endpoint.
    State string
    The current lifecycle state of the Database Management private endpoint.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    VcnId string
    The OCID of the VCN.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIp String
    The IP addresses assigned to the Database Management private endpoint.
    state String
    The current lifecycle state of the Database Management private endpoint.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId String
    The OCID of the VCN.
    id string
    The provider-assigned unique ID for this managed resource.
    privateIp string
    The IP addresses assigned to the Database Management private endpoint.
    state string
    The current lifecycle state of the Database Management private endpoint.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId string
    The OCID of the VCN.
    id str
    The provider-assigned unique ID for this managed resource.
    private_ip str
    The IP addresses assigned to the Database Management private endpoint.
    state str
    The current lifecycle state of the Database Management private endpoint.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcn_id str
    The OCID of the VCN.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIp String
    The IP addresses assigned to the Database Management private endpoint.
    state String
    The current lifecycle state of the Database Management private endpoint.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId String
    The OCID of the VCN.

    Look up Existing DbManagementPrivateEndpoint Resource

    Get an existing DbManagementPrivateEndpoint 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?: DbManagementPrivateEndpointState, opts?: CustomResourceOptions): DbManagementPrivateEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            is_cluster: Optional[bool] = None,
            is_dns_resolution_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            nsg_ids: Optional[Sequence[str]] = None,
            private_ip: Optional[str] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            vcn_id: Optional[str] = None) -> DbManagementPrivateEndpoint
    func GetDbManagementPrivateEndpoint(ctx *Context, name string, id IDInput, state *DbManagementPrivateEndpointState, opts ...ResourceOption) (*DbManagementPrivateEndpoint, error)
    public static DbManagementPrivateEndpoint Get(string name, Input<string> id, DbManagementPrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static DbManagementPrivateEndpoint get(String name, Output<String> id, DbManagementPrivateEndpointState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the private endpoint.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    IsDnsResolutionEnabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    Name string
    (Updatable) The display name of the Database Management private endpoint.
    NsgIds List<string>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    PrivateIp string
    The IP addresses assigned to the Database Management private endpoint.
    State string
    The current lifecycle state of the Database Management private endpoint.
    SubnetId string

    The OCID of the subnet.

    ** 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, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    VcnId string
    The OCID of the VCN.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the private endpoint.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    IsDnsResolutionEnabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    Name string
    (Updatable) The display name of the Database Management private endpoint.
    NsgIds []string
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    PrivateIp string
    The IP addresses assigned to the Database Management private endpoint.
    State string
    The current lifecycle state of the Database Management private endpoint.
    SubnetId string

    The OCID of the subnet.

    ** 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]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    VcnId string
    The OCID of the VCN.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the private endpoint.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster Boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled Boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name String
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds List<String>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    privateIp String
    The IP addresses assigned to the Database Management private endpoint.
    state String
    The current lifecycle state of the Database Management private endpoint.
    subnetId String

    The OCID of the subnet.

    ** 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,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId String
    The OCID of the VCN.
    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the private endpoint.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name string
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds string[]
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    privateIp string
    The IP addresses assigned to the Database Management private endpoint.
    state string
    The current lifecycle state of the Database Management private endpoint.
    subnetId string

    The OCID of the subnet.

    ** 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]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId string
    The OCID of the VCN.
    compartment_id str
    (Updatable) The OCID of the compartment.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the private endpoint.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_cluster bool
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    is_dns_resolution_enabled bool
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name str
    (Updatable) The display name of the Database Management private endpoint.
    nsg_ids Sequence[str]
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    private_ip str
    The IP addresses assigned to the Database Management private endpoint.
    state str
    The current lifecycle state of the Database Management private endpoint.
    subnet_id str

    The OCID of the subnet.

    ** 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, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcn_id str
    The OCID of the VCN.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the private endpoint.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCluster Boolean
    Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
    isDnsResolutionEnabled Boolean
    Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
    name String
    (Updatable) The display name of the Database Management private endpoint.
    nsgIds List<String>
    (Updatable) The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
    privateIp String
    The IP addresses assigned to the Database Management private endpoint.
    state String
    The current lifecycle state of the Database Management private endpoint.
    subnetId String

    The OCID of the subnet.

    ** 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>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
    vcnId String
    The OCID of the VCN.

    Import

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

    $ pulumi import oci:DatabaseManagement/dbManagementPrivateEndpoint:DbManagementPrivateEndpoint test_db_management_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.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi