Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. GcpPrivatelink
Aiven v6.38.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.GcpPrivatelink

Explore with Pulumi AI

aiven logo
Aiven v6.38.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aiven

    Creates and manages a Google Private Service Connect for an Aiven service in a VPC.

    Example Usage

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

const main = new aiven.GcpPrivatelink("main", {
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
});

    import pulumi
import pulumi_aiven as aiven

main = aiven.GcpPrivatelink("main",
    project=example_project["project"],
    service_name=example_kafka["serviceName"])

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewGcpPrivatelink(ctx, "main", &aiven.GcpPrivatelinkArgs{
			Project:     pulumi.Any(exampleProject.Project),
			ServiceName: pulumi.Any(exampleKafka.ServiceName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var main = new Aiven.GcpPrivatelink("main", new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.GcpPrivatelink;
import com.pulumi.aiven.GcpPrivatelinkArgs;
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 main = new GcpPrivatelink("main", GcpPrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .build());

    }
}

    resources:
  main:
    type: aiven:GcpPrivatelink
    properties:
      project: ${exampleProject.project}
      serviceName: ${exampleKafka.serviceName}

    Create GcpPrivatelink Resource

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

    Constructor syntax

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

@overload
def GcpPrivatelink(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project: Optional[str] = None,
                   service_name: Optional[str] = None)
    func NewGcpPrivatelink(ctx *Context, name string, args GcpPrivatelinkArgs, opts ...ResourceOption) (*GcpPrivatelink, error)
    public GcpPrivatelink(string name, GcpPrivatelinkArgs args, CustomResourceOptions? opts = null)
    public GcpPrivatelink(String name, GcpPrivatelinkArgs args)
public GcpPrivatelink(String name, GcpPrivatelinkArgs args, CustomResourceOptions options)

    type: aiven:GcpPrivatelink
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 GcpPrivatelinkArgs
    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 GcpPrivatelinkArgs
    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 GcpPrivatelinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GcpPrivatelinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GcpPrivatelinkArgs
    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 gcpPrivatelinkResource = new Aiven.GcpPrivatelink("gcpPrivatelinkResource", new()
{
    Project = "string",
    ServiceName = "string",
});

    example, err := aiven.NewGcpPrivatelink(ctx, "gcpPrivatelinkResource", &aiven.GcpPrivatelinkArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
})

    var gcpPrivatelinkResource = new GcpPrivatelink("gcpPrivatelinkResource", GcpPrivatelinkArgs.builder()
    .project("string")
    .serviceName("string")
    .build());

    gcp_privatelink_resource = aiven.GcpPrivatelink("gcpPrivatelinkResource",
    project="string",
    service_name="string")

    const gcpPrivatelinkResource = new aiven.GcpPrivatelink("gcpPrivatelinkResource", {
    project: "string",
    serviceName: "string",
});

    type: aiven:GcpPrivatelink
properties:
    project: string
    serviceName: string

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

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    Outputs

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

    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Printable result of the Google Cloud Private Service Connect request.
    State string
    The state of the Private Service Connect resource.
    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Printable result of the Google Cloud Private Service Connect request.
    State string
    The state of the Private Service Connect resource.
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Printable result of the Google Cloud Private Service Connect request.
    state String
    The state of the Private Service Connect resource.
    googleServiceAttachment string
    Google Private Service Connect service attachment.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Printable result of the Google Cloud Private Service Connect request.
    state string
    The state of the Private Service Connect resource.
    google_service_attachment str
    Google Private Service Connect service attachment.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Printable result of the Google Cloud Private Service Connect request.
    state str
    The state of the Private Service Connect resource.
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Printable result of the Google Cloud Private Service Connect request.
    state String
    The state of the Private Service Connect resource.

    Look up Existing GcpPrivatelink Resource

    Get an existing GcpPrivatelink 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?: GcpPrivatelinkState, opts?: CustomResourceOptions): GcpPrivatelink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        google_service_attachment: Optional[str] = None,
        message: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        state: Optional[str] = None) -> GcpPrivatelink
    func GetGcpPrivatelink(ctx *Context, name string, id IDInput, state *GcpPrivatelinkState, opts ...ResourceOption) (*GcpPrivatelink, error)
    public static GcpPrivatelink Get(string name, Input<string> id, GcpPrivatelinkState? state, CustomResourceOptions? opts = null)
    public static GcpPrivatelink get(String name, Output<String> id, GcpPrivatelinkState state, CustomResourceOptions options)
    resources:  _:    type: aiven:GcpPrivatelink    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:
    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Message string
    Printable result of the Google Cloud Private Service Connect request.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    State string
    The state of the Private Service Connect resource.
    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Message string
    Printable result of the Google Cloud Private Service Connect request.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    State string
    The state of the Private Service Connect resource.
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    message String
    Printable result of the Google Cloud Private Service Connect request.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    state String
    The state of the Private Service Connect resource.
    googleServiceAttachment string
    Google Private Service Connect service attachment.
    message string
    Printable result of the Google Cloud Private Service Connect request.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    state string
    The state of the Private Service Connect resource.
    google_service_attachment str
    Google Private Service Connect service attachment.
    message str
    Printable result of the Google Cloud Private Service Connect request.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    state str
    The state of the Private Service Connect resource.
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    message String
    Printable result of the Google Cloud Private Service Connect request.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    state String
    The state of the Private Service Connect resource.

    Import

    $ pulumi import aiven:index/gcpPrivatelink:GcpPrivatelink main PROJECT/SERVICE_NAME

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

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.38.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aiven