← All packages

Confluent Cloud

Pulumi Official
Package maintained by Pulumi
v1.0.0 published on Wednesday, Jul 20, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Confluent Cloud
  3. Confluent
  4. getPrivateLinkAccess

getPrivateLinkAccess

confluentcloud.PrivateLinkAccess describes a Network data source.

Example Usage

using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleUsingIdPrivateLinkAccess = Output.Create(ConfluentCloud.GetPrivateLinkAccess.InvokeAsync(new ConfluentCloud.GetPrivateLinkAccessArgs
        {
            Id = "pla-abc123",
            Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentArgs
            {
                Id = "env-xyz456",
            },
        }));
        this.ExampleUsingId = exampleUsingIdPrivateLinkAccess;
        var exampleUsingNamePrivateLinkAccess = Output.Create(ConfluentCloud.GetPrivateLinkAccess.InvokeAsync(new ConfluentCloud.GetPrivateLinkAccessArgs
        {
            DisplayName = "my_pla",
            Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentArgs
            {
                Id = "env-xyz456",
            },
        }));
        this.ExampleUsingName = exampleUsingNamePrivateLinkAccess;
    }

    [Output("exampleUsingId")]
    public Output<string> ExampleUsingId { get; set; }
    [Output("exampleUsingName")]
    public Output<string> ExampleUsingName { get; set; }
}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleUsingIdPrivateLinkAccess, err := confluentcloud.LookupPrivateLinkAccess(ctx, &GetPrivateLinkAccessArgs{
			Id: pulumi.StringRef("pla-abc123"),
			Environment: GetPrivateLinkAccessEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingId", exampleUsingIdPrivateLinkAccess)
		exampleUsingNamePrivateLinkAccess, err := confluentcloud.LookupPrivateLinkAccess(ctx, &GetPrivateLinkAccessArgs{
			DisplayName: pulumi.StringRef("my_pla"),
			Environment: GetPrivateLinkAccessEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingNamePrivateLinkAccess)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetPrivateLinkAccessArgs;
import com.pulumi.confluentcloud.inputs.GetPrivateLinkAccessEnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleUsingIdPrivateLinkAccess = ConfluentcloudFunctions.getPrivateLinkAccess(GetPrivateLinkAccessArgs.builder()
            .id("pla-abc123")
            .environment(GetPrivateLinkAccessEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingId", exampleUsingIdPrivateLinkAccess.applyValue(getPrivateLinkAccessResult -> getPrivateLinkAccessResult));
        final var exampleUsingNamePrivateLinkAccess = ConfluentcloudFunctions.getPrivateLinkAccess(GetPrivateLinkAccessArgs.builder()
            .displayName("my_pla")
            .environment(GetPrivateLinkAccessEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingNamePrivateLinkAccess.applyValue(getPrivateLinkAccessResult -> getPrivateLinkAccessResult));
    }
}

import pulumi
import pulumi_confluentcloud as confluentcloud

example_using_id_private_link_access = confluentcloud.get_private_link_access(id="pla-abc123",
    environment=confluentcloud.GetPrivateLinkAccessEnvironmentArgs(
        id="env-xyz456",
    ))
pulumi.export("exampleUsingId", example_using_id_private_link_access)
example_using_name_private_link_access = confluentcloud.get_private_link_access(display_name="my_pla",
    environment=confluentcloud.GetPrivateLinkAccessEnvironmentArgs(
        id="env-xyz456",
    ))
pulumi.export("exampleUsingName", example_using_name_private_link_access)

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

const exampleUsingIdPrivateLinkAccess = confluentcloud.getPrivateLinkAccess({
    id: "pla-abc123",
    environment: {
        id: "env-xyz456",
    },
});
export const exampleUsingId = exampleUsingIdPrivateLinkAccess;
const exampleUsingNamePrivateLinkAccess = confluentcloud.getPrivateLinkAccess({
    displayName: "my_pla",
    environment: {
        id: "env-xyz456",
    },
});
export const exampleUsingName = exampleUsingNamePrivateLinkAccess;

variables:
  exampleUsingIdPrivateLinkAccess:
    Fn::Invoke:
      Function: confluentcloud:getPrivateLinkAccess
      Arguments:
        id: pla-abc123
        environment:
          id: env-xyz456
  exampleUsingNamePrivateLinkAccess:
    Fn::Invoke:
      Function: confluentcloud:getPrivateLinkAccess
      Arguments:
        displayName: my_pla
        environment:
          id: env-xyz456
outputs:
  exampleUsingId: ${exampleUsingIdPrivateLinkAccess}
  exampleUsingName: ${exampleUsingNamePrivateLinkAccess}

Using getPrivateLinkAccess

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPrivateLinkAccess(args: GetPrivateLinkAccessArgs, opts?: InvokeOptions): Promise<GetPrivateLinkAccessResult>
function getPrivateLinkAccessOutput(args: GetPrivateLinkAccessOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkAccessResult>
def get_private_link_access(display_name: Optional[str] = None,
                            environment: Optional[GetPrivateLinkAccessEnvironment] = None,
                            id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPrivateLinkAccessResult
def get_private_link_access_output(display_name: Optional[pulumi.Input[str]] = None,
                            environment: Optional[pulumi.Input[GetPrivateLinkAccessEnvironmentArgs]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkAccessResult]
func LookupPrivateLinkAccess(ctx *Context, args *LookupPrivateLinkAccessArgs, opts ...InvokeOption) (*LookupPrivateLinkAccessResult, error)
func LookupPrivateLinkAccessOutput(ctx *Context, args *LookupPrivateLinkAccessOutputArgs, opts ...InvokeOption) LookupPrivateLinkAccessResultOutput

> Note: This function is named LookupPrivateLinkAccess in the Go SDK.

public static class GetPrivateLinkAccess 
{
    public static Task<GetPrivateLinkAccessResult> InvokeAsync(GetPrivateLinkAccessArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkAccessResult> Invoke(GetPrivateLinkAccessInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivateLinkAccessResult> getPrivateLinkAccess(GetPrivateLinkAccessArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: confluentcloud:index/getPrivateLinkAccess:getPrivateLinkAccess
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Environment Pulumi.ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironment
DisplayName string

A human-readable name for the Private Link Access.

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

Environment GetPrivateLinkAccessEnvironment
DisplayName string

A human-readable name for the Private Link Access.

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

environment GetPrivateLinkAccessEnvironment
displayName String

A human-readable name for the Private Link Access.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

environment GetPrivateLinkAccessEnvironment
displayName string

A human-readable name for the Private Link Access.

id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

environment GetPrivateLinkAccessEnvironment
display_name str

A human-readable name for the Private Link Access.

id str

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

environment Property Map
displayName String

A human-readable name for the Private Link Access.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

getPrivateLinkAccess Result

The following output properties are available:

Aws List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessAw>

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

Azures List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessAzure>

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

DisplayName string

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
Environment Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessEnvironment
Id string

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

Networks List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessNetwork>
Aws []GetPrivateLinkAccessAw

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

Azures []GetPrivateLinkAccessAzure

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

DisplayName string

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
Environment GetPrivateLinkAccessEnvironment
Id string

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

Networks []GetPrivateLinkAccessNetwork
aws List<GetPrivateLinkAccessAw>

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

azures List<GetPrivateLinkAccessAzure>

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

displayName String

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
environment GetPrivateLinkAccessEnvironment
id String

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

networks List<GetPrivateLinkAccessNetwork>
aws GetPrivateLinkAccessAw[]

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

azures GetPrivateLinkAccessAzure[]

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

displayName string

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
environment GetPrivateLinkAccessEnvironment
id string

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

networks GetPrivateLinkAccessNetwork[]
aws Sequence[GetPrivateLinkAccessAw]

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

azures Sequence[GetPrivateLinkAccessAzure]

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

display_name str

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
environment GetPrivateLinkAccessEnvironment
id str

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

networks Sequence[GetPrivateLinkAccessNetwork]
aws List<Property Map>

(Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:

azures List<Property Map>

(Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:

displayName String

(Optional String) The name of the Private Link Access.

  • environment (Required Configuration Block) supports the following:
environment Property Map
id String

(Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.

networks List<Property Map>

Supporting Types

GetPrivateLinkAccessAw

Account string

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

Account string

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

account String

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

account string

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

account str

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

account String

(Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

GetPrivateLinkAccessAzure

Subscription string

(Required 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. Must be a valid 32 character UUID string.

Subscription string

(Required 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. Must be a valid 32 character UUID string.

subscription String

(Required 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. Must be a valid 32 character UUID string.

subscription string

(Required 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. Must be a valid 32 character UUID string.

subscription str

(Required 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. Must be a valid 32 character UUID string.

subscription String

(Required 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. Must be a valid 32 character UUID string.

GetPrivateLinkAccessEnvironment

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id str

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

GetPrivateLinkAccessNetwork

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

Id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id string

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id str

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

id String

The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

Package Details

Repository
https://github.com/pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes

This Pulumi package is based on the confluent Terraform Provider.