Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Kms
  5. EkmsPrivateEndpoint
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.Kms.EkmsPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Ekms Private Endpoint resource in Oracle Cloud Infrastructure Kms service.

    Create a new EKMS private endpoint used to connect to external key manager system

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testEkmsPrivateEndpoint = new oci.kms.EkmsPrivateEndpoint("test_ekms_private_endpoint", {
    caBundle: ekmsPrivateEndpointCaBundle,
    compartmentId: compartmentId,
    displayName: ekmsPrivateEndpointDisplayName,
    externalKeyManagerIp: ekmsPrivateEndpointExternalKeyManagerIp,
    subnetId: testSubnet.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    port: ekmsPrivateEndpointPort,
});

    import pulumi
import pulumi_oci as oci

test_ekms_private_endpoint = oci.kms.EkmsPrivateEndpoint("test_ekms_private_endpoint",
    ca_bundle=ekms_private_endpoint_ca_bundle,
    compartment_id=compartment_id,
    display_name=ekms_private_endpoint_display_name,
    external_key_manager_ip=ekms_private_endpoint_external_key_manager_ip,
    subnet_id=test_subnet["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    port=ekms_private_endpoint_port)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.NewEkmsPrivateEndpoint(ctx, "test_ekms_private_endpoint", &kms.EkmsPrivateEndpointArgs{
			CaBundle:             pulumi.Any(ekmsPrivateEndpointCaBundle),
			CompartmentId:        pulumi.Any(compartmentId),
			DisplayName:          pulumi.Any(ekmsPrivateEndpointDisplayName),
			ExternalKeyManagerIp: pulumi.Any(ekmsPrivateEndpointExternalKeyManagerIp),
			SubnetId:             pulumi.Any(testSubnet.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			Port: pulumi.Any(ekmsPrivateEndpointPort),
		})
		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 testEkmsPrivateEndpoint = new Oci.Kms.EkmsPrivateEndpoint("test_ekms_private_endpoint", new()
    {
        CaBundle = ekmsPrivateEndpointCaBundle,
        CompartmentId = compartmentId,
        DisplayName = ekmsPrivateEndpointDisplayName,
        ExternalKeyManagerIp = ekmsPrivateEndpointExternalKeyManagerIp,
        SubnetId = testSubnet.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        Port = ekmsPrivateEndpointPort,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.EkmsPrivateEndpoint;
import com.pulumi.oci.Kms.EkmsPrivateEndpointArgs;
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 testEkmsPrivateEndpoint = new EkmsPrivateEndpoint("testEkmsPrivateEndpoint", EkmsPrivateEndpointArgs.builder()
            .caBundle(ekmsPrivateEndpointCaBundle)
            .compartmentId(compartmentId)
            .displayName(ekmsPrivateEndpointDisplayName)
            .externalKeyManagerIp(ekmsPrivateEndpointExternalKeyManagerIp)
            .subnetId(testSubnet.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .port(ekmsPrivateEndpointPort)
            .build());

    }
}

    resources:
  testEkmsPrivateEndpoint:
    type: oci:Kms:EkmsPrivateEndpoint
    name: test_ekms_private_endpoint
    properties:
      caBundle: ${ekmsPrivateEndpointCaBundle}
      compartmentId: ${compartmentId}
      displayName: ${ekmsPrivateEndpointDisplayName}
      externalKeyManagerIp: ${ekmsPrivateEndpointExternalKeyManagerIp}
      subnetId: ${testSubnet.id}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      port: ${ekmsPrivateEndpointPort}

    Create EkmsPrivateEndpoint Resource

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

    Constructor syntax

    new EkmsPrivateEndpoint(name: string, args: EkmsPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
def EkmsPrivateEndpoint(resource_name: str,
                        args: EkmsPrivateEndpointArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def EkmsPrivateEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        ca_bundle: Optional[str] = None,
                        compartment_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        external_key_manager_ip: Optional[str] = None,
                        subnet_id: Optional[str] = None,
                        defined_tags: Optional[Mapping[str, str]] = None,
                        freeform_tags: Optional[Mapping[str, str]] = None,
                        port: Optional[int] = None)
    func NewEkmsPrivateEndpoint(ctx *Context, name string, args EkmsPrivateEndpointArgs, opts ...ResourceOption) (*EkmsPrivateEndpoint, error)
    public EkmsPrivateEndpoint(string name, EkmsPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public EkmsPrivateEndpoint(String name, EkmsPrivateEndpointArgs args)
public EkmsPrivateEndpoint(String name, EkmsPrivateEndpointArgs args, CustomResourceOptions options)

    type: oci:Kms:EkmsPrivateEndpoint
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 EkmsPrivateEndpointArgs
    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 EkmsPrivateEndpointArgs
    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 EkmsPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EkmsPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EkmsPrivateEndpointArgs
    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 ekmsPrivateEndpointResource = new Oci.Kms.EkmsPrivateEndpoint("ekmsPrivateEndpointResource", new()
{
    CaBundle = "string",
    CompartmentId = "string",
    DisplayName = "string",
    ExternalKeyManagerIp = "string",
    SubnetId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    Port = 0,
});

    example, err := Kms.NewEkmsPrivateEndpoint(ctx, "ekmsPrivateEndpointResource", &Kms.EkmsPrivateEndpointArgs{
	CaBundle:             pulumi.String("string"),
	CompartmentId:        pulumi.String("string"),
	DisplayName:          pulumi.String("string"),
	ExternalKeyManagerIp: pulumi.String("string"),
	SubnetId:             pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Port: pulumi.Int(0),
})

    var ekmsPrivateEndpointResource = new EkmsPrivateEndpoint("ekmsPrivateEndpointResource", EkmsPrivateEndpointArgs.builder()
    .caBundle("string")
    .compartmentId("string")
    .displayName("string")
    .externalKeyManagerIp("string")
    .subnetId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .port(0)
    .build());

    ekms_private_endpoint_resource = oci.kms.EkmsPrivateEndpoint("ekmsPrivateEndpointResource",
    ca_bundle="string",
    compartment_id="string",
    display_name="string",
    external_key_manager_ip="string",
    subnet_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    port=0)

    const ekmsPrivateEndpointResource = new oci.kms.EkmsPrivateEndpoint("ekmsPrivateEndpointResource", {
    caBundle: "string",
    compartmentId: "string",
    displayName: "string",
    externalKeyManagerIp: "string",
    subnetId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    port: 0,
});

    type: oci:Kms:EkmsPrivateEndpoint
properties:
    caBundle: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    externalKeyManagerIp: string
    freeformTags:
        string: string
    port: 0
    subnetId: string

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

    CaBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    CompartmentId string
    Compartment identifier.
    DisplayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    ExternalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    SubnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Port int
    The port of the external key manager system
    CaBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    CompartmentId string
    Compartment identifier.
    DisplayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    ExternalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    SubnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Port int
    The port of the external key manager system
    caBundle String
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId String
    Compartment identifier.
    displayName String
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp String
    External private IP to connect to from this EKMS private endpoint
    subnetId String

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    port Integer
    The port of the external key manager system
    caBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId string
    Compartment identifier.
    displayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    subnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    port number
    The port of the external key manager system
    ca_bundle str
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartment_id str
    Compartment identifier.
    display_name str
    (Updatable) Display name of the EKMS private endpoint resource being created.
    external_key_manager_ip str
    External private IP to connect to from this EKMS private endpoint
    subnet_id str

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    port int
    The port of the external key manager system
    caBundle String
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId String
    Compartment identifier.
    displayName String
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp String
    External private IP to connect to from this EKMS private endpoint
    subnetId String

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    port Number
    The port of the external key manager system

    Outputs

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

    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.
    PrivateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    State string
    The current state of the EKMS private endpoint resource.
    TimeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    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.
    PrivateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    State string
    The current state of the EKMS private endpoint resource.
    TimeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    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.
    privateEndpointIp String
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state String
    The current state of the EKMS private endpoint resource.
    timeCreated String
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    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.
    privateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state string
    The current state of the EKMS private endpoint resource.
    timeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    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_ip str
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state str
    The current state of the EKMS private endpoint resource.
    time_created str
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    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.
    privateEndpointIp String
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state String
    The current state of the EKMS private endpoint resource.
    timeCreated String
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.

    Look up Existing EkmsPrivateEndpoint Resource

    Get an existing EkmsPrivateEndpoint 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?: EkmsPrivateEndpointState, opts?: CustomResourceOptions): EkmsPrivateEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_bundle: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        external_key_manager_ip: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        port: Optional[int] = None,
        private_endpoint_ip: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> EkmsPrivateEndpoint
    func GetEkmsPrivateEndpoint(ctx *Context, name string, id IDInput, state *EkmsPrivateEndpointState, opts ...ResourceOption) (*EkmsPrivateEndpoint, error)
    public static EkmsPrivateEndpoint Get(string name, Input<string> id, EkmsPrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static EkmsPrivateEndpoint get(String name, Output<String> id, EkmsPrivateEndpointState state, CustomResourceOptions options)
    resources:  _:    type: oci:Kms:EkmsPrivateEndpoint    get:      id: ${id}
    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:
    CaBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    CompartmentId string
    Compartment identifier.
    DefinedTags Dictionary<string, string>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    ExternalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    Port int
    The port of the external key manager system
    PrivateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    State string
    The current state of the EKMS private endpoint resource.
    SubnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    TimeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    CaBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    CompartmentId string
    Compartment identifier.
    DefinedTags map[string]string
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    ExternalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    Port int
    The port of the external key manager system
    PrivateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    State string
    The current state of the EKMS private endpoint resource.
    SubnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    TimeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    caBundle String
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId String
    Compartment identifier.
    definedTags Map<String,String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp String
    External private IP to connect to from this EKMS private endpoint
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    port Integer
    The port of the external key manager system
    privateEndpointIp String
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state String
    The current state of the EKMS private endpoint resource.
    subnetId String

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    timeCreated String
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    caBundle string
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId string
    Compartment identifier.
    definedTags {[key: string]: string}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp string
    External private IP to connect to from this EKMS private endpoint
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    port number
    The port of the external key manager system
    privateEndpointIp string
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state string
    The current state of the EKMS private endpoint resource.
    subnetId string

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    timeCreated string
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    ca_bundle str
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartment_id str
    Compartment identifier.
    defined_tags Mapping[str, str]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Display name of the EKMS private endpoint resource being created.
    external_key_manager_ip str
    External private IP to connect to from this EKMS private endpoint
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
    port int
    The port of the external key manager system
    private_endpoint_ip str
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state str
    The current state of the EKMS private endpoint resource.
    subnet_id str

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    time_created str
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.
    caBundle String
    CABundle to validate TLS certificate of the external key manager system in PEM format
    compartmentId String
    Compartment identifier.
    definedTags Map<String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Display name of the EKMS private endpoint resource being created.
    externalKeyManagerIp String
    External private IP to connect to from this EKMS private endpoint
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    port Number
    The port of the external key manager system
    privateEndpointIp String
    The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
    state String
    The current state of the EKMS private endpoint resource.
    subnetId String

    The OCID of subnet in which the EKMS private endpoint is to be created

    ** 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

    timeCreated String
    The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.

    Import

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

    $ pulumi import oci:Kms/ekmsPrivateEndpoint:EkmsPrivateEndpoint test_ekms_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.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci