Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
aiven.getAwsPrivatelink
Explore with Pulumi AI
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 main = aiven.getAwsPrivatelink({
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
});
import pulumi
import pulumi_aiven as aiven
main = aiven.get_aws_privatelink(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.LookupAwsPrivatelink(ctx, &aiven.LookupAwsPrivatelinkArgs{
			Project:     exampleProject.Project,
			ServiceName: exampleKafka.ServiceName,
		}, 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 main = Aiven.GetAwsPrivatelink.Invoke(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.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 main = AivenFunctions.getAwsPrivatelink(GetAwsPrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .build());
    }
}
variables:
  main:
    fn::invoke:
      function: aiven:getAwsPrivatelink
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleKafka.serviceName}
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 dictionaryThe following arguments are supported:
- 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.
getAwsPrivatelink Result
The following output properties are available:
- AwsService stringId 
- AWS service ID.
- AwsService stringName 
- AWS service name.
- Id string
- The provider-assigned unique ID for this managed resource.
- Principals List<string>
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
- AwsService stringId 
- AWS service ID.
- AwsService stringName 
- AWS service name.
- Id string
- The provider-assigned unique ID for this managed resource.
- Principals []string
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
- awsService StringId 
- AWS service ID.
- awsService StringName 
- AWS service name.
- id String
- The provider-assigned unique ID for this managed resource.
- principals List<String>
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
- awsService stringId 
- AWS service ID.
- awsService stringName 
- AWS service name.
- id string
- The provider-assigned unique ID for this managed resource.
- principals string[]
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
- aws_service_ strid 
- AWS service ID.
- aws_service_ strname 
- AWS service name.
- id str
- The provider-assigned unique ID for this managed resource.
- principals Sequence[str]
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
- awsService StringId 
- AWS service ID.
- awsService StringName 
- AWS service name.
- id String
- The provider-assigned unique ID for this managed resource.
- principals List<String>
- List of the ARNs of the AWS accounts or IAM users allowed to connect to the VPC endpoint.
- 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.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the aivenTerraform Provider.