1. Packages
  2. Redpanda Provider
  3. API Docs
  4. ServerlessPrivateLink
redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

redpanda.ServerlessPrivateLink

redpanda logo
redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

    Manages a Redpanda Serverless Private Link

    Create ServerlessPrivateLink Resource

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

    Constructor syntax

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

@overload
def ServerlessPrivateLink(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cloud_provider: Optional[str] = None,
                          cloud_provider_config: Optional[ServerlessPrivateLinkCloudProviderConfigArgs] = None,
                          resource_group_id: Optional[str] = None,
                          serverless_region: Optional[str] = None,
                          allow_deletion: Optional[bool] = None,
                          name: Optional[str] = None)
    func NewServerlessPrivateLink(ctx *Context, name string, args ServerlessPrivateLinkArgs, opts ...ResourceOption) (*ServerlessPrivateLink, error)
    public ServerlessPrivateLink(string name, ServerlessPrivateLinkArgs args, CustomResourceOptions? opts = null)
    public ServerlessPrivateLink(String name, ServerlessPrivateLinkArgs args)
public ServerlessPrivateLink(String name, ServerlessPrivateLinkArgs args, CustomResourceOptions options)

    type: redpanda:ServerlessPrivateLink
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 ServerlessPrivateLinkArgs
    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 ServerlessPrivateLinkArgs
    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 ServerlessPrivateLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessPrivateLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessPrivateLinkArgs
    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 serverlessPrivateLinkResource = new Redpanda.ServerlessPrivateLink("serverlessPrivateLinkResource", new()
{
    CloudProvider = "string",
    CloudProviderConfig = new Redpanda.Inputs.ServerlessPrivateLinkCloudProviderConfigArgs
    {
        Aws = new Redpanda.Inputs.ServerlessPrivateLinkCloudProviderConfigAwsArgs
        {
            AllowedPrincipals = new[]
            {
                "string",
            },
        },
    },
    ResourceGroupId = "string",
    ServerlessRegion = "string",
    AllowDeletion = false,
    Name = "string",
});

    example, err := redpanda.NewServerlessPrivateLink(ctx, "serverlessPrivateLinkResource", &redpanda.ServerlessPrivateLinkArgs{
	CloudProvider: pulumi.String("string"),
	CloudProviderConfig: &redpanda.ServerlessPrivateLinkCloudProviderConfigArgs{
		Aws: &redpanda.ServerlessPrivateLinkCloudProviderConfigAwsArgs{
			AllowedPrincipals: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ResourceGroupId:  pulumi.String("string"),
	ServerlessRegion: pulumi.String("string"),
	AllowDeletion:    pulumi.Bool(false),
	Name:             pulumi.String("string"),
})

    var serverlessPrivateLinkResource = new ServerlessPrivateLink("serverlessPrivateLinkResource", ServerlessPrivateLinkArgs.builder()
    .cloudProvider("string")
    .cloudProviderConfig(ServerlessPrivateLinkCloudProviderConfigArgs.builder()
        .aws(ServerlessPrivateLinkCloudProviderConfigAwsArgs.builder()
            .allowedPrincipals("string")
            .build())
        .build())
    .resourceGroupId("string")
    .serverlessRegion("string")
    .allowDeletion(false)
    .name("string")
    .build());

    serverless_private_link_resource = redpanda.ServerlessPrivateLink("serverlessPrivateLinkResource",
    cloud_provider="string",
    cloud_provider_config={
        "aws": {
            "allowed_principals": ["string"],
        },
    },
    resource_group_id="string",
    serverless_region="string",
    allow_deletion=False,
    name="string")

    const serverlessPrivateLinkResource = new redpanda.ServerlessPrivateLink("serverlessPrivateLinkResource", {
    cloudProvider: "string",
    cloudProviderConfig: {
        aws: {
            allowedPrincipals: ["string"],
        },
    },
    resourceGroupId: "string",
    serverlessRegion: "string",
    allowDeletion: false,
    name: "string",
});

    type: redpanda:ServerlessPrivateLink
properties:
    allowDeletion: false
    cloudProvider: string
    cloudProviderConfig:
        aws:
            allowedPrincipals:
                - string
    name: string
    resourceGroupId: string
    serverlessRegion: string

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

    CloudProvider string
    Cloud provider (aws)
    CloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    ServerlessRegion string
    Redpanda serverless region
    AllowDeletion bool
    Allows deletion of the serverless private link. Defaults to false.
    Name string
    Name of the serverless private link
    CloudProvider string
    Cloud provider (aws)
    CloudProviderConfig ServerlessPrivateLinkCloudProviderConfigArgs
    Cloud provider specific configuration
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    ServerlessRegion string
    Redpanda serverless region
    AllowDeletion bool
    Allows deletion of the serverless private link. Defaults to false.
    Name string
    Name of the serverless private link
    cloudProvider String
    Cloud provider (aws)
    cloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion String
    Redpanda serverless region
    allowDeletion Boolean
    Allows deletion of the serverless private link. Defaults to false.
    name String
    Name of the serverless private link
    cloudProvider string
    Cloud provider (aws)
    cloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    resourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion string
    Redpanda serverless region
    allowDeletion boolean
    Allows deletion of the serverless private link. Defaults to false.
    name string
    Name of the serverless private link
    cloud_provider str
    Cloud provider (aws)
    cloud_provider_config ServerlessPrivateLinkCloudProviderConfigArgs
    Cloud provider specific configuration
    resource_group_id str
    The ID of the Resource Group in which to create the serverless private link
    serverless_region str
    Redpanda serverless region
    allow_deletion bool
    Allows deletion of the serverless private link. Defaults to false.
    name str
    Name of the serverless private link
    cloudProvider String
    Cloud provider (aws)
    cloudProviderConfig Property Map
    Cloud provider specific configuration
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion String
    Redpanda serverless region
    allowDeletion Boolean
    Allows deletion of the serverless private link. Defaults to false.
    name String
    Name of the serverless private link

    Outputs

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

    CreatedAt string
    Timestamp when the serverless private link was created
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    Status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    UpdatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    CreatedAt string
    Timestamp when the serverless private link was created
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    Status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    UpdatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    createdAt String
    Timestamp when the serverless private link was created
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    updatedAt String
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    createdAt string
    Timestamp when the serverless private link was created
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    updatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    created_at str
    Timestamp when the serverless private link was created
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    updated_at str
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    createdAt String
    Timestamp when the serverless private link was created
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status Property Map
    Cloud provider specific status information
    updatedAt String
    Timestamp when the serverless private link was last updated. This value changes on every update operation.

    Look up Existing ServerlessPrivateLink Resource

    Get an existing ServerlessPrivateLink 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?: ServerlessPrivateLinkState, opts?: CustomResourceOptions): ServerlessPrivateLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_deletion: Optional[bool] = None,
        cloud_provider: Optional[str] = None,
        cloud_provider_config: Optional[ServerlessPrivateLinkCloudProviderConfigArgs] = None,
        created_at: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        serverless_region: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[ServerlessPrivateLinkStatusArgs] = None,
        updated_at: Optional[str] = None) -> ServerlessPrivateLink
    func GetServerlessPrivateLink(ctx *Context, name string, id IDInput, state *ServerlessPrivateLinkState, opts ...ResourceOption) (*ServerlessPrivateLink, error)
    public static ServerlessPrivateLink Get(string name, Input<string> id, ServerlessPrivateLinkState? state, CustomResourceOptions? opts = null)
    public static ServerlessPrivateLink get(String name, Output<String> id, ServerlessPrivateLinkState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:ServerlessPrivateLink    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:
    AllowDeletion bool
    Allows deletion of the serverless private link. Defaults to false.
    CloudProvider string
    Cloud provider (aws)
    CloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    CreatedAt string
    Timestamp when the serverless private link was created
    Name string
    Name of the serverless private link
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    ServerlessRegion string
    Redpanda serverless region
    State string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    Status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    UpdatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    AllowDeletion bool
    Allows deletion of the serverless private link. Defaults to false.
    CloudProvider string
    Cloud provider (aws)
    CloudProviderConfig ServerlessPrivateLinkCloudProviderConfigArgs
    Cloud provider specific configuration
    CreatedAt string
    Timestamp when the serverless private link was created
    Name string
    Name of the serverless private link
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    ServerlessRegion string
    Redpanda serverless region
    State string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    Status ServerlessPrivateLinkStatusArgs
    Cloud provider specific status information
    UpdatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    allowDeletion Boolean
    Allows deletion of the serverless private link. Defaults to false.
    cloudProvider String
    Cloud provider (aws)
    cloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    createdAt String
    Timestamp when the serverless private link was created
    name String
    Name of the serverless private link
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion String
    Redpanda serverless region
    state String
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    updatedAt String
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    allowDeletion boolean
    Allows deletion of the serverless private link. Defaults to false.
    cloudProvider string
    Cloud provider (aws)
    cloudProviderConfig ServerlessPrivateLinkCloudProviderConfig
    Cloud provider specific configuration
    createdAt string
    Timestamp when the serverless private link was created
    name string
    Name of the serverless private link
    resourceGroupId string
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion string
    Redpanda serverless region
    state string
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatus
    Cloud provider specific status information
    updatedAt string
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    allow_deletion bool
    Allows deletion of the serverless private link. Defaults to false.
    cloud_provider str
    Cloud provider (aws)
    cloud_provider_config ServerlessPrivateLinkCloudProviderConfigArgs
    Cloud provider specific configuration
    created_at str
    Timestamp when the serverless private link was created
    name str
    Name of the serverless private link
    resource_group_id str
    The ID of the Resource Group in which to create the serverless private link
    serverless_region str
    Redpanda serverless region
    state str
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status ServerlessPrivateLinkStatusArgs
    Cloud provider specific status information
    updated_at str
    Timestamp when the serverless private link was last updated. This value changes on every update operation.
    allowDeletion Boolean
    Allows deletion of the serverless private link. Defaults to false.
    cloudProvider String
    Cloud provider (aws)
    cloudProviderConfig Property Map
    Cloud provider specific configuration
    createdAt String
    Timestamp when the serverless private link was created
    name String
    Name of the serverless private link
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless private link
    serverlessRegion String
    Redpanda serverless region
    state String
    Current state of the serverless private link (STATECREATING, STATEREADY, STATEDELETING, STATEFAILED, STATE_UPDATING)
    status Property Map
    Cloud provider specific status information
    updatedAt String
    Timestamp when the serverless private link was last updated. This value changes on every update operation.

    Supporting Types

    ServerlessPrivateLinkCloudProviderConfig, ServerlessPrivateLinkCloudProviderConfigArgs

    Aws ServerlessPrivateLinkCloudProviderConfigAws
    AWS-specific configuration. Required when cloud*provider is 'aws'.
    Aws ServerlessPrivateLinkCloudProviderConfigAws
    AWS-specific configuration. Required when cloud*provider is 'aws'.
    aws ServerlessPrivateLinkCloudProviderConfigAws
    AWS-specific configuration. Required when cloud*provider is 'aws'.
    aws ServerlessPrivateLinkCloudProviderConfigAws
    AWS-specific configuration. Required when cloud*provider is 'aws'.
    aws ServerlessPrivateLinkCloudProviderConfigAws
    AWS-specific configuration. Required when cloud*provider is 'aws'.
    aws Property Map
    AWS-specific configuration. Required when cloud*provider is 'aws'.

    ServerlessPrivateLinkCloudProviderConfigAws, ServerlessPrivateLinkCloudProviderConfigAwsArgs

    AllowedPrincipals List<string>
    AWS principals (ARNs) allowed to connect to the private link endpoint
    AllowedPrincipals []string
    AWS principals (ARNs) allowed to connect to the private link endpoint
    allowedPrincipals List<String>
    AWS principals (ARNs) allowed to connect to the private link endpoint
    allowedPrincipals string[]
    AWS principals (ARNs) allowed to connect to the private link endpoint
    allowed_principals Sequence[str]
    AWS principals (ARNs) allowed to connect to the private link endpoint
    allowedPrincipals List<String>
    AWS principals (ARNs) allowed to connect to the private link endpoint

    ServerlessPrivateLinkStatus, ServerlessPrivateLinkStatusArgs

    Aws ServerlessPrivateLinkStatusAws
    AWS-specific status information
    Aws ServerlessPrivateLinkStatusAws
    AWS-specific status information
    aws ServerlessPrivateLinkStatusAws
    AWS-specific status information
    aws ServerlessPrivateLinkStatusAws
    AWS-specific status information
    aws ServerlessPrivateLinkStatusAws
    AWS-specific status information
    aws Property Map
    AWS-specific status information

    ServerlessPrivateLinkStatusAws, ServerlessPrivateLinkStatusAwsArgs

    AvailabilityZones List<string>
    Availability zones where the private link endpoint service is available
    VpcEndpointServiceName string
    VPC endpoint service name for connecting to the private link
    AvailabilityZones []string
    Availability zones where the private link endpoint service is available
    VpcEndpointServiceName string
    VPC endpoint service name for connecting to the private link
    availabilityZones List<String>
    Availability zones where the private link endpoint service is available
    vpcEndpointServiceName String
    VPC endpoint service name for connecting to the private link
    availabilityZones string[]
    Availability zones where the private link endpoint service is available
    vpcEndpointServiceName string
    VPC endpoint service name for connecting to the private link
    availability_zones Sequence[str]
    Availability zones where the private link endpoint service is available
    vpc_endpoint_service_name str
    VPC endpoint service name for connecting to the private link
    availabilityZones List<String>
    Availability zones where the private link endpoint service is available
    vpcEndpointServiceName String
    VPC endpoint service name for connecting to the private link

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data
    Schema (JSON)
    redpanda-data/terraform-provider-redpanda
      Meet Neo: Your AI Platform Teammate