confluentcloud.PrivateLinkAccess (v0)

Confluent v0.1.0 (0.x), Mar 9 26

Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-confluentcloud

Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-confluentcloud

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.

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)

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",
});

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"),
})

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")
    .build());

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

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

type: confluentcloud:PrivateLinkAccess
properties:
    aws:
        account: string
    azure:
        subscription: string
    displayName: string
    environment:
        id: 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.

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.

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.

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.

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.

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.

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

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.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.

Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-confluentcloud

confluentcloud.PrivateLinkAccess

On this page

On this page

Import

Create PrivateLinkAccess Resource

Constructor syntax

Parameters

Constructor example

PrivateLinkAccess Resource Properties

Inputs

Outputs

Look up Existing PrivateLinkAccess Resource

Supporting Types

PrivateLinkAccessAws, PrivateLinkAccessAwsArgs

PrivateLinkAccessAzure, PrivateLinkAccessAzureArgs

PrivateLinkAccessEnvironment, PrivateLinkAccessEnvironmentArgs

PrivateLinkAccessNetwork, PrivateLinkAccessNetworkArgs

Package Details

On this page

On this page