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

confluentcloud.PrivateLinkAttachment

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

confluentcloud.PrivateLinkAttachment provides a Private Link Attachment resource that enables creating, editing, and deleting Private Link Attachments on Confluent Cloud.

Example Usage

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

const main = new confluentcloud.PrivateLinkAttachment("main", {
    cloud: "AWS",
    region: "us-west-2",
    displayName: "staging-platt",
    environment: {
        id: "env-3732nw",
    },
});
export const privateLinkAttachment = main;
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.PrivateLinkAttachment("main",
    cloud="AWS",
    region="us-west-2",
    display_name="staging-platt",
    environment={
        "id": "env-3732nw",
    })
pulumi.export("privateLinkAttachment", main)
Copy
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 {
		main, err := confluentcloud.NewPrivateLinkAttachment(ctx, "main", &confluentcloud.PrivateLinkAttachmentArgs{
			Cloud:       pulumi.String("AWS"),
			Region:      pulumi.String("us-west-2"),
			DisplayName: pulumi.String("staging-platt"),
			Environment: &confluentcloud.PrivateLinkAttachmentEnvironmentArgs{
				Id: pulumi.String("env-3732nw"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("privateLinkAttachment", main)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = new ConfluentCloud.PrivateLinkAttachment("main", new()
    {
        Cloud = "AWS",
        Region = "us-west-2",
        DisplayName = "staging-platt",
        Environment = new ConfluentCloud.Inputs.PrivateLinkAttachmentEnvironmentArgs
        {
            Id = "env-3732nw",
        },
    });

    return new Dictionary<string, object?>
    {
        ["privateLinkAttachment"] = main,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.PrivateLinkAttachment;
import com.pulumi.confluentcloud.PrivateLinkAttachmentArgs;
import com.pulumi.confluentcloud.inputs.PrivateLinkAttachmentEnvironmentArgs;
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 PrivateLinkAttachment("main", PrivateLinkAttachmentArgs.builder()
            .cloud("AWS")
            .region("us-west-2")
            .displayName("staging-platt")
            .environment(PrivateLinkAttachmentEnvironmentArgs.builder()
                .id("env-3732nw")
                .build())
            .build());

        ctx.export("privateLinkAttachment", main);
    }
}
Copy
resources:
  main:
    type: confluentcloud:PrivateLinkAttachment
    properties:
      cloud: AWS
      region: us-west-2
      displayName: staging-platt
      environment:
        id: env-3732nw
outputs:
  privateLinkAttachment: ${main}
Copy

Getting Started

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

  • enterprise-privatelinkattachment-aws-kafka-acls: Enterprise Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
  • enterprise-privatelinkattachment-azure-kafka-acls: Enterprise Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs

Create PrivateLinkAttachment Resource

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

Constructor syntax

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

@overload
def PrivateLinkAttachment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cloud: Optional[str] = None,
                          display_name: Optional[str] = None,
                          environment: Optional[PrivateLinkAttachmentEnvironmentArgs] = None,
                          region: Optional[str] = None)
func NewPrivateLinkAttachment(ctx *Context, name string, args PrivateLinkAttachmentArgs, opts ...ResourceOption) (*PrivateLinkAttachment, error)
public PrivateLinkAttachment(string name, PrivateLinkAttachmentArgs args, CustomResourceOptions? opts = null)
public PrivateLinkAttachment(String name, PrivateLinkAttachmentArgs args)
public PrivateLinkAttachment(String name, PrivateLinkAttachmentArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PrivateLinkAttachmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkAttachmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PrivateLinkAttachmentArgs
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 privateLinkAttachmentResource = new ConfluentCloud.PrivateLinkAttachment("privateLinkAttachmentResource", new()
{
    Cloud = "string",
    DisplayName = "string",
    Environment = new ConfluentCloud.Inputs.PrivateLinkAttachmentEnvironmentArgs
    {
        Id = "string",
    },
    Region = "string",
});
Copy
example, err := confluentcloud.NewPrivateLinkAttachment(ctx, "privateLinkAttachmentResource", &confluentcloud.PrivateLinkAttachmentArgs{
	Cloud:       pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Environment: &confluentcloud.PrivateLinkAttachmentEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	Region: pulumi.String("string"),
})
Copy
var privateLinkAttachmentResource = new PrivateLinkAttachment("privateLinkAttachmentResource", PrivateLinkAttachmentArgs.builder()
    .cloud("string")
    .displayName("string")
    .environment(PrivateLinkAttachmentEnvironmentArgs.builder()
        .id("string")
        .build())
    .region("string")
    .build());
Copy
private_link_attachment_resource = confluentcloud.PrivateLinkAttachment("privateLinkAttachmentResource",
    cloud="string",
    display_name="string",
    environment={
        "id": "string",
    },
    region="string")
Copy
const privateLinkAttachmentResource = new confluentcloud.PrivateLinkAttachment("privateLinkAttachmentResource", {
    cloud: "string",
    displayName: "string",
    environment: {
        id: "string",
    },
    region: "string",
});
Copy
type: confluentcloud:PrivateLinkAttachment
properties:
    cloud: string
    displayName: string
    environment:
        id: string
    region: string
Copy

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

Cloud
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName This property is required. string
The name of the Private Link Attachment.
Environment
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Region
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
Cloud
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName This property is required. string
The name of the Private Link Attachment.
Environment
This property is required.
Changes to this property will trigger replacement.
PrivateLinkAttachmentEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Region
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
cloud
This property is required.
Changes to this property will trigger replacement.
String
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName This property is required. String
The name of the Private Link Attachment.
environment
This property is required.
Changes to this property will trigger replacement.
PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
region
This property is required.
Changes to this property will trigger replacement.
String
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
cloud
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName This property is required. string
The name of the Private Link Attachment.
environment
This property is required.
Changes to this property will trigger replacement.
PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
region
This property is required.
Changes to this property will trigger replacement.
string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
cloud
This property is required.
Changes to this property will trigger replacement.
str
The cloud service provider that hosts the resources to access with the Private Link Attachment.
display_name This property is required. str
The name of the Private Link Attachment.
environment
This property is required.
Changes to this property will trigger replacement.
PrivateLinkAttachmentEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
region
This property is required.
Changes to this property will trigger replacement.
str
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
cloud
This property is required.
Changes to this property will trigger replacement.
String
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName This property is required. String
The name of the Private Link Attachment.
environment
This property is required.
Changes to this property will trigger replacement.
Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
region
This property is required.
Changes to this property will trigger replacement.
String
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.

Outputs

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

Aws List<Pulumi.ConfluentCloud.Outputs.PrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
Azures List<Pulumi.ConfluentCloud.Outputs.PrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Gcps List<Pulumi.ConfluentCloud.Outputs.PrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
Id string
The provider-assigned unique ID for this managed resource.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
Aws []PrivateLinkAttachmentAw
(Optional Configuration Block) supports the following:
Azures []PrivateLinkAttachmentAzure
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Gcps []PrivateLinkAttachmentGcp
(Optional Configuration Block) supports the following:
Id string
The provider-assigned unique ID for this managed resource.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<PrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
azures List<PrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
gcps List<PrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
id String
The provider-assigned unique ID for this managed resource.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws PrivateLinkAttachmentAw[]
(Optional Configuration Block) supports the following:
azures PrivateLinkAttachmentAzure[]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
dnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
gcps PrivateLinkAttachmentGcp[]
(Optional Configuration Block) supports the following:
id string
The provider-assigned unique ID for this managed resource.
resourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws Sequence[PrivateLinkAttachmentAw]
(Optional Configuration Block) supports the following:
azures Sequence[PrivateLinkAttachmentAzure]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
dns_domain str
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
gcps Sequence[PrivateLinkAttachmentGcp]
(Optional Configuration Block) supports the following:
id str
The provider-assigned unique ID for this managed resource.
resource_name str
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<Property Map>
(Optional Configuration Block) supports the following:
azures List<Property Map>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
gcps List<Property Map>
(Optional Configuration Block) supports the following:
id String
The provider-assigned unique ID for this managed resource.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.

Look up Existing PrivateLinkAttachment Resource

Get an existing PrivateLinkAttachment 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?: PrivateLinkAttachmentState, opts?: CustomResourceOptions): PrivateLinkAttachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws: Optional[Sequence[PrivateLinkAttachmentAwArgs]] = None,
        azures: Optional[Sequence[PrivateLinkAttachmentAzureArgs]] = None,
        cloud: Optional[str] = None,
        display_name: Optional[str] = None,
        dns_domain: Optional[str] = None,
        environment: Optional[PrivateLinkAttachmentEnvironmentArgs] = None,
        gcps: Optional[Sequence[PrivateLinkAttachmentGcpArgs]] = None,
        region: Optional[str] = None,
        resource_name: Optional[str] = None) -> PrivateLinkAttachment
func GetPrivateLinkAttachment(ctx *Context, name string, id IDInput, state *PrivateLinkAttachmentState, opts ...ResourceOption) (*PrivateLinkAttachment, error)
public static PrivateLinkAttachment Get(string name, Input<string> id, PrivateLinkAttachmentState? state, CustomResourceOptions? opts = null)
public static PrivateLinkAttachment get(String name, Output<String> id, PrivateLinkAttachmentState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:PrivateLinkAttachment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 List<Pulumi.ConfluentCloud.Inputs.PrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
Azures List<Pulumi.ConfluentCloud.Inputs.PrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
Cloud Changes to this property will trigger replacement. string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName string
The name of the Private Link Attachment.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Environment Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Gcps List<Pulumi.ConfluentCloud.Inputs.PrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
Region Changes to this property will trigger replacement. string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
Aws []PrivateLinkAttachmentAwArgs
(Optional Configuration Block) supports the following:
Azures []PrivateLinkAttachmentAzureArgs
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
Cloud Changes to this property will trigger replacement. string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName string
The name of the Private Link Attachment.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Environment Changes to this property will trigger replacement. PrivateLinkAttachmentEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Gcps []PrivateLinkAttachmentGcpArgs
(Optional Configuration Block) supports the following:
Region Changes to this property will trigger replacement. string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<PrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
azures List<PrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud Changes to this property will trigger replacement. String
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName String
The name of the Private Link Attachment.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment Changes to this property will trigger replacement. PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcps List<PrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
region Changes to this property will trigger replacement. String
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws PrivateLinkAttachmentAw[]
(Optional Configuration Block) supports the following:
azures PrivateLinkAttachmentAzure[]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud Changes to this property will trigger replacement. string
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName string
The name of the Private Link Attachment.
dnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment Changes to this property will trigger replacement. PrivateLinkAttachmentEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcps PrivateLinkAttachmentGcp[]
(Optional Configuration Block) supports the following:
region Changes to this property will trigger replacement. string
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws Sequence[PrivateLinkAttachmentAwArgs]
(Optional Configuration Block) supports the following:
azures Sequence[PrivateLinkAttachmentAzureArgs]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud Changes to this property will trigger replacement. str
The cloud service provider that hosts the resources to access with the Private Link Attachment.
display_name str
The name of the Private Link Attachment.
dns_domain str
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment Changes to this property will trigger replacement. PrivateLinkAttachmentEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcps Sequence[PrivateLinkAttachmentGcpArgs]
(Optional Configuration Block) supports the following:
region Changes to this property will trigger replacement. str
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resource_name str
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<Property Map>
(Optional Configuration Block) supports the following:
azures List<Property Map>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud Changes to this property will trigger replacement. String
The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName String
The name of the Private Link Attachment.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment Changes to this property will trigger replacement. Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcps List<Property Map>
(Optional Configuration Block) supports the following:
region Changes to this property will trigger replacement. String
The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.

Supporting Types

PrivateLinkAttachmentAw
, PrivateLinkAttachmentAwArgs

VpcEndpointServiceName string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
VpcEndpointServiceName string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName String
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpc_endpoint_service_name str
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName String
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.

PrivateLinkAttachmentAzure
, PrivateLinkAttachmentAzureArgs

PrivateLinkServiceAlias string
Azure PrivateLink service alias for the availability zone.
PrivateLinkServiceResourceId string
(Required String) Azure Private Link service resource id for the availability zone.
PrivateLinkServiceAlias string
Azure PrivateLink service alias for the availability zone.
PrivateLinkServiceResourceId string
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias String
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId String
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias string
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId string
(Required String) Azure Private Link service resource id for the availability zone.
private_link_service_alias str
Azure PrivateLink service alias for the availability zone.
private_link_service_resource_id str
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias String
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId String
(Required String) Azure Private Link service resource id for the availability zone.

PrivateLinkAttachmentEnvironment
, PrivateLinkAttachmentEnvironmentArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.

PrivateLinkAttachmentGcp
, PrivateLinkAttachmentGcpArgs

PrivateServiceConnectServiceAttachment string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
PrivateServiceConnectServiceAttachment string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment String
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
private_service_connect_service_attachment str
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment String
Id of a Private Service Connect Service Attachment in Confluent Cloud.

Import

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

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ pulumi import confluentcloud:index/privateLinkAttachment:PrivateLinkAttachment main env-abc123/platt-abc123
Copy

!> 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.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud