Oracle Cloud Infrastructure v2.28.0, Mar 27 25

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.Kms.getEkmsPrivateEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testEkmsPrivateEndpoint = oci.Kms.getEkmsPrivateEndpoint({
    ekmsPrivateEndpointId: testEkmsPrivateEndpointOciKmsEkmsPrivateEndpoint.id,
});

import pulumi
import pulumi_oci as oci

test_ekms_private_endpoint = oci.Kms.get_ekms_private_endpoint(ekms_private_endpoint_id=test_ekms_private_endpoint_oci_kms_ekms_private_endpoint["id"])

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.GetEkmsPrivateEndpoint(ctx, &kms.GetEkmsPrivateEndpointArgs{
			EkmsPrivateEndpointId: testEkmsPrivateEndpointOciKmsEkmsPrivateEndpoint.Id,
		}, nil)
		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 = Oci.Kms.GetEkmsPrivateEndpoint.Invoke(new()
    {
        EkmsPrivateEndpointId = testEkmsPrivateEndpointOciKmsEkmsPrivateEndpoint.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.KmsFunctions;
import com.pulumi.oci.Kms.inputs.GetEkmsPrivateEndpointArgs;
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) {
        final var testEkmsPrivateEndpoint = KmsFunctions.getEkmsPrivateEndpoint(GetEkmsPrivateEndpointArgs.builder()
            .ekmsPrivateEndpointId(testEkmsPrivateEndpointOciKmsEkmsPrivateEndpoint.id())
            .build());

    }
}

variables:
  testEkmsPrivateEndpoint:
    fn::invoke:
      function: oci:Kms:getEkmsPrivateEndpoint
      arguments:
        ekmsPrivateEndpointId: ${testEkmsPrivateEndpointOciKmsEkmsPrivateEndpoint.id}

Using getEkmsPrivateEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getEkmsPrivateEndpoint(args: GetEkmsPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetEkmsPrivateEndpointResult>
function getEkmsPrivateEndpointOutput(args: GetEkmsPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetEkmsPrivateEndpointResult>

def get_ekms_private_endpoint(ekms_private_endpoint_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetEkmsPrivateEndpointResult
def get_ekms_private_endpoint_output(ekms_private_endpoint_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetEkmsPrivateEndpointResult]

func GetEkmsPrivateEndpoint(ctx *Context, args *GetEkmsPrivateEndpointArgs, opts ...InvokeOption) (*GetEkmsPrivateEndpointResult, error)
func GetEkmsPrivateEndpointOutput(ctx *Context, args *GetEkmsPrivateEndpointOutputArgs, opts ...InvokeOption) GetEkmsPrivateEndpointResultOutput

> Note: This function is named GetEkmsPrivateEndpoint in the Go SDK.

public static class GetEkmsPrivateEndpoint 
{
    public static Task<GetEkmsPrivateEndpointResult> InvokeAsync(GetEkmsPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEkmsPrivateEndpointResult> Invoke(GetEkmsPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEkmsPrivateEndpointResult> getEkmsPrivateEndpoint(GetEkmsPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetEkmsPrivateEndpointResult> getEkmsPrivateEndpoint(GetEkmsPrivateEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Kms/getEkmsPrivateEndpoint:getEkmsPrivateEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EkmsPrivateEndpointId string: Unique EKMS private endpoint identifier.

EkmsPrivateEndpointId string: Unique EKMS private endpoint identifier.

ekmsPrivateEndpointId String: Unique EKMS private endpoint identifier.

ekmsPrivateEndpointId string: Unique EKMS private endpoint identifier.

ekms_private_endpoint_id str: Unique EKMS private endpoint identifier.

ekmsPrivateEndpointId String: Unique EKMS private endpoint identifier.

getEkmsPrivateEndpoint Result

The following output properties are available:

CaBundle string: CABundle to validate TLS certificate of the external key manager system in PEM format
CompartmentId string: Identifier of the compartment this EKMS private endpoint belongs to
DefinedTags Dictionary<string, string>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: Mutable name of the EKMS private endpoint
EkmsPrivateEndpointId string
ExternalKeyManagerIp string: Private IP of the external key manager system to connect to from the EKMS private endpoint
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable
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: Subnet Identifier
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: Identifier of the compartment this EKMS private endpoint belongs to
DefinedTags map[string]string: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: Mutable name of the EKMS private endpoint
EkmsPrivateEndpointId string
ExternalKeyManagerIp string: Private IP of the external key manager system to connect to from the EKMS private endpoint
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable
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: Subnet Identifier
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: Identifier of the compartment this EKMS private endpoint belongs to
definedTags Map<String,String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: Mutable name of the EKMS private endpoint
ekmsPrivateEndpointId String
externalKeyManagerIp String: Private IP of the external key manager system to connect to from the EKMS private endpoint
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable
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: Subnet Identifier
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: Identifier of the compartment this EKMS private endpoint belongs to
definedTags {[key: string]: string}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string: Mutable name of the EKMS private endpoint
ekmsPrivateEndpointId string
externalKeyManagerIp string: Private IP of the external key manager system to connect to from the EKMS private endpoint
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that is immutable
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: Subnet Identifier
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: Identifier of the compartment this EKMS private endpoint belongs to
defined_tags Mapping[str, str]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
display_name str: Mutable name of the EKMS private endpoint
ekms_private_endpoint_id str
external_key_manager_ip str: Private IP of the external key manager system to connect to from the EKMS private endpoint
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier that is immutable
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: Subnet Identifier
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: Identifier of the compartment this EKMS private endpoint belongs to
definedTags Map<String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: Mutable name of the EKMS private endpoint
ekmsPrivateEndpointId String
externalKeyManagerIp String: Private IP of the external key manager system to connect to from the EKMS private endpoint
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable
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: Subnet Identifier
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.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-oci

oci.Kms.getEkmsPrivateEndpoint

On this page

On this page

Example Usage

Using getEkmsPrivateEndpoint

getEkmsPrivateEndpoint Result

Package Details

On this page

On this page