Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Clickhouse
  3. API Docs
  4. PrivateEndpoint
  5. Registration
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

clickhouse.PrivateEndpoint.Registration

Explore with Pulumi AI

clickhouse logo
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

    ClickHouse Cloud provides the ability to connect your services to your cloud virtual network through a feature named Private Link.

    You can use the private_endpoint_registration resource to set up the private link feature.

    Check the docs for more details on private link.

    Example Usage

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

const endpoint = new clickhouse.privateendpoint.Registration("endpoint", {
    cloudProvider: "aws",
    description: "Private Link from VPC foo",
    privateEndpointId: "vpce-...",
    region: "us-west-2",
});

    import pulumi
import pulumiverse_clickhouse as clickhouse

endpoint = clickhouse.private_endpoint.Registration("endpoint",
    cloud_provider="aws",
    description="Private Link from VPC foo",
    private_endpoint_id="vpce-...",
    region="us-west-2")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-clickhouse/sdk/go/clickhouse/PrivateEndpoint"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := PrivateEndpoint.NewRegistration(ctx, "endpoint", &PrivateEndpoint.RegistrationArgs{
			CloudProvider:     pulumi.String("aws"),
			Description:       pulumi.String("Private Link from VPC foo"),
			PrivateEndpointId: pulumi.String("vpce-..."),
			Region:            pulumi.String("us-west-2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Clickhouse = Pulumiverse.Clickhouse;

return await Deployment.RunAsync(() => 
{
    var endpoint = new Clickhouse.PrivateEndpoint.Registration("endpoint", new()
    {
        CloudProvider = "aws",
        Description = "Private Link from VPC foo",
        PrivateEndpointId = "vpce-...",
        Region = "us-west-2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.clickhouse.PrivateEndpoint.Registration;
import com.pulumi.clickhouse.PrivateEndpoint.RegistrationArgs;
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 endpoint = new Registration("endpoint", RegistrationArgs.builder()
            .cloudProvider("aws")
            .description("Private Link from VPC foo")
            .privateEndpointId("vpce-...")
            .region("us-west-2")
            .build());

    }
}

    resources:
  endpoint:
    type: clickhouse:PrivateEndpoint:Registration
    properties:
      cloudProvider: aws
      description: Private Link from VPC foo
      privateEndpointId: vpce-...
      region: us-west-2

    Create Registration Resource

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

    Constructor syntax

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

@overload
def Registration(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cloud_provider: Optional[str] = None,
                 private_endpoint_id: Optional[str] = None,
                 region: Optional[str] = None,
                 description: Optional[str] = None)
    func NewRegistration(ctx *Context, name string, args RegistrationArgs, opts ...ResourceOption) (*Registration, error)
    public Registration(string name, RegistrationArgs args, CustomResourceOptions? opts = null)
    public Registration(String name, RegistrationArgs args)
public Registration(String name, RegistrationArgs args, CustomResourceOptions options)

    type: clickhouse:PrivateEndpoint:Registration
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 RegistrationArgs
    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 RegistrationArgs
    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 RegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegistrationArgs
    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 registrationResource = new Clickhouse.PrivateEndpoint.Registration("registrationResource", new()
{
    CloudProvider = "string",
    PrivateEndpointId = "string",
    Region = "string",
    Description = "string",
});

    example, err := PrivateEndpoint.NewRegistration(ctx, "registrationResource", &PrivateEndpoint.RegistrationArgs{
	CloudProvider:     pulumi.String("string"),
	PrivateEndpointId: pulumi.String("string"),
	Region:            pulumi.String("string"),
	Description:       pulumi.String("string"),
})

    var registrationResource = new Registration("registrationResource", RegistrationArgs.builder()
    .cloudProvider("string")
    .privateEndpointId("string")
    .region("string")
    .description("string")
    .build());

    registration_resource = clickhouse.private_endpoint.Registration("registrationResource",
    cloud_provider="string",
    private_endpoint_id="string",
    region="string",
    description="string")

    const registrationResource = new clickhouse.privateendpoint.Registration("registrationResource", {
    cloudProvider: "string",
    privateEndpointId: "string",
    region: "string",
    description: "string",
});

    type: clickhouse:PrivateEndpoint:Registration
properties:
    cloudProvider: string
    description: string
    privateEndpointId: string
    region: string

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

    CloudProvider string
    Cloud provider of the private endpoint ID
    PrivateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    Region string
    Region of the private endpoint
    Description string
    Description of the private endpoint
    CloudProvider string
    Cloud provider of the private endpoint ID
    PrivateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    Region string
    Region of the private endpoint
    Description string
    Description of the private endpoint
    cloudProvider String
    Cloud provider of the private endpoint ID
    privateEndpointId String
    ID of the private endpoint (replaces deprecated attribute id)
    region String
    Region of the private endpoint
    description String
    Description of the private endpoint
    cloudProvider string
    Cloud provider of the private endpoint ID
    privateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    region string
    Region of the private endpoint
    description string
    Description of the private endpoint
    cloud_provider str
    Cloud provider of the private endpoint ID
    private_endpoint_id str
    ID of the private endpoint (replaces deprecated attribute id)
    region str
    Region of the private endpoint
    description str
    Description of the private endpoint
    cloudProvider String
    Cloud provider of the private endpoint ID
    privateEndpointId String
    ID of the private endpoint (replaces deprecated attribute id)
    region String
    Region of the private endpoint
    description String
    Description of the private endpoint

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Registration Resource

    Get an existing Registration 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?: RegistrationState, opts?: CustomResourceOptions): Registration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        description: Optional[str] = None,
        private_endpoint_id: Optional[str] = None,
        region: Optional[str] = None) -> Registration
    func GetRegistration(ctx *Context, name string, id IDInput, state *RegistrationState, opts ...ResourceOption) (*Registration, error)
    public static Registration Get(string name, Input<string> id, RegistrationState? state, CustomResourceOptions? opts = null)
    public static Registration get(String name, Output<String> id, RegistrationState 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:
    CloudProvider string
    Cloud provider of the private endpoint ID
    Description string
    Description of the private endpoint
    PrivateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    Region string
    Region of the private endpoint
    CloudProvider string
    Cloud provider of the private endpoint ID
    Description string
    Description of the private endpoint
    PrivateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    Region string
    Region of the private endpoint
    cloudProvider String
    Cloud provider of the private endpoint ID
    description String
    Description of the private endpoint
    privateEndpointId String
    ID of the private endpoint (replaces deprecated attribute id)
    region String
    Region of the private endpoint
    cloudProvider string
    Cloud provider of the private endpoint ID
    description string
    Description of the private endpoint
    privateEndpointId string
    ID of the private endpoint (replaces deprecated attribute id)
    region string
    Region of the private endpoint
    cloud_provider str
    Cloud provider of the private endpoint ID
    description str
    Description of the private endpoint
    private_endpoint_id str
    ID of the private endpoint (replaces deprecated attribute id)
    region str
    Region of the private endpoint
    cloudProvider String
    Cloud provider of the private endpoint ID
    description String
    Description of the private endpoint
    privateEndpointId String
    ID of the private endpoint (replaces deprecated attribute id)
    region String
    Region of the private endpoint

    Import

    Endpoint Attachments can be imported by specifying the Cloud provider private endpoint ID

    For example for AWS you could run:

    $ pulumi import clickhouse:PrivateEndpoint/registration:Registration example vpce-xxxxxx

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

    Package Details

    Repository
    clickhouse pulumiverse/pulumi-clickhouse
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the clickhouse Terraform Provider.
    clickhouse logo
    Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
    pulumiverse/pulumi-clickhouse