1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getGcpPrivatelink
Viewing docs for Aiven v6.62.0
published on Thursday, Oct 22, 2026 by Pulumi
aiven logo aiven logo
Viewing docs for Aiven v6.62.0
published on Thursday, Oct 22, 2026 by Pulumi

    Gets information about a Google Private Service Connect connection for an Aiven service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = aiven.getGcpPrivatelink({
        project: "my-project",
        serviceName: "foo",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.get_gcp_privatelink(project="my-project",
        service_name="foo")
    
    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.GetGcpPrivatelink(ctx, &aiven.LookupGcpPrivatelinkArgs{
    			Project:     "my-project",
    			ServiceName: "foo",
    		}, nil)
    		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 example = Aiven.GetGcpPrivatelink.Invoke(new()
        {
            Project = "my-project",
            ServiceName = "foo",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.AivenFunctions;
    import com.pulumi.aiven.inputs.GetGcpPrivatelinkArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = AivenFunctions.getGcpPrivatelink(GetGcpPrivatelinkArgs.builder()
                .project("my-project")
                .serviceName("foo")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aiven:getGcpPrivatelink
          arguments:
            project: my-project
            serviceName: foo
    
    terraform {
      required_providers {
        aiven = {
          source = "pulumi/aiven"
        }
      }
    }
    
    data "aiven_gcp_privatelink" "example" {
      project      = "my-project"
      service_name = "foo"
    }
    

    Using getGcpPrivatelink

    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.

    function getGcpPrivatelink(args: GetGcpPrivatelinkArgs, opts?: InvokeOptions): Promise<GetGcpPrivatelinkResult>
    function getGcpPrivatelinkOutput(args: GetGcpPrivatelinkOutputArgs, opts?: InvokeOutputOptions): Output<GetGcpPrivatelinkResult>
    def get_gcp_privatelink(project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            timeouts: Optional[GetGcpPrivatelinkTimeouts] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGcpPrivatelinkResult
    def get_gcp_privatelink_output(project: pulumi.Input[Optional[str]] = None,
                            service_name: pulumi.Input[Optional[str]] = None,
                            timeouts: pulumi.Input[Optional[GetGcpPrivatelinkTimeoutsArgs]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetGcpPrivatelinkResult]
    func LookupGcpPrivatelink(ctx *Context, args *LookupGcpPrivatelinkArgs, opts ...InvokeOption) (*LookupGcpPrivatelinkResult, error)
    func LookupGcpPrivatelinkOutput(ctx *Context, args *LookupGcpPrivatelinkOutputArgs, opts ...InvokeOption) LookupGcpPrivatelinkResultOutput

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

    public static class GetGcpPrivatelink 
    {
        public static Task<GetGcpPrivatelinkResult> InvokeAsync(GetGcpPrivatelinkArgs args, InvokeOptions? opts = null)
        public static Output<GetGcpPrivatelinkResult> Invoke(GetGcpPrivatelinkInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetGcpPrivatelinkResult> Invoke(GetGcpPrivatelinkInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetGcpPrivatelinkResult> getGcpPrivatelink(GetGcpPrivatelinkArgs args, InvokeOptions options)
    public static Output<GetGcpPrivatelinkResult> getGcpPrivatelink(GetGcpPrivatelinkArgs args, InvokeOptions options)
    public static Output<GetGcpPrivatelinkResult> getGcpPrivatelink(GetGcpPrivatelinkArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aiven:index/getGcpPrivatelink:getGcpPrivatelink
      arguments:
        # arguments dictionary
    data "aiven_get_gcp_privatelink" "name" {
        # arguments
    }

    The following arguments are supported:

    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetGcpPrivatelinkTimeouts
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetGcpPrivatelinkTimeouts
    project string
    Project name.
    service_name string
    Service name.
    timeouts object
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetGcpPrivatelinkTimeouts
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetGcpPrivatelinkTimeouts
    project str
    Project name.
    service_name str
    Service name.
    timeouts GetGcpPrivatelinkTimeouts
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map

    getGcpPrivatelink Result

    The following output properties are available:

    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Id string
    Resource ID composed as: project/service_name.
    Message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    Timeouts GetGcpPrivatelinkTimeouts
    GoogleServiceAttachment string
    Google Private Service Connect service attachment.
    Id string
    Resource ID composed as: project/service_name.
    Message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    Timeouts GetGcpPrivatelinkTimeouts
    google_service_attachment string
    Google Private Service Connect service attachment.
    id string
    Resource ID composed as: project/service_name.
    message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project string
    Project name.
    service_name string
    Service name.
    state string
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    timeouts object
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    id String
    Resource ID composed as: project/service_name.
    message String
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project String
    Project name.
    serviceName String
    Service name.
    state String
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    timeouts GetGcpPrivatelinkTimeouts
    googleServiceAttachment string
    Google Private Service Connect service attachment.
    id string
    Resource ID composed as: project/service_name.
    message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project string
    Project name.
    serviceName string
    Service name.
    state string
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    timeouts GetGcpPrivatelinkTimeouts
    google_service_attachment str
    Google Private Service Connect service attachment.
    id str
    Resource ID composed as: project/service_name.
    message str
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project str
    Project name.
    service_name str
    Service name.
    state str
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    timeouts GetGcpPrivatelinkTimeouts
    googleServiceAttachment String
    Google Private Service Connect service attachment.
    id String
    Resource ID composed as: project/service_name.
    message String
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project String
    Project name.
    serviceName String
    Service name.
    state String
    The state of the Private Service Connect resource. The possible values are active, creating and deleting.
    timeouts Property Map

    Supporting Types

    GetGcpPrivatelinkTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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 logo
    Viewing docs for Aiven v6.62.0
    published on Thursday, Oct 22, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial