Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. PrivateEndpointServices
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.PrivateEndpointServices

Explore with Pulumi AI

CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

PrivateEndpointServices contains services that allow for private connectivity to the CockroachDB Cloud cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cockroach from "@pulumiverse/cockroach";

const config = new pulumi.Config();
const clusterId = config.require("clusterId");
const cockroach = new cockroach.PrivateEndpointServices("cockroach", {clusterId: clusterId});
Copy
import pulumi
import pulumiverse_cockroach as cockroach

config = pulumi.Config()
cluster_id = config.require("clusterId")
cockroach = cockroach.PrivateEndpointServices("cockroach", cluster_id=cluster_id)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-cockroach/sdk/go/cockroach"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		clusterId := cfg.Require("clusterId")
		_, err := cockroach.NewPrivateEndpointServices(ctx, "cockroach", &cockroach.PrivateEndpointServicesArgs{
			ClusterId: pulumi.String(clusterId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cockroach = Pulumiverse.Cockroach;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var clusterId = config.Require("clusterId");
    var cockroach = new Cockroach.PrivateEndpointServices("cockroach", new()
    {
        ClusterId = clusterId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.PrivateEndpointServices;
import com.pulumi.cockroach.PrivateEndpointServicesArgs;
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 config = ctx.config();
        final var clusterId = config.get("clusterId");
        var cockroach = new PrivateEndpointServices("cockroach", PrivateEndpointServicesArgs.builder()
            .clusterId(clusterId)
            .build());

    }
}
Copy
configuration:
  clusterId:
    type: string
resources:
  cockroach:
    type: cockroach:PrivateEndpointServices
    properties:
      clusterId: ${clusterId}
Copy

Create PrivateEndpointServices Resource

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

Constructor syntax

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

@overload
def PrivateEndpointServices(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cluster_id: Optional[str] = None)
func NewPrivateEndpointServices(ctx *Context, name string, args PrivateEndpointServicesArgs, opts ...ResourceOption) (*PrivateEndpointServices, error)
public PrivateEndpointServices(string name, PrivateEndpointServicesArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointServices(String name, PrivateEndpointServicesArgs args)
public PrivateEndpointServices(String name, PrivateEndpointServicesArgs args, CustomResourceOptions options)

type: cockroach:PrivateEndpointServices
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointServicesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PrivateEndpointServicesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointServicesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointServicesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PrivateEndpointServicesArgs
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 privateEndpointServicesResource = new Cockroach.PrivateEndpointServices("privateEndpointServicesResource", new()
{
    ClusterId = "string",
});
Copy
example, err := cockroach.NewPrivateEndpointServices(ctx, "privateEndpointServicesResource", &cockroach.PrivateEndpointServicesArgs{
	ClusterId: pulumi.String("string"),
})
Copy
var privateEndpointServicesResource = new PrivateEndpointServices("privateEndpointServicesResource", PrivateEndpointServicesArgs.builder()
    .clusterId("string")
    .build());
Copy
private_endpoint_services_resource = cockroach.PrivateEndpointServices("privateEndpointServicesResource", cluster_id="string")
Copy
const privateEndpointServicesResource = new cockroach.PrivateEndpointServices("privateEndpointServicesResource", {clusterId: "string"});
Copy
type: cockroach:PrivateEndpointServices
properties:
    clusterId: string
Copy

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

ClusterId This property is required. string
ClusterId This property is required. string
clusterId This property is required. String
clusterId This property is required. string
cluster_id This property is required. str
clusterId This property is required. String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Services List<Pulumiverse.Cockroach.Outputs.PrivateEndpointServicesService>
ServicesMap Dictionary<string, Pulumiverse.Cockroach.Outputs.PrivateEndpointServicesServicesMap>
a map of services keyed by the region name
Id string
The provider-assigned unique ID for this managed resource.
Services []PrivateEndpointServicesService
ServicesMap map[string]PrivateEndpointServicesServicesMap
a map of services keyed by the region name
id String
The provider-assigned unique ID for this managed resource.
services List<PrivateEndpointServicesService>
servicesMap Map<String,PrivateEndpointServicesServicesMap>
a map of services keyed by the region name
id string
The provider-assigned unique ID for this managed resource.
services PrivateEndpointServicesService[]
servicesMap {[key: string]: PrivateEndpointServicesServicesMap}
a map of services keyed by the region name
id str
The provider-assigned unique ID for this managed resource.
services Sequence[PrivateEndpointServicesService]
services_map Mapping[str, PrivateEndpointServicesServicesMap]
a map of services keyed by the region name
id String
The provider-assigned unique ID for this managed resource.
services List<Property Map>
servicesMap Map<Property Map>
a map of services keyed by the region name

Look up Existing PrivateEndpointServices Resource

Get an existing PrivateEndpointServices 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?: PrivateEndpointServicesState, opts?: CustomResourceOptions): PrivateEndpointServices
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        services: Optional[Sequence[PrivateEndpointServicesServiceArgs]] = None,
        services_map: Optional[Mapping[str, PrivateEndpointServicesServicesMapArgs]] = None) -> PrivateEndpointServices
func GetPrivateEndpointServices(ctx *Context, name string, id IDInput, state *PrivateEndpointServicesState, opts ...ResourceOption) (*PrivateEndpointServices, error)
public static PrivateEndpointServices Get(string name, Input<string> id, PrivateEndpointServicesState? state, CustomResourceOptions? opts = null)
public static PrivateEndpointServices get(String name, Output<String> id, PrivateEndpointServicesState state, CustomResourceOptions options)
resources:  _:    type: cockroach:PrivateEndpointServices    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClusterId string
Services List<Pulumiverse.Cockroach.Inputs.PrivateEndpointServicesService>
ServicesMap Dictionary<string, Pulumiverse.Cockroach.Inputs.PrivateEndpointServicesServicesMapArgs>
a map of services keyed by the region name
ClusterId string
Services []PrivateEndpointServicesServiceArgs
ServicesMap map[string]PrivateEndpointServicesServicesMapArgs
a map of services keyed by the region name
clusterId String
services List<PrivateEndpointServicesService>
servicesMap Map<String,PrivateEndpointServicesServicesMapArgs>
a map of services keyed by the region name
clusterId string
services PrivateEndpointServicesService[]
servicesMap {[key: string]: PrivateEndpointServicesServicesMapArgs}
a map of services keyed by the region name
cluster_id str
services Sequence[PrivateEndpointServicesServiceArgs]
services_map Mapping[str, PrivateEndpointServicesServicesMapArgs]
a map of services keyed by the region name
clusterId String
services List<Property Map>
servicesMap Map<Property Map>
a map of services keyed by the region name

Supporting Types

PrivateEndpointServicesService
, PrivateEndpointServicesServiceArgs

AvailabilityZoneIds List<string>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
Aws Pulumiverse.Cockroach.Inputs.PrivateEndpointServicesServiceAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

CloudProvider string
Cloud provider associated with this service.
EndpointServiceId string
Server side ID of the private endpoint connection.
Name string
Name of the endpoint service.
RegionName string
Cloud provider region code associated with this service.
Status string
Operation status of the service.
AvailabilityZoneIds []string
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
Aws PrivateEndpointServicesServiceAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

CloudProvider string
Cloud provider associated with this service.
EndpointServiceId string
Server side ID of the private endpoint connection.
Name string
Name of the endpoint service.
RegionName string
Cloud provider region code associated with this service.
Status string
Operation status of the service.
availabilityZoneIds List<String>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServiceAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider String
Cloud provider associated with this service.
endpointServiceId String
Server side ID of the private endpoint connection.
name String
Name of the endpoint service.
regionName String
Cloud provider region code associated with this service.
status String
Operation status of the service.
availabilityZoneIds string[]
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServiceAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider string
Cloud provider associated with this service.
endpointServiceId string
Server side ID of the private endpoint connection.
name string
Name of the endpoint service.
regionName string
Cloud provider region code associated with this service.
status string
Operation status of the service.
availability_zone_ids Sequence[str]
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServiceAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloud_provider str
Cloud provider associated with this service.
endpoint_service_id str
Server side ID of the private endpoint connection.
name str
Name of the endpoint service.
region_name str
Cloud provider region code associated with this service.
status str
Operation status of the service.
availabilityZoneIds List<String>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws Property Map

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider String
Cloud provider associated with this service.
endpointServiceId String
Server side ID of the private endpoint connection.
name String
Name of the endpoint service.
regionName String
Cloud provider region code associated with this service.
status String
Operation status of the service.

PrivateEndpointServicesServiceAws
, PrivateEndpointServicesServiceAwsArgs

AvailabilityZoneIds List<string>
AZ IDs users should create their VPCs in to minimize their cost.
ServiceId string
Server side ID of the PrivateLink connection.
ServiceName string
AWS service name used to create endpoints.
AvailabilityZoneIds []string
AZ IDs users should create their VPCs in to minimize their cost.
ServiceId string
Server side ID of the PrivateLink connection.
ServiceName string
AWS service name used to create endpoints.
availabilityZoneIds List<String>
AZ IDs users should create their VPCs in to minimize their cost.
serviceId String
Server side ID of the PrivateLink connection.
serviceName String
AWS service name used to create endpoints.
availabilityZoneIds string[]
AZ IDs users should create their VPCs in to minimize their cost.
serviceId string
Server side ID of the PrivateLink connection.
serviceName string
AWS service name used to create endpoints.
availability_zone_ids Sequence[str]
AZ IDs users should create their VPCs in to minimize their cost.
service_id str
Server side ID of the PrivateLink connection.
service_name str
AWS service name used to create endpoints.
availabilityZoneIds List<String>
AZ IDs users should create their VPCs in to minimize their cost.
serviceId String
Server side ID of the PrivateLink connection.
serviceName String
AWS service name used to create endpoints.

PrivateEndpointServicesServicesMap
, PrivateEndpointServicesServicesMapArgs

AvailabilityZoneIds List<string>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
Aws Pulumiverse.Cockroach.Inputs.PrivateEndpointServicesServicesMapAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

CloudProvider string
Cloud provider associated with this service.
EndpointServiceId string
Server side ID of the private endpoint connection.
Name string
Name of the endpoint service.
RegionName string
Cloud provider region code associated with this service.
Status string
Operation status of the service.
AvailabilityZoneIds []string
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
Aws PrivateEndpointServicesServicesMapAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

CloudProvider string
Cloud provider associated with this service.
EndpointServiceId string
Server side ID of the private endpoint connection.
Name string
Name of the endpoint service.
RegionName string
Cloud provider region code associated with this service.
Status string
Operation status of the service.
availabilityZoneIds List<String>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServicesMapAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider String
Cloud provider associated with this service.
endpointServiceId String
Server side ID of the private endpoint connection.
name String
Name of the endpoint service.
regionName String
Cloud provider region code associated with this service.
status String
Operation status of the service.
availabilityZoneIds string[]
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServicesMapAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider string
Cloud provider associated with this service.
endpointServiceId string
Server side ID of the private endpoint connection.
name string
Name of the endpoint service.
regionName string
Cloud provider region code associated with this service.
status string
Operation status of the service.
availability_zone_ids Sequence[str]
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws PrivateEndpointServicesServicesMapAws

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloud_provider str
Cloud provider associated with this service.
endpoint_service_id str
Server side ID of the private endpoint connection.
name str
Name of the endpoint service.
region_name str
Cloud provider region code associated with this service.
status str
Operation status of the service.
availabilityZoneIds List<String>
Availability Zone IDs of the private endpoint service. It is recommended, for cost optimization purposes, to create the private endpoint spanning these same availability zones. For more information, see data transfer cost information for your cloud provider.
aws Property Map

Deprecated: nested aws fields have been moved one level up. These fields will be removed in a future version

cloudProvider String
Cloud provider associated with this service.
endpointServiceId String
Server side ID of the private endpoint connection.
name String
Name of the endpoint service.
regionName String
Cloud provider region code associated with this service.
status String
Operation status of the service.

PrivateEndpointServicesServicesMapAws
, PrivateEndpointServicesServicesMapAwsArgs

AvailabilityZoneIds List<string>
AZ IDs users should create their VPCs in to minimize their cost.
ServiceId string
Server side ID of the PrivateLink connection.
ServiceName string
AWS service name used to create endpoints.
AvailabilityZoneIds []string
AZ IDs users should create their VPCs in to minimize their cost.
ServiceId string
Server side ID of the PrivateLink connection.
ServiceName string
AWS service name used to create endpoints.
availabilityZoneIds List<String>
AZ IDs users should create their VPCs in to minimize their cost.
serviceId String
Server side ID of the PrivateLink connection.
serviceName String
AWS service name used to create endpoints.
availabilityZoneIds string[]
AZ IDs users should create their VPCs in to minimize their cost.
serviceId string
Server side ID of the PrivateLink connection.
serviceName string
AWS service name used to create endpoints.
availability_zone_ids Sequence[str]
AZ IDs users should create their VPCs in to minimize their cost.
service_id str
Server side ID of the PrivateLink connection.
service_name str
AWS service name used to create endpoints.
availabilityZoneIds List<String>
AZ IDs users should create their VPCs in to minimize their cost.
serviceId String
Server side ID of the PrivateLink connection.
serviceName String
AWS service name used to create endpoints.

Import

format: 

$ pulumi import cockroach:index/privateEndpointServices:PrivateEndpointServices resource_name 1f69fdd2-600a-4cfc-a9ba-16995df0d77d
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
cockroach pulumiverse/pulumi-cockroach
License
Apache-2.0
Notes
This Pulumi package is based on the cockroach Terraform Provider.
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach