Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Kms.getEkmsPrivateEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testEkmsPrivateEndpoints = oci.Kms.getEkmsPrivateEndpoints({
    compartmentId: compartmentId,
});

import pulumi
import pulumi_oci as oci

test_ekms_private_endpoints = oci.Kms.get_ekms_private_endpoints(compartment_id=compartment_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.GetEkmsPrivateEndpoints(ctx, &kms.GetEkmsPrivateEndpointsArgs{
			CompartmentId: compartmentId,
		}, 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 testEkmsPrivateEndpoints = Oci.Kms.GetEkmsPrivateEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});

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.GetEkmsPrivateEndpointsArgs;
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 testEkmsPrivateEndpoints = KmsFunctions.getEkmsPrivateEndpoints(GetEkmsPrivateEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}

variables:
  testEkmsPrivateEndpoints:
    fn::invoke:
      function: oci:Kms:getEkmsPrivateEndpoints
      arguments:
        compartmentId: ${compartmentId}

Using getEkmsPrivateEndpoints

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 getEkmsPrivateEndpoints(args: GetEkmsPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetEkmsPrivateEndpointsResult>
function getEkmsPrivateEndpointsOutput(args: GetEkmsPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEkmsPrivateEndpointsResult>

def get_ekms_private_endpoints(compartment_id: Optional[str] = None,
                               filters: Optional[Sequence[_kms.GetEkmsPrivateEndpointsFilter]] = None,
                               opts: Optional[InvokeOptions] = None) -> GetEkmsPrivateEndpointsResult
def get_ekms_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_kms.GetEkmsPrivateEndpointsFilterArgs]]]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetEkmsPrivateEndpointsResult]

func GetEkmsPrivateEndpoints(ctx *Context, args *GetEkmsPrivateEndpointsArgs, opts ...InvokeOption) (*GetEkmsPrivateEndpointsResult, error)
func GetEkmsPrivateEndpointsOutput(ctx *Context, args *GetEkmsPrivateEndpointsOutputArgs, opts ...InvokeOption) GetEkmsPrivateEndpointsResultOutput

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

public static class GetEkmsPrivateEndpoints 
{
    public static Task<GetEkmsPrivateEndpointsResult> InvokeAsync(GetEkmsPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEkmsPrivateEndpointsResult> Invoke(GetEkmsPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEkmsPrivateEndpointsResult> getEkmsPrivateEndpoints(GetEkmsPrivateEndpointsArgs args, InvokeOptions options)
public static Output<GetEkmsPrivateEndpointsResult> getEkmsPrivateEndpoints(GetEkmsPrivateEndpointsArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
Filters List<GetEkmsPrivateEndpointsFilter>

CompartmentId string: The OCID of the compartment.
Filters []GetEkmsPrivateEndpointsFilter

compartmentId String: The OCID of the compartment.
filters List<GetEkmsPrivateEndpointsFilter>

compartmentId string: The OCID of the compartment.
filters GetEkmsPrivateEndpointsFilter[]

compartment_id str: The OCID of the compartment.
filters Sequence[kms.GetEkmsPrivateEndpointsFilter]

compartmentId String: The OCID of the compartment.
filters List<Property Map>

getEkmsPrivateEndpoints Result

The following output properties are available:

CompartmentId string: Identifier of the compartment this EKMS private endpoint belongs to
EkmsPrivateEndpoints List<GetEkmsPrivateEndpointsEkmsPrivateEndpoint>: The list of ekms_private_endpoints.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetEkmsPrivateEndpointsFilter>

CompartmentId string: Identifier of the compartment this EKMS private endpoint belongs to
EkmsPrivateEndpoints []GetEkmsPrivateEndpointsEkmsPrivateEndpoint: The list of ekms_private_endpoints.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetEkmsPrivateEndpointsFilter

compartmentId String: Identifier of the compartment this EKMS private endpoint belongs to
ekmsPrivateEndpoints List<GetEkmsPrivateEndpointsEkmsPrivateEndpoint>: The list of ekms_private_endpoints.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetEkmsPrivateEndpointsFilter>

compartmentId string: Identifier of the compartment this EKMS private endpoint belongs to
ekmsPrivateEndpoints GetEkmsPrivateEndpointsEkmsPrivateEndpoint[]: The list of ekms_private_endpoints.
id string: The provider-assigned unique ID for this managed resource.
filters GetEkmsPrivateEndpointsFilter[]

compartment_id str: Identifier of the compartment this EKMS private endpoint belongs to
ekms_private_endpoints Sequence[kms.GetEkmsPrivateEndpointsEkmsPrivateEndpoint]: The list of ekms_private_endpoints.
id str: The provider-assigned unique ID for this managed resource.
filters Sequence[kms.GetEkmsPrivateEndpointsFilter]

compartmentId String: Identifier of the compartment this EKMS private endpoint belongs to
ekmsPrivateEndpoints List<Property Map>: The list of ekms_private_endpoints.
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>

Supporting Types

GetEkmsPrivateEndpointsEkmsPrivateEndpoint

CaBundle string: CABundle to validate TLS certificate of the external key manager system in PEM format
CompartmentId string: The OCID of the compartment.
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
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: The OCID of the compartment.
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
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: The OCID of the compartment.
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
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: The OCID of the compartment.
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
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: The OCID of the compartment.
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
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: The OCID of the compartment.
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
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.

GetEkmsPrivateEndpointsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Kms.getEkmsPrivateEndpoints

On this page

On this page

Example Usage

Using getEkmsPrivateEndpoints

getEkmsPrivateEndpoints Result

Supporting Types

GetEkmsPrivateEndpointsEkmsPrivateEndpoint

GetEkmsPrivateEndpointsFilter

Package Details

On this page

On this page