1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getAwsPrivatelink
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 an AWS PrivateLink connection for an Aiven service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = aiven.getAwsPrivatelink({
        project: "my-project",
        serviceName: "foo",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.get_aws_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.GetAwsPrivatelink(ctx, &aiven.LookupAwsPrivatelinkArgs{
    			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.GetAwsPrivatelink.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.GetAwsPrivatelinkArgs;
    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.getAwsPrivatelink(GetAwsPrivatelinkArgs.builder()
                .project("my-project")
                .serviceName("foo")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aiven:getAwsPrivatelink
          arguments:
            project: my-project
            serviceName: foo
    
    terraform {
      required_providers {
        aiven = {
          source = "pulumi/aiven"
        }
      }
    }
    
    data "aiven_aws_privatelink" "example" {
      project      = "my-project"
      service_name = "foo"
    }
    

    Using getAwsPrivatelink

    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 getAwsPrivatelink(args: GetAwsPrivatelinkArgs, opts?: InvokeOptions): Promise<GetAwsPrivatelinkResult>
    function getAwsPrivatelinkOutput(args: GetAwsPrivatelinkOutputArgs, opts?: InvokeOutputOptions): Output<GetAwsPrivatelinkResult>
    def get_aws_privatelink(project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            timeouts: Optional[GetAwsPrivatelinkTimeouts] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAwsPrivatelinkResult
    def get_aws_privatelink_output(project: pulumi.Input[Optional[str]] = None,
                            service_name: pulumi.Input[Optional[str]] = None,
                            timeouts: pulumi.Input[Optional[GetAwsPrivatelinkTimeoutsArgs]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetAwsPrivatelinkResult]
    func LookupAwsPrivatelink(ctx *Context, args *LookupAwsPrivatelinkArgs, opts ...InvokeOption) (*LookupAwsPrivatelinkResult, error)
    func LookupAwsPrivatelinkOutput(ctx *Context, args *LookupAwsPrivatelinkOutputArgs, opts ...InvokeOption) LookupAwsPrivatelinkResultOutput

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

    public static class GetAwsPrivatelink 
    {
        public static Task<GetAwsPrivatelinkResult> InvokeAsync(GetAwsPrivatelinkArgs args, InvokeOptions? opts = null)
        public static Output<GetAwsPrivatelinkResult> Invoke(GetAwsPrivatelinkInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAwsPrivatelinkResult> Invoke(GetAwsPrivatelinkInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAwsPrivatelinkResult> getAwsPrivatelink(GetAwsPrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAwsPrivatelinkResult> getAwsPrivatelink(GetAwsPrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAwsPrivatelinkResult> getAwsPrivatelink(GetAwsPrivatelinkArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aiven:index/getAwsPrivatelink:getAwsPrivatelink
      arguments:
        # arguments dictionary
    data "aiven_get_aws_privatelink" "name" {
        # arguments
    }

    The following arguments are supported:

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

    getAwsPrivatelink Result

    The following output properties are available:

    AwsServiceId string
    AWS VPC endpoint service ID.
    AwsServiceName string
    AWS VPC endpoint service name.
    Id string
    Resource ID composed as: project/service_name.
    Principals List<string>
    ARNs of principals allowed connecting to the service.
    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    Privatelink resource state. The possible values are active, creating and deleting.
    SupportedRegions List<string>
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    Timeouts GetAwsPrivatelinkTimeouts
    AwsServiceId string
    AWS VPC endpoint service ID.
    AwsServiceName string
    AWS VPC endpoint service name.
    Id string
    Resource ID composed as: project/service_name.
    Principals []string
    ARNs of principals allowed connecting to the service.
    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    Privatelink resource state. The possible values are active, creating and deleting.
    SupportedRegions []string
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    Timeouts GetAwsPrivatelinkTimeouts
    aws_service_id string
    AWS VPC endpoint service ID.
    aws_service_name string
    AWS VPC endpoint service name.
    id string
    Resource ID composed as: project/service_name.
    principals list(string)
    ARNs of principals allowed connecting to the service.
    project string
    Project name.
    service_name string
    Service name.
    state string
    Privatelink resource state. The possible values are active, creating and deleting.
    supported_regions list(string)
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    timeouts object
    awsServiceId String
    AWS VPC endpoint service ID.
    awsServiceName String
    AWS VPC endpoint service name.
    id String
    Resource ID composed as: project/service_name.
    principals List<String>
    ARNs of principals allowed connecting to the service.
    project String
    Project name.
    serviceName String
    Service name.
    state String
    Privatelink resource state. The possible values are active, creating and deleting.
    supportedRegions List<String>
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    timeouts GetAwsPrivatelinkTimeouts
    awsServiceId string
    AWS VPC endpoint service ID.
    awsServiceName string
    AWS VPC endpoint service name.
    id string
    Resource ID composed as: project/service_name.
    principals string[]
    ARNs of principals allowed connecting to the service.
    project string
    Project name.
    serviceName string
    Service name.
    state string
    Privatelink resource state. The possible values are active, creating and deleting.
    supportedRegions string[]
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    timeouts GetAwsPrivatelinkTimeouts
    aws_service_id str
    AWS VPC endpoint service ID.
    aws_service_name str
    AWS VPC endpoint service name.
    id str
    Resource ID composed as: project/service_name.
    principals Sequence[str]
    ARNs of principals allowed connecting to the service.
    project str
    Project name.
    service_name str
    Service name.
    state str
    Privatelink resource state. The possible values are active, creating and deleting.
    supported_regions Sequence[str]
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    timeouts GetAwsPrivatelinkTimeouts
    awsServiceId String
    AWS VPC endpoint service ID.
    awsServiceName String
    AWS VPC endpoint service name.
    id String
    Resource ID composed as: project/service_name.
    principals List<String>
    ARNs of principals allowed connecting to the service.
    project String
    Project name.
    serviceName String
    Service name.
    state String
    Privatelink resource state. The possible values are active, creating and deleting.
    supportedRegions List<String>
    Allow new connections to the endpoint from these regions, in addition to the region the endpoint is in.
    timeouts Property Map

    Supporting Types

    GetAwsPrivatelinkTimeouts

    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