1. Packages
  2. Aiven Provider
  3. API Docs
  4. getAwsPrivatelink
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The AWS Privatelink resource allows the creation and management of Aiven AWS Privatelink for a services.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Aiven.GetAwsPrivatelink.Invoke(new()
        {
            Project = data.Aiven_project.Foo.Project,
            ServiceName = aiven_kafka.Bar.Service_name,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v5/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupAwsPrivatelink(ctx, &aiven.LookupAwsPrivatelinkArgs{
    			Project:     data.Aiven_project.Foo.Project,
    			ServiceName: aiven_kafka.Bar.Service_name,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.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 foo = AivenFunctions.getAwsPrivatelink(GetAwsPrivatelinkArgs.builder()
                .project(data.aiven_project().foo().project())
                .serviceName(aiven_kafka.bar().service_name())
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const foo = aiven.getAwsPrivatelink({
        project: data.aiven_project.foo.project,
        serviceName: aiven_kafka.bar.service_name,
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    foo = aiven.get_aws_privatelink(project=data["aiven_project"]["foo"]["project"],
        service_name=aiven_kafka["bar"]["service_name"])
    
    variables:
      foo:
        fn::invoke:
          Function: aiven:getAwsPrivatelink
          Arguments:
            project: ${data.aiven_project.foo.project}
            serviceName: ${aiven_kafka.bar.service_name}
    

    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?: InvokeOptions): Output<GetAwsPrivatelinkResult>
    def get_aws_privatelink(project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAwsPrivatelinkResult
    def get_aws_privatelink_output(project: Optional[pulumi.Input[str]] = None,
                            service_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = 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 CompletableFuture<GetAwsPrivatelinkResult> getAwsPrivatelink(GetAwsPrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAwsPrivatelinkResult> getAwsPrivatelink(GetAwsPrivatelinkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getAwsPrivatelink:getAwsPrivatelink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    getAwsPrivatelink Result

    The following output properties are available:

    AwsServiceId string
    AWS service ID
    AwsServiceName string
    AWS service name
    Id string
    The provider-assigned unique ID for this managed resource.
    Principals List<string>
    List of allowed principals
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    AwsServiceId string
    AWS service ID
    AwsServiceName string
    AWS service name
    Id string
    The provider-assigned unique ID for this managed resource.
    Principals []string
    List of allowed principals
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    awsServiceId String
    AWS service ID
    awsServiceName String
    AWS service name
    id String
    The provider-assigned unique ID for this managed resource.
    principals List<String>
    List of allowed principals
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    awsServiceId string
    AWS service ID
    awsServiceName string
    AWS service name
    id string
    The provider-assigned unique ID for this managed resource.
    principals string[]
    List of allowed principals
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    aws_service_id str
    AWS service ID
    aws_service_name str
    AWS service name
    id str
    The provider-assigned unique ID for this managed resource.
    principals Sequence[str]
    List of allowed principals
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    awsServiceId String
    AWS service ID
    awsServiceName String
    AWS service name
    id String
    The provider-assigned unique ID for this managed resource.
    principals List<String>
    List of allowed principals
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v5.6.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.