Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

DbManagementPrivateEndpoint

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

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDbManagementPrivateEndpoint = new Oci.DatabaseManagement.DbManagementPrivateEndpoint("testDbManagementPrivateEndpoint", new Oci.DatabaseManagement.DbManagementPrivateEndpointArgs
        {
            CompartmentId = @var.Compartment_id,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            Description = @var.Db_management_private_endpoint_description,
            IsCluster = @var.Db_management_private_endpoint_is_cluster,
            NsgIds = @var.Db_management_private_endpoint_nsg_ids,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DatabaseManagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.NewDbManagementPrivateEndpoint(ctx, "testDbManagementPrivateEndpoint", &DatabaseManagement.DbManagementPrivateEndpointArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
			Description:   pulumi.Any(_var.Db_management_private_endpoint_description),
			IsCluster:     pulumi.Any(_var.Db_management_private_endpoint_is_cluster),
			NsgIds:        pulumi.Any(_var.Db_management_private_endpoint_nsg_ids),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_db_management_private_endpoint = oci.database_management.DbManagementPrivateEndpoint("testDbManagementPrivateEndpoint",
    compartment_id=var["compartment_id"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    description=var["db_management_private_endpoint_description"],
    is_cluster=var["db_management_private_endpoint_is_cluster"],
    nsg_ids=var["db_management_private_endpoint_nsg_ids"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDbManagementPrivateEndpoint = new oci.databasemanagement.DbManagementPrivateEndpoint("testDbManagementPrivateEndpoint", {
    compartmentId: _var.compartment_id,
    subnetId: oci_core_subnet.test_subnet.id,
    description: _var.db_management_private_endpoint_description,
    isCluster: _var.db_management_private_endpoint_is_cluster,
    nsgIds: _var.db_management_private_endpoint_nsg_ids,
});

Coming soon!

Create a DbManagementPrivateEndpoint Resource

new DbManagementPrivateEndpoint(name: string, args: DbManagementPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def DbManagementPrivateEndpoint(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                compartment_id: Optional[str] = None,
                                description: Optional[str] = None,
                                is_cluster: Optional[bool] = None,
                                name: Optional[str] = None,
                                nsg_ids: Optional[Sequence[str]] = None,
                                subnet_id: Optional[str] = None)
@overload
def DbManagementPrivateEndpoint(resource_name: str,
                                args: DbManagementPrivateEndpointArgs,
                                opts: Optional[ResourceOptions] = 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.

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.

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

The DbManagementPrivateEndpoint resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment.

SubnetId string

The OCID of the subnet.

Description string

(Updatable) The description of the private endpoint.

IsCluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

Description string

(Updatable) The description of the private endpoint.

IsCluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

description String

(Updatable) The description of the private endpoint.

isCluster Boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

description string

(Updatable) The description of the private endpoint.

isCluster boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

description str

(Updatable) The description of the private endpoint.

is_cluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

description String

(Updatable) The description of the private endpoint.

isCluster Boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

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.

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.

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.

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.

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 an 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,
        description: Optional[str] = None,
        is_cluster: 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,
        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.

Description string

(Updatable) The description of the private endpoint.

IsCluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

Description string

(Updatable) The description of the private endpoint.

IsCluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

description String

(Updatable) The description of the private endpoint.

isCluster Boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

description string

(Updatable) The description of the private endpoint.

isCluster boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

description str

(Updatable) The description of the private endpoint.

is_cluster bool

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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.

description String

(Updatable) The description of the private endpoint.

isCluster Boolean

Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.

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.

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"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.