confluentcloud.PrivateLinkAccess
Explore with Pulumi AI
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
new PrivateLinkAccess(name: string, args: PrivateLinkAccessArgs, opts?: CustomResourceOptions);
@overload
def PrivateLinkAccess(resource_name: 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)
@overload
def PrivateLinkAccess(resource_name: str,
args: PrivateLinkAccessArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The PrivateLinkAccess resource accepts the following input properties:
- Environment
Pulumi.
Confluent Cloud. Inputs. Private Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Pulumi.
Confluent Cloud. Inputs. Private Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Pulumi.
Confluent Cloud. Inputs. Private Link Access Aws - Azure
Pulumi.
Confluent Cloud. Inputs. Private Link Access Azure - Display
Name string The name of the Private Link Access.
- Gcp
Pulumi.
Confluent Cloud. Inputs. Private Link Access Gcp
- Environment
Private
Link Access Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Private
Link Access Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Private
Link Access Aws Args - Azure
Private
Link Access Azure Args - Display
Name string The name of the Private Link Access.
- Gcp
Private
Link Access Gcp Args
- environment
Private
Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Private
Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws - azure
Private
Link Access Azure - display
Name String The name of the Private Link Access.
- gcp
Private
Link Access Gcp
- environment
Private
Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Private
Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws - azure
Private
Link Access Azure - display
Name string The name of the Private Link Access.
- gcp
Private
Link Access Gcp
- environment
Private
Link Access Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Private
Link Access Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws Args - azure
Private
Link Access Azure Args - display_
name str The name of the Private Link Access.
- gcp
Private
Link Access Gcp Args
- 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
- display
Name 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)
Resource lookup is not supported in YAML
- 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.
- Aws
Pulumi.
Confluent Cloud. Inputs. Private Link Access Aws - Azure
Pulumi.
Confluent Cloud. Inputs. Private Link Access Azure - Display
Name string The name of the Private Link Access.
- Environment
Pulumi.
Confluent Cloud. Inputs. Private Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Gcp
Pulumi.
Confluent Cloud. Inputs. Private Link Access Gcp - Network
Pulumi.
Confluent Cloud. Inputs. Private Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Private
Link Access Aws Args - Azure
Private
Link Access Azure Args - Display
Name string The name of the Private Link Access.
- Environment
Private
Link Access Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Gcp
Private
Link Access Gcp Args - Network
Private
Link Access Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws - azure
Private
Link Access Azure - display
Name String The name of the Private Link Access.
- environment
Private
Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Private
Link Access Gcp - network
Private
Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws - azure
Private
Link Access Azure - display
Name string The name of the Private Link Access.
- environment
Private
Link Access Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Private
Link Access Gcp - network
Private
Link Access Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Private
Link Access Aws Args - azure
Private
Link Access Azure Args - display_
name str The name of the Private Link Access.
- environment
Private
Link Access Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Private
Link Access Gcp Args - network
Private
Link Access Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws Property Map
- azure Property Map
- display
Name 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 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
.
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
.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.