confluentcloud.getPrivateLinkAccess
Explore with Pulumi AI
confluentcloud.PrivateLinkAccess
describes a Private Link Access data source.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var exampleUsingIdPrivateLinkAccess = ConfluentCloud.GetPrivateLinkAccess.Invoke(new()
{
Id = "pla-abc123",
Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentInputArgs
{
Id = "env-xyz456",
},
});
var exampleUsingNamePrivateLinkAccess = ConfluentCloud.GetPrivateLinkAccess.Invoke(new()
{
DisplayName = "my_pla",
Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentInputArgs
{
Id = "env-xyz456",
},
});
return new Dictionary<string, object?>
{
["exampleUsingId"] = exampleUsingIdPrivateLinkAccess,
["exampleUsingName"] = exampleUsingNamePrivateLinkAccess,
};
});
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, &confluentcloud.LookupPrivateLinkAccessArgs{
Id: pulumi.StringRef("pla-abc123"),
Environment: confluentcloud.GetPrivateLinkAccessEnvironment{
Id: "env-xyz456",
},
}, nil)
if err != nil {
return err
}
ctx.Export("exampleUsingId", exampleUsingIdPrivateLinkAccess)
exampleUsingNamePrivateLinkAccess, err := confluentcloud.LookupPrivateLinkAccess(ctx, &confluentcloud.LookupPrivateLinkAccessArgs{
DisplayName: pulumi.StringRef("my_pla"),
Environment: confluentcloud.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.
Confluent Cloud. Inputs. Get Private Link Access Environment (Required Configuration Block) supports the following:
- Display
Name 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- Environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- Display
Name 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- display
Name 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- display
Name 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment Property Map
(Required Configuration Block) supports the following:
- display
Name 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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
getPrivateLinkAccess Result
The following output properties are available:
- Aws
List<Pulumi.
Confluent Cloud. Outputs. Get Private Link Access Aw> (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
- Azures
List<Pulumi.
Confluent Cloud. Outputs. Get Private Link Access Azure> (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
- Display
Name string (Optional String) The name of the Private Link Access.
- Environment
Pulumi.
Confluent Cloud. Outputs. Get Private Link Access Environment (Required Configuration Block) supports the following:
- Gcps
List<Pulumi.
Confluent Cloud. Outputs. Get Private Link Access Gcp> (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- Id string
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- Networks
List<Pulumi.
Confluent Cloud. Outputs. Get Private Link Access Network> (Required Configuration Block) supports the following:
- Aws
[]Get
Private Link Access Aw (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
- Azures
[]Get
Private Link Access Azure (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
- Display
Name string (Optional String) The name of the Private Link Access.
- Environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- Gcps
[]Get
Private Link Access Gcp (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- Id string
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- Networks
[]Get
Private Link Access Network (Required Configuration Block) supports the following:
- aws
List<Get
Private Link Access Aw> (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
- azures
List<Get
Private Link Access Azure> (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
- display
Name String (Optional String) The name of the Private Link Access.
- environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- gcps
List<Get
Private Link Access Gcp> (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- id String
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- networks
List<Get
Private Link Access Network> (Required Configuration Block) supports the following:
- aws
Get
Private Link Access Aw[] (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
- azures
Get
Private Link Access Azure[] (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
- display
Name string (Optional String) The name of the Private Link Access.
- environment
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- gcps
Get
Private Link Access Gcp[] (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- id string
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- networks
Get
Private Link Access Network[] (Required Configuration Block) supports the following:
- aws
Sequence[Get
Private Link Access Aw] (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
- azures
Sequence[Get
Private Link Access Azure] (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
Get
Private Link Access Environment (Required Configuration Block) supports the following:
- gcps
Sequence[Get
Private Link Access Gcp] (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- id str
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- networks
Sequence[Get
Private Link Access Network] (Required Configuration Block) supports the following:
- 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:
- display
Name String (Optional String) The name of the Private Link Access.
- environment Property Map
(Required Configuration Block) supports the following:
- gcps List<Property Map>
(Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
- id String
(Required String) The ID of the Network that the Private Link Access belongs to, for example,
n-abc123
.- networks List<Property Map>
(Required Configuration Block) supports the following:
Supporting Types
GetPrivateLinkAccessAw
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
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- Id string
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id String
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id string
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id str
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id String
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
GetPrivateLinkAccessGcp
- Project string
(Required 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.
- Project string
(Required 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.
- project String
(Required 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.
- project string
(Required 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.
- project str
(Required 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.
- project String
(Required 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.
GetPrivateLinkAccessNetwork
- Id string
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- Id string
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id String
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id string
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id str
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- id String
The ID of the Environment that the Private Link Access belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.