Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. AwsPrivatelink
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.AwsPrivatelink

Explore with Pulumi AI

aiven logo
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

    Creates and manages an AWS PrivateLink for Aiven services in a VPC.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const main = new aiven.AwsPrivatelink("main", {
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
    principals: ["arn:aws:iam::012345678901:user/mwf"],
});

    import pulumi
import pulumi_aiven as aiven

main = aiven.AwsPrivatelink("main",
    project=example_project["project"],
    service_name=example_kafka["serviceName"],
    principals=["arn:aws:iam::012345678901:user/mwf"])

    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.NewAwsPrivatelink(ctx, "main", &aiven.AwsPrivatelinkArgs{
			Project:     pulumi.Any(exampleProject.Project),
			ServiceName: pulumi.Any(exampleKafka.ServiceName),
			Principals: pulumi.StringArray{
				pulumi.String("arn:aws:iam::012345678901:user/mwf"),
			},
		})
		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 = new Aiven.AwsPrivatelink("main", new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
        Principals = new[]
        {
            "arn:aws:iam::012345678901:user/mwf",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AwsPrivatelink;
import com.pulumi.aiven.AwsPrivatelinkArgs;
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) {
        var main = new AwsPrivatelink("main", AwsPrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .principals("arn:aws:iam::012345678901:user/mwf")
            .build());

    }
}

    resources:
  main:
    type: aiven:AwsPrivatelink
    properties:
      project: ${exampleProject.project}
      serviceName: ${exampleKafka.serviceName}
      principals:
        - arn:aws:iam::012345678901:user/mwf

    Create AwsPrivatelink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AwsPrivatelink(name: string, args: AwsPrivatelinkArgs, opts?: CustomResourceOptions);
    @overload
def AwsPrivatelink(resource_name: str,
                   args: AwsPrivatelinkArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def AwsPrivatelink(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   principals: Optional[Sequence[str]] = None,
                   project: Optional[str] = None,
                   service_name: Optional[str] = None)
    func NewAwsPrivatelink(ctx *Context, name string, args AwsPrivatelinkArgs, opts ...ResourceOption) (*AwsPrivatelink, error)
    public AwsPrivatelink(string name, AwsPrivatelinkArgs args, CustomResourceOptions? opts = null)
    public AwsPrivatelink(String name, AwsPrivatelinkArgs args)
public AwsPrivatelink(String name, AwsPrivatelinkArgs args, CustomResourceOptions options)

    type: aiven:AwsPrivatelink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AwsPrivatelinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AwsPrivatelinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AwsPrivatelinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsPrivatelinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsPrivatelinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsPrivatelinkResource = new Aiven.AwsPrivatelink("awsPrivatelinkResource", new()
{
    Principals = new[]
    {
        "string",
    },
    Project = "string",
    ServiceName = "string",
});

    example, err := aiven.NewAwsPrivatelink(ctx, "awsPrivatelinkResource", &aiven.AwsPrivatelinkArgs{
	Principals: pulumi.StringArray{
		pulumi.String("string"),
	},
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
})

    var awsPrivatelinkResource = new AwsPrivatelink("awsPrivatelinkResource", AwsPrivatelinkArgs.builder()
    .principals("string")
    .project("string")
    .serviceName("string")
    .build());

    aws_privatelink_resource = aiven.AwsPrivatelink("awsPrivatelinkResource",
    principals=["string"],
    project="string",
    service_name="string")

    const awsPrivatelinkResource = new aiven.AwsPrivatelink("awsPrivatelinkResource", {
    principals: ["string"],
    project: "string",
    serviceName: "string",
});

    type: aiven:AwsPrivatelink
properties:
    principals:
        - string
    project: string
    serviceName: string

    AwsPrivatelink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AwsPrivatelink resource accepts the following input properties:

    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.
    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.
    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.
    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.
    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.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AwsPrivatelink resource produces the following output properties:

    AwsServiceId string
    AWS service ID.
    AwsServiceName string
    AWS service name.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsServiceId string
    AWS service ID.
    AwsServiceName string
    AWS service name.
    Id string
    The provider-assigned unique ID for this managed resource.
    awsServiceId String
    AWS service ID.
    awsServiceName String
    AWS service name.
    id String
    The provider-assigned unique ID for this managed resource.
    awsServiceId string
    AWS service ID.
    awsServiceName string
    AWS service name.
    id string
    The provider-assigned unique ID for this managed 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.
    awsServiceId String
    AWS service ID.
    awsServiceName String
    AWS service name.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AwsPrivatelink Resource

    Get an existing AwsPrivatelink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AwsPrivatelinkState, opts?: CustomResourceOptions): AwsPrivatelink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_service_id: Optional[str] = None,
        aws_service_name: Optional[str] = None,
        principals: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None) -> AwsPrivatelink
    func GetAwsPrivatelink(ctx *Context, name string, id IDInput, state *AwsPrivatelinkState, opts ...ResourceOption) (*AwsPrivatelink, error)
    public static AwsPrivatelink Get(string name, Input<string> id, AwsPrivatelinkState? state, CustomResourceOptions? opts = null)
    public static AwsPrivatelink get(String name, Output<String> id, AwsPrivatelinkState state, CustomResourceOptions options)
    resources:  _:    type: aiven:AwsPrivatelink    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsServiceId string
    AWS service ID.
    AwsServiceName string
    AWS service name.
    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.
    AwsServiceId string
    AWS service ID.
    AwsServiceName string
    AWS service name.
    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.
    awsServiceId String
    AWS service ID.
    awsServiceName String
    AWS service name.
    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.
    awsServiceId string
    AWS service ID.
    awsServiceName string
    AWS service name.
    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_id str
    AWS service ID.
    aws_service_name str
    AWS service name.
    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.
    awsServiceId String
    AWS service ID.
    awsServiceName String
    AWS service name.
    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.

    Import

    $ pulumi import aiven:index/awsPrivatelink:AwsPrivatelink main PROJECT/SERVICE_NAME

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
    pulumi/pulumi-aiven