Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. PrivateLinkAccess
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.PrivateLinkAccess

Explore with Pulumi AI

confluentcloud logo
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    Example Usage

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const aws_private_link = new confluentcloud.Network("aws-private-link", {
    displayName: "AWS Private Link Network",
    cloud: "AWS",
    region: "us-east-1",
    connectionTypes: ["PRIVATELINK"],
    zones: [
        "use1-az1",
        "use1-az2",
        "use1-az6",
    ],
    environment: {
        id: development.id,
    },
});
const aws = new confluentcloud.PrivateLinkAccess("aws", {
    displayName: "AWS Private Link Access",
    aws: {
        account: "012345678901",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: aws_private_link.id,
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
aws_private_link = confluentcloud.Network("aws-private-link",
    display_name="AWS Private Link Network",
    cloud="AWS",
    region="us-east-1",
    connection_types=["PRIVATELINK"],
    zones=[
        "use1-az1",
        "use1-az2",
        "use1-az6",
    ],
    environment={
        "id": development.id,
    })
aws = confluentcloud.PrivateLinkAccess("aws",
    display_name="AWS Private Link Access",
    aws={
        "account": "012345678901",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": aws_private_link.id,
    })

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		aws_private_link, err := confluentcloud.NewNetwork(ctx, "aws-private-link", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("AWS Private Link Network"),
			Cloud:       pulumi.String("AWS"),
			Region:      pulumi.String("us-east-1"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PRIVATELINK"),
			},
			Zones: pulumi.StringArray{
				pulumi.String("use1-az1"),
				pulumi.String("use1-az2"),
				pulumi.String("use1-az6"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPrivateLinkAccess(ctx, "aws", &confluentcloud.PrivateLinkAccessArgs{
			DisplayName: pulumi.String("AWS Private Link Access"),
			Aws: &confluentcloud.PrivateLinkAccessAwsArgs{
				Account: pulumi.String("012345678901"),
			},
			Environment: &confluentcloud.PrivateLinkAccessEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PrivateLinkAccessNetworkArgs{
				Id: aws_private_link.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var aws_private_link = new ConfluentCloud.Network("aws-private-link", new()
    {
        DisplayName = "AWS Private Link Network",
        Cloud = "AWS",
        Region = "us-east-1",
        ConnectionTypes = new[]
        {
            "PRIVATELINK",
        },
        Zones = new[]
        {
            "use1-az1",
            "use1-az2",
            "use1-az6",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var aws = new ConfluentCloud.PrivateLinkAccess("aws", new()
    {
        DisplayName = "AWS Private Link Access",
        Aws = new ConfluentCloud.Inputs.PrivateLinkAccessAwsArgs
        {
            Account = "012345678901",
        },
        Environment = new ConfluentCloud.Inputs.PrivateLinkAccessEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PrivateLinkAccessNetworkArgs
        {
            Id = aws_private_link.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.PrivateLinkAccess;
import com.pulumi.confluentcloud.PrivateLinkAccessArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessAwsArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessNetworkArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var aws_private_link = new Network("aws-private-link", NetworkArgs.builder()
            .displayName("AWS Private Link Network")
            .cloud("AWS")
            .region("us-east-1")
            .connectionTypes("PRIVATELINK")
            .zones(            
                "use1-az1",
                "use1-az2",
                "use1-az6")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var aws = new PrivateLinkAccess("aws", PrivateLinkAccessArgs.builder()
            .displayName("AWS Private Link Access")
            .aws(PrivateLinkAccessAwsArgs.builder()
                .account("012345678901")
                .build())
            .environment(PrivateLinkAccessEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PrivateLinkAccessNetworkArgs.builder()
                .id(aws_private_link.id())
                .build())
            .build());

    }
}

    resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  aws-private-link:
    type: confluentcloud:Network
    properties:
      displayName: AWS Private Link Network
      cloud: AWS
      region: us-east-1
      connectionTypes:
        - PRIVATELINK
      zones:
        - use1-az1
        - use1-az2
        - use1-az6
      environment:
        id: ${development.id}
  aws:
    type: confluentcloud:PrivateLinkAccess
    properties:
      displayName: AWS Private Link Access
      aws:
        account: '012345678901'
      environment:
        id: ${development.id}
      network:
        id: ${["aws-private-link"].id}

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const azure_private_link = new confluentcloud.Network("azure-private-link", {
    displayName: "Azure Private Link Network",
    cloud: "AZURE",
    region: "centralus",
    connectionTypes: ["PRIVATELINK"],
    environment: {
        id: development.id,
    },
});
const azure = new confluentcloud.PrivateLinkAccess("azure", {
    displayName: "Azure Private Link Access",
    azure: {
        subscription: "1234abcd-12ab-34cd-1234-123456abcdef",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: azure_private_link.id,
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
azure_private_link = confluentcloud.Network("azure-private-link",
    display_name="Azure Private Link Network",
    cloud="AZURE",
    region="centralus",
    connection_types=["PRIVATELINK"],
    environment={
        "id": development.id,
    })
azure = confluentcloud.PrivateLinkAccess("azure",
    display_name="Azure Private Link Access",
    azure={
        "subscription": "1234abcd-12ab-34cd-1234-123456abcdef",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": azure_private_link.id,
    })

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		azure_private_link, err := confluentcloud.NewNetwork(ctx, "azure-private-link", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("Azure Private Link Network"),
			Cloud:       pulumi.String("AZURE"),
			Region:      pulumi.String("centralus"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PRIVATELINK"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPrivateLinkAccess(ctx, "azure", &confluentcloud.PrivateLinkAccessArgs{
			DisplayName: pulumi.String("Azure Private Link Access"),
			Azure: &confluentcloud.PrivateLinkAccessAzureArgs{
				Subscription: pulumi.String("1234abcd-12ab-34cd-1234-123456abcdef"),
			},
			Environment: &confluentcloud.PrivateLinkAccessEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PrivateLinkAccessNetworkArgs{
				Id: azure_private_link.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var azure_private_link = new ConfluentCloud.Network("azure-private-link", new()
    {
        DisplayName = "Azure Private Link Network",
        Cloud = "AZURE",
        Region = "centralus",
        ConnectionTypes = new[]
        {
            "PRIVATELINK",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var azure = new ConfluentCloud.PrivateLinkAccess("azure", new()
    {
        DisplayName = "Azure Private Link Access",
        Azure = new ConfluentCloud.Inputs.PrivateLinkAccessAzureArgs
        {
            Subscription = "1234abcd-12ab-34cd-1234-123456abcdef",
        },
        Environment = new ConfluentCloud.Inputs.PrivateLinkAccessEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PrivateLinkAccessNetworkArgs
        {
            Id = azure_private_link.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.PrivateLinkAccess;
import com.pulumi.confluentcloud.PrivateLinkAccessArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessAzureArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessNetworkArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var azure_private_link = new Network("azure-private-link", NetworkArgs.builder()
            .displayName("Azure Private Link Network")
            .cloud("AZURE")
            .region("centralus")
            .connectionTypes("PRIVATELINK")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var azure = new PrivateLinkAccess("azure", PrivateLinkAccessArgs.builder()
            .displayName("Azure Private Link Access")
            .azure(PrivateLinkAccessAzureArgs.builder()
                .subscription("1234abcd-12ab-34cd-1234-123456abcdef")
                .build())
            .environment(PrivateLinkAccessEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PrivateLinkAccessNetworkArgs.builder()
                .id(azure_private_link.id())
                .build())
            .build());

    }
}

    resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  azure-private-link:
    type: confluentcloud:Network
    properties:
      displayName: Azure Private Link Network
      cloud: AZURE
      region: centralus
      connectionTypes:
        - PRIVATELINK
      environment:
        id: ${development.id}
  azure:
    type: confluentcloud:PrivateLinkAccess
    properties:
      displayName: Azure Private Link Access
      azure:
        subscription: 1234abcd-12ab-34cd-1234-123456abcdef
      environment:
        id: ${development.id}
      network:
        id: ${["azure-private-link"].id}

    Example Private Service Connect on GCP

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const gcp_private_service_connect = new confluentcloud.Network("gcp-private-service-connect", {
    displayName: "GCP Private Service Connect Network",
    cloud: "GCP",
    region: "us-central1",
    connectionTypes: ["PRIVATELINK"],
    zones: [
        "us-central1-a",
        "us-central1-b",
        "us-central1-c",
    ],
    environment: {
        id: development.id,
    },
});
const gcp = new confluentcloud.PrivateLinkAccess("gcp", {
    displayName: "GCP Private Service Connect",
    gcp: {
        project: "temp-gear-123456",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: gcp_private_service_connect.id,
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
gcp_private_service_connect = confluentcloud.Network("gcp-private-service-connect",
    display_name="GCP Private Service Connect Network",
    cloud="GCP",
    region="us-central1",
    connection_types=["PRIVATELINK"],
    zones=[
        "us-central1-a",
        "us-central1-b",
        "us-central1-c",
    ],
    environment={
        "id": development.id,
    })
gcp = confluentcloud.PrivateLinkAccess("gcp",
    display_name="GCP Private Service Connect",
    gcp={
        "project": "temp-gear-123456",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": gcp_private_service_connect.id,
    })

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		gcp_private_service_connect, err := confluentcloud.NewNetwork(ctx, "gcp-private-service-connect", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("GCP Private Service Connect Network"),
			Cloud:       pulumi.String("GCP"),
			Region:      pulumi.String("us-central1"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PRIVATELINK"),
			},
			Zones: pulumi.StringArray{
				pulumi.String("us-central1-a"),
				pulumi.String("us-central1-b"),
				pulumi.String("us-central1-c"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPrivateLinkAccess(ctx, "gcp", &confluentcloud.PrivateLinkAccessArgs{
			DisplayName: pulumi.String("GCP Private Service Connect"),
			Gcp: &confluentcloud.PrivateLinkAccessGcpArgs{
				Project: pulumi.String("temp-gear-123456"),
			},
			Environment: &confluentcloud.PrivateLinkAccessEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PrivateLinkAccessNetworkArgs{
				Id: gcp_private_service_connect.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var gcp_private_service_connect = new ConfluentCloud.Network("gcp-private-service-connect", new()
    {
        DisplayName = "GCP Private Service Connect Network",
        Cloud = "GCP",
        Region = "us-central1",
        ConnectionTypes = new[]
        {
            "PRIVATELINK",
        },
        Zones = new[]
        {
            "us-central1-a",
            "us-central1-b",
            "us-central1-c",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var gcp = new ConfluentCloud.PrivateLinkAccess("gcp", new()
    {
        DisplayName = "GCP Private Service Connect",
        Gcp = new ConfluentCloud.Inputs.PrivateLinkAccessGcpArgs
        {
            Project = "temp-gear-123456",
        },
        Environment = new ConfluentCloud.Inputs.PrivateLinkAccessEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PrivateLinkAccessNetworkArgs
        {
            Id = gcp_private_service_connect.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.PrivateLinkAccess;
import com.pulumi.confluentcloud.PrivateLinkAccessArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessGcpArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAccessNetworkArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var gcp_private_service_connect = new Network("gcp-private-service-connect", NetworkArgs.builder()
            .displayName("GCP Private Service Connect Network")
            .cloud("GCP")
            .region("us-central1")
            .connectionTypes("PRIVATELINK")
            .zones(            
                "us-central1-a",
                "us-central1-b",
                "us-central1-c")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var gcp = new PrivateLinkAccess("gcp", PrivateLinkAccessArgs.builder()
            .displayName("GCP Private Service Connect")
            .gcp(PrivateLinkAccessGcpArgs.builder()
                .project("temp-gear-123456")
                .build())
            .environment(PrivateLinkAccessEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PrivateLinkAccessNetworkArgs.builder()
                .id(gcp_private_service_connect.id())
                .build())
            .build());

    }
}

    resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  gcp-private-service-connect:
    type: confluentcloud:Network
    properties:
      displayName: GCP Private Service Connect Network
      cloud: GCP
      region: us-central1
      connectionTypes:
        - PRIVATELINK
      zones:
        - us-central1-a
        - us-central1-b
        - us-central1-c
      environment:
        id: ${development.id}
  gcp:
    type: confluentcloud:PrivateLinkAccess
    properties:
      displayName: GCP Private Service Connect
      gcp:
        project: temp-gear-123456
      environment:
        id: ${development.id}
      network:
        id: ${["gcp-private-service-connect"].id}

    Getting Started

    The following end-to-end examples might help to get started with confluentcloud.PrivateLinkAccess resource:

    • dedicated-privatelink-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
    • dedicated-privatelink-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBAC
    • dedicated-privatelink-azure-kafka-rbac: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBAC
    • dedicated-privatelink-azure-kafka-acls: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs
    • dedicated-private-service-connect-gcp-kafka-acls: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLs
    • dedicated-private-service-connect-gcp-kafka-rbac: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBAC

    Create PrivateLinkAccess Resource

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

    Constructor syntax

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

@overload
def PrivateLinkAccess(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      environment: Optional[PrivateLinkAccessEnvironmentArgs] = None,
                      network: Optional[PrivateLinkAccessNetworkArgs] = None,
                      aws: Optional[PrivateLinkAccessAwsArgs] = None,
                      azure: Optional[PrivateLinkAccessAzureArgs] = None,
                      display_name: Optional[str] = None,
                      gcp: Optional[PrivateLinkAccessGcpArgs] = None)
    func NewPrivateLinkAccess(ctx *Context, name string, args PrivateLinkAccessArgs, opts ...ResourceOption) (*PrivateLinkAccess, error)
    public PrivateLinkAccess(string name, PrivateLinkAccessArgs args, CustomResourceOptions? opts = null)
    public PrivateLinkAccess(String name, PrivateLinkAccessArgs args)
public PrivateLinkAccess(String name, PrivateLinkAccessArgs args, CustomResourceOptions options)

    type: confluentcloud:PrivateLinkAccess
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 PrivateLinkAccessArgs
    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 PrivateLinkAccessArgs
    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 PrivateLinkAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkAccessArgs
    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 privateLinkAccessResource = new ConfluentCloud.PrivateLinkAccess("privateLinkAccessResource", new()
{
    Environment = new ConfluentCloud.Inputs.PrivateLinkAccessEnvironmentArgs
    {
        Id = "string",
    },
    Network = new ConfluentCloud.Inputs.PrivateLinkAccessNetworkArgs
    {
        Id = "string",
    },
    Aws = new ConfluentCloud.Inputs.PrivateLinkAccessAwsArgs
    {
        Account = "string",
    },
    Azure = new ConfluentCloud.Inputs.PrivateLinkAccessAzureArgs
    {
        Subscription = "string",
    },
    DisplayName = "string",
    Gcp = new ConfluentCloud.Inputs.PrivateLinkAccessGcpArgs
    {
        Project = "string",
    },
});

    example, err := confluentcloud.NewPrivateLinkAccess(ctx, "privateLinkAccessResource", &confluentcloud.PrivateLinkAccessArgs{
	Environment: &confluentcloud.PrivateLinkAccessEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	Network: &confluentcloud.PrivateLinkAccessNetworkArgs{
		Id: pulumi.String("string"),
	},
	Aws: &confluentcloud.PrivateLinkAccessAwsArgs{
		Account: pulumi.String("string"),
	},
	Azure: &confluentcloud.PrivateLinkAccessAzureArgs{
		Subscription: pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Gcp: &confluentcloud.PrivateLinkAccessGcpArgs{
		Project: pulumi.String("string"),
	},
})

    var privateLinkAccessResource = new PrivateLinkAccess("privateLinkAccessResource", PrivateLinkAccessArgs.builder()
    .environment(PrivateLinkAccessEnvironmentArgs.builder()
        .id("string")
        .build())
    .network(PrivateLinkAccessNetworkArgs.builder()
        .id("string")
        .build())
    .aws(PrivateLinkAccessAwsArgs.builder()
        .account("string")
        .build())
    .azure(PrivateLinkAccessAzureArgs.builder()
        .subscription("string")
        .build())
    .displayName("string")
    .gcp(PrivateLinkAccessGcpArgs.builder()
        .project("string")
        .build())
    .build());

    private_link_access_resource = confluentcloud.PrivateLinkAccess("privateLinkAccessResource",
    environment={
        "id": "string",
    },
    network={
        "id": "string",
    },
    aws={
        "account": "string",
    },
    azure={
        "subscription": "string",
    },
    display_name="string",
    gcp={
        "project": "string",
    })

    const privateLinkAccessResource = new confluentcloud.PrivateLinkAccess("privateLinkAccessResource", {
    environment: {
        id: "string",
    },
    network: {
        id: "string",
    },
    aws: {
        account: "string",
    },
    azure: {
        subscription: "string",
    },
    displayName: "string",
    gcp: {
        project: "string",
    },
});

    type: confluentcloud:PrivateLinkAccess
properties:
    aws:
        account: string
    azure:
        subscription: string
    displayName: string
    environment:
        id: string
    gcp:
        project: string
    network:
        id: string

    PrivateLinkAccess 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 PrivateLinkAccess resource accepts the following input properties:

    Environment Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Network Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    Aws Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessAws
    Azure Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessAzure
    DisplayName string
    The name of the Private Link Access.
    Gcp Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessGcp
    Environment PrivateLinkAccessEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Network PrivateLinkAccessNetworkArgs
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    Aws PrivateLinkAccessAwsArgs
    Azure PrivateLinkAccessAzureArgs
    DisplayName string
    The name of the Private Link Access.
    Gcp PrivateLinkAccessGcpArgs
    environment PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    network PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAws
    azure PrivateLinkAccessAzure
    displayName String
    The name of the Private Link Access.
    gcp PrivateLinkAccessGcp
    environment PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    network PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAws
    azure PrivateLinkAccessAzure
    displayName string
    The name of the Private Link Access.
    gcp PrivateLinkAccessGcp
    environment PrivateLinkAccessEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    network PrivateLinkAccessNetworkArgs
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAwsArgs
    azure PrivateLinkAccessAzureArgs
    display_name str
    The name of the Private Link Access.
    gcp PrivateLinkAccessGcpArgs
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    network Property Map
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws Property Map
    azure Property Map
    displayName String
    The name of the Private Link Access.
    gcp Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PrivateLinkAccess Resource

    Get an existing PrivateLinkAccess 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?: PrivateLinkAccessState, opts?: CustomResourceOptions): PrivateLinkAccess
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws: Optional[PrivateLinkAccessAwsArgs] = None,
        azure: Optional[PrivateLinkAccessAzureArgs] = None,
        display_name: Optional[str] = None,
        environment: Optional[PrivateLinkAccessEnvironmentArgs] = None,
        gcp: Optional[PrivateLinkAccessGcpArgs] = None,
        network: Optional[PrivateLinkAccessNetworkArgs] = None) -> PrivateLinkAccess
    func GetPrivateLinkAccess(ctx *Context, name string, id IDInput, state *PrivateLinkAccessState, opts ...ResourceOption) (*PrivateLinkAccess, error)
    public static PrivateLinkAccess Get(string name, Input<string> id, PrivateLinkAccessState? state, CustomResourceOptions? opts = null)
    public static PrivateLinkAccess get(String name, Output<String> id, PrivateLinkAccessState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:PrivateLinkAccess    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:
    Aws Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessAws
    Azure Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessAzure
    DisplayName string
    The name of the Private Link Access.
    Environment Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gcp Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessGcp
    Network Pulumi.ConfluentCloud.Inputs.PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    Aws PrivateLinkAccessAwsArgs
    Azure PrivateLinkAccessAzureArgs
    DisplayName string
    The name of the Private Link Access.
    Environment PrivateLinkAccessEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gcp PrivateLinkAccessGcpArgs
    Network PrivateLinkAccessNetworkArgs
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAws
    azure PrivateLinkAccessAzure
    displayName String
    The name of the Private Link Access.
    environment PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gcp PrivateLinkAccessGcp
    network PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAws
    azure PrivateLinkAccessAzure
    displayName string
    The name of the Private Link Access.
    environment PrivateLinkAccessEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gcp PrivateLinkAccessGcp
    network PrivateLinkAccessNetwork
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws PrivateLinkAccessAwsArgs
    azure PrivateLinkAccessAzureArgs
    display_name str
    The name of the Private Link Access.
    environment PrivateLinkAccessEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gcp PrivateLinkAccessGcpArgs
    network PrivateLinkAccessNetworkArgs
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
    aws Property Map
    azure Property Map
    displayName String
    The name of the Private Link Access.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gcp Property Map
    network Property Map
    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Supporting Types

    PrivateLinkAccessAws, PrivateLinkAccessAwsArgs

    Account string
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.
    Account string
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.
    account String
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.
    account string
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.
    account str
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.
    account String
    The AWS account ID to enable for the Private Link Access. You can find your AWS account ID [here] (https://console.aws.amazon.com/billing/home?#/account) under My Account in your AWS Management Console. Must be a 12 character string.

    PrivateLinkAccessAzure, PrivateLinkAccessAzureArgs

    Subscription string
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.
    Subscription string
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.
    subscription String
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.
    subscription string
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.
    subscription str
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.
    subscription String
    The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your [Microsoft Azure Portal] (https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). Must be a valid 32 character UUID string.

    PrivateLinkAccessEnvironment, PrivateLinkAccessEnvironmentArgs

    Id string
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.
    Id string
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.
    id string
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.
    id str
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Private Link Access belongs to, for example, env-abc123.

    PrivateLinkAccessGcp, PrivateLinkAccessGcpArgs

    Project string

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    Project string

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    project String

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    project string

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    project str

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    project String

    The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    Note: Exactly one from the aws, azure, gcp configuration blocks must be specified.

    Note: Learn more about Private Link Access limitations on AWS here.

    Note: Learn more about Private Link Access limitations on Azure here.

    PrivateLinkAccessNetwork, PrivateLinkAccessNetworkArgs

    Id string
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    Id string
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    id String
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    id string
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    id str
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    id String
    The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

    Import

    You can import a Private Link Access by using Environment ID and Private Link Access ID, in the format <Environment ID>/<Private Link Access ID>. The following example shows how to import a Private Link Access:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/privateLinkAccess:PrivateLinkAccess my_pla env-abc123/pla-abc123

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
    pulumi/pulumi-confluentcloud