1. Packages
  2. Aiven Provider
  3. API Docs
  4. getGcpPrivatelink
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi

aiven.getGcpPrivatelink

Explore with Pulumi AI

Aiven v6.36.0 published on Thursday, Mar 13, 2025 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 main = aiven.getGcpPrivatelink({
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
});
Copy
import pulumi
import pulumi_aiven as aiven

main = aiven.get_gcp_privatelink(project=example_project["project"],
    service_name=example_kafka["serviceName"])
Copy
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.LookupGcpPrivatelink(ctx, &aiven.LookupGcpPrivatelinkArgs{
			Project:     exampleProject.Project,
			ServiceName: exampleKafka.ServiceName,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

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

});
Copy
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.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 main = AivenFunctions.getGcpPrivatelink(GetGcpPrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .build());

    }
}
Copy
variables:
  main:
    fn::invoke:
      function: aiven:getGcpPrivatelink
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleKafka.serviceName}
Copy

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?: InvokeOptions): Output<GetGcpPrivatelinkResult>
Copy
def get_gcp_privatelink(project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetGcpPrivatelinkResult
def get_gcp_privatelink_output(project: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetGcpPrivatelinkResult]
Copy
func LookupGcpPrivatelink(ctx *Context, args *LookupGcpPrivatelinkArgs, opts ...InvokeOption) (*LookupGcpPrivatelinkResult, error)
func LookupGcpPrivatelinkOutput(ctx *Context, args *LookupGcpPrivatelinkOutputArgs, opts ...InvokeOption) LookupGcpPrivatelinkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGcpPrivatelinkResult> getGcpPrivatelink(GetGcpPrivatelinkArgs args, InvokeOptions options)
public static Output<GetGcpPrivatelinkResult> getGcpPrivatelink(GetGcpPrivatelinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aiven:index/getGcpPrivatelink:getGcpPrivatelink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Project This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

getGcpPrivatelink Result

The following output properties are available:

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.
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.
Id string
The provider-assigned unique ID for this managed resource.
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.
id String
The provider-assigned unique ID for this managed resource.
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.
id string
The provider-assigned unique ID for this managed resource.
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.
id str
The provider-assigned unique ID for this managed resource.
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.
id String
The provider-assigned unique ID for this managed resource.
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.

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi