published on Thursday, Oct 22, 2026 by Pulumi
published on Thursday, Oct 22, 2026 by Pulumi
Creates and manages a Google Private Service Connect for an Aiven service in a VPC. If this resource is missing (for example, after a service power off), it’s removed from the state and a new create plan is generated.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const example = new aiven.GcpPrivatelink("example", {
project: "my-project",
serviceName: "foo",
});
import pulumi
import pulumi_aiven as aiven
example = aiven.GcpPrivatelink("example",
project="my-project",
service_name="foo")
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewGcpPrivatelink(ctx, "example", &aiven.GcpPrivatelinkArgs{
Project: pulumi.String("my-project"),
ServiceName: pulumi.String("foo"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var example = new Aiven.GcpPrivatelink("example", new()
{
Project = "my-project",
ServiceName = "foo",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.GcpPrivatelink;
import com.pulumi.aiven.GcpPrivatelinkArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new GcpPrivatelink("example", GcpPrivatelinkArgs.builder()
.project("my-project")
.serviceName("foo")
.build());
}
}
resources:
example:
type: aiven:GcpPrivatelink
properties:
project: my-project
serviceName: foo
terraform {
required_providers {
aiven = {
source = "pulumi/aiven"
}
}
}
resource "aiven_gcp_privatelink" "example" {
lifecycle {
create_before_destroy = true
}
project = "my-project"
service_name = "foo"
}
Create GcpPrivatelink Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GcpPrivatelink(name: string, args: GcpPrivatelinkArgs, opts?: CustomResourceOptions);@overload
def GcpPrivatelink(resource_name: str,
args: GcpPrivatelinkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GcpPrivatelink(resource_name: str,
opts: Optional[ResourceOptions] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
timeouts: Optional[GcpPrivatelinkTimeoutsArgs] = None)func NewGcpPrivatelink(ctx *Context, name string, args GcpPrivatelinkArgs, opts ...ResourceOption) (*GcpPrivatelink, error)public GcpPrivatelink(string name, GcpPrivatelinkArgs args, CustomResourceOptions? opts = null)
public GcpPrivatelink(String name, GcpPrivatelinkArgs args)
public GcpPrivatelink(String name, GcpPrivatelinkArgs args, CustomResourceOptions options)
type: aiven:GcpPrivatelink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aiven_gcp_privatelink" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GcpPrivatelinkArgs
- 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 GcpPrivatelinkArgs
- 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 GcpPrivatelinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GcpPrivatelinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GcpPrivatelinkArgs
- 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 gcpPrivatelinkResource = new Aiven.GcpPrivatelink("gcpPrivatelinkResource", new()
{
Project = "string",
ServiceName = "string",
Timeouts = new Aiven.Inputs.GcpPrivatelinkTimeoutsArgs
{
Create = "string",
Delete = "string",
Read = "string",
Update = "string",
},
});
example, err := aiven.NewGcpPrivatelink(ctx, "gcpPrivatelinkResource", &aiven.GcpPrivatelinkArgs{
Project: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Timeouts: &aiven.GcpPrivatelinkTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Read: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
resource "aiven_gcp_privatelink" "gcpPrivatelinkResource" {
lifecycle {
create_before_destroy = true
}
project = "string"
service_name = "string"
timeouts = {
create = "string"
delete = "string"
read = "string"
update = "string"
}
}
var gcpPrivatelinkResource = new GcpPrivatelink("gcpPrivatelinkResource", GcpPrivatelinkArgs.builder()
.project("string")
.serviceName("string")
.timeouts(GcpPrivatelinkTimeoutsArgs.builder()
.create("string")
.delete("string")
.read("string")
.update("string")
.build())
.build());
gcp_privatelink_resource = aiven.GcpPrivatelink("gcpPrivatelinkResource",
project="string",
service_name="string",
timeouts={
"create": "string",
"delete": "string",
"read": "string",
"update": "string",
})
const gcpPrivatelinkResource = new aiven.GcpPrivatelink("gcpPrivatelinkResource", {
project: "string",
serviceName: "string",
timeouts: {
create: "string",
"delete": "string",
read: "string",
update: "string",
},
});
type: aiven:GcpPrivatelink
properties:
project: string
serviceName: string
timeouts:
create: string
delete: string
read: string
update: string
GcpPrivatelink 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 GcpPrivatelink resource accepts the following input properties:
- Project string
- Project name. Changing this property forces recreation of the resource.
- Service
Name string - Service name. Changing this property forces recreation of the resource.
- Timeouts
Gcp
Privatelink Timeouts
- Project string
- Project name. Changing this property forces recreation of the resource.
- Service
Name string - Service name. Changing this property forces recreation of the resource.
- Timeouts
Gcp
Privatelink Timeouts Args
- project string
- Project name. Changing this property forces recreation of the resource.
- service_
name string - Service name. Changing this property forces recreation of the resource.
- timeouts object
- project String
- Project name. Changing this property forces recreation of the resource.
- service
Name String - Service name. Changing this property forces recreation of the resource.
- timeouts
Gcp
Privatelink Timeouts
- project string
- Project name. Changing this property forces recreation of the resource.
- service
Name string - Service name. Changing this property forces recreation of the resource.
- timeouts
Gcp
Privatelink Timeouts
- project str
- Project name. Changing this property forces recreation of the resource.
- service_
name str - Service name. Changing this property forces recreation of the resource.
- timeouts
Gcp
Privatelink Timeouts Args
- project String
- Project name. Changing this property forces recreation of the resource.
- service
Name String - Service name. Changing this property forces recreation of the resource.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the GcpPrivatelink resource produces the following output properties:
- Google
Service stringAttachment - Google Private Service Connect service attachment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- State string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- Google
Service stringAttachment - Google Private Service Connect service attachment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- State string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- google_
service_ stringattachment - Google Private Service Connect service attachment.
- id string
- The provider-assigned unique ID for this managed resource.
- message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- state string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- google
Service StringAttachment - Google Private Service Connect service attachment.
- id String
- The provider-assigned unique ID for this managed resource.
- message String
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- state String
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- google
Service stringAttachment - Google Private Service Connect service attachment.
- id string
- The provider-assigned unique ID for this managed resource.
- message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- state string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- google_
service_ strattachment - Google Private Service Connect service attachment.
- id str
- The provider-assigned unique ID for this managed resource.
- message str
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- state str
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
- google
Service StringAttachment - Google Private Service Connect service attachment.
- id String
- The provider-assigned unique ID for this managed resource.
- message String
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- state String
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting.
Look up Existing GcpPrivatelink Resource
Get an existing GcpPrivatelink 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?: GcpPrivatelinkState, opts?: CustomResourceOptions): GcpPrivatelink@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
google_service_attachment: Optional[str] = None,
message: Optional[str] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
state: Optional[str] = None,
timeouts: Optional[GcpPrivatelinkTimeoutsArgs] = None) -> GcpPrivatelinkfunc GetGcpPrivatelink(ctx *Context, name string, id IDInput, state *GcpPrivatelinkState, opts ...ResourceOption) (*GcpPrivatelink, error)public static GcpPrivatelink Get(string name, Input<string> id, GcpPrivatelinkState? state, CustomResourceOptions? opts = null)public static GcpPrivatelink get(String name, Output<String> id, GcpPrivatelinkState state, CustomResourceOptions options)resources: _: type: aiven:GcpPrivatelink get: id: ${id}import {
to = aiven_gcp_privatelink.example
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.
- Google
Service stringAttachment - Google Private Service Connect service attachment.
- Message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- Project string
- Project name. Changing this property forces recreation of the resource.
- Service
Name string - Service name. Changing this property forces recreation of the resource.
- State string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - Timeouts
Gcp
Privatelink Timeouts
- Google
Service stringAttachment - Google Private Service Connect service attachment.
- Message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- Project string
- Project name. Changing this property forces recreation of the resource.
- Service
Name string - Service name. Changing this property forces recreation of the resource.
- State string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - Timeouts
Gcp
Privatelink Timeouts Args
- google_
service_ stringattachment - Google Private Service Connect service attachment.
- message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- project string
- Project name. Changing this property forces recreation of the resource.
- service_
name string - Service name. Changing this property forces recreation of the resource.
- state string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - timeouts object
- google
Service StringAttachment - Google Private Service Connect service attachment.
- message String
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- project String
- Project name. Changing this property forces recreation of the resource.
- service
Name String - Service name. Changing this property forces recreation of the resource.
- state String
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - timeouts
Gcp
Privatelink Timeouts
- google
Service stringAttachment - Google Private Service Connect service attachment.
- message string
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- project string
- Project name. Changing this property forces recreation of the resource.
- service
Name string - Service name. Changing this property forces recreation of the resource.
- state string
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - timeouts
Gcp
Privatelink Timeouts
- google_
service_ strattachment - Google Private Service Connect service attachment.
- message str
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- project str
- Project name. Changing this property forces recreation of the resource.
- service_
name str - Service name. Changing this property forces recreation of the resource.
- state str
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - timeouts
Gcp
Privatelink Timeouts Args
- google
Service StringAttachment - Google Private Service Connect service attachment.
- message String
- Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.
- project String
- Project name. Changing this property forces recreation of the resource.
- service
Name String - Service name. Changing this property forces recreation of the resource.
- state String
- The state of the Private Service Connect resource. The possible values are
active,creatinganddeleting. - timeouts Property Map
Supporting Types
GcpPrivatelinkTimeouts, GcpPrivatelinkTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Default string
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Default string
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- default string
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- default_ String
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- default string
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- default str
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- default String
- Timeout for all operations. Deprecated, use operation-specific timeouts instead.
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
$ pulumi import aiven:index/gcpPrivatelink:GcpPrivatelink example PROJECT/SERVICE_NAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aivenTerraform Provider.
published on Thursday, Oct 22, 2026 by Pulumi