Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. databasemigrationservice
  5. PrivateConnection
Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.databasemigrationservice.PrivateConnection

Explore with Pulumi AI

Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi
pulumi/pulumi-gcp

The PrivateConnection resource is used to establish private connectivity between Database Migration Service and a customer’s network.

To get more information about PrivateConnection, see:

Example Usage

Database Migration Service Private Connection

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

const _default = new gcp.databasemigrationservice.PrivateConnection("default", {
    displayName: "dbms_pc",
    location: "us-central1",
    privateConnectionId: "my-connection",
    labels: {
        key: "value",
    },
    vpcPeeringConfig: {
        vpcName: googleComputeNetwork["default"].id,
        subnet: "10.0.0.0/29",
    },
});
const defaultNetwork = new gcp.compute.Network("default", {
    name: "my-network",
    autoCreateSubnetworks: false,
});
Copy
import pulumi
import pulumi_gcp as gcp

default = gcp.databasemigrationservice.PrivateConnection("default",
    display_name="dbms_pc",
    location="us-central1",
    private_connection_id="my-connection",
    labels={
        "key": "value",
    },
    vpc_peering_config={
        "vpc_name": google_compute_network["default"]["id"],
        "subnet": "10.0.0.0/29",
    })
default_network = gcp.compute.Network("default",
    name="my-network",
    auto_create_subnetworks=False)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/databasemigrationservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemigrationservice.NewPrivateConnection(ctx, "default", &databasemigrationservice.PrivateConnectionArgs{
			DisplayName:         pulumi.String("dbms_pc"),
			Location:            pulumi.String("us-central1"),
			PrivateConnectionId: pulumi.String("my-connection"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			VpcPeeringConfig: &databasemigrationservice.PrivateConnectionVpcPeeringConfigArgs{
				VpcName: pulumi.Any(googleComputeNetwork.Default.Id),
				Subnet:  pulumi.String("10.0.0.0/29"),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name:                  pulumi.String("my-network"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.DatabaseMigrationService.PrivateConnection("default", new()
    {
        DisplayName = "dbms_pc",
        Location = "us-central1",
        PrivateConnectionId = "my-connection",
        Labels = 
        {
            { "key", "value" },
        },
        VpcPeeringConfig = new Gcp.DatabaseMigrationService.Inputs.PrivateConnectionVpcPeeringConfigArgs
        {
            VpcName = googleComputeNetwork.Default.Id,
            Subnet = "10.0.0.0/29",
        },
    });

    var defaultNetwork = new Gcp.Compute.Network("default", new()
    {
        Name = "my-network",
        AutoCreateSubnetworks = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.databasemigrationservice.PrivateConnection;
import com.pulumi.gcp.databasemigrationservice.PrivateConnectionArgs;
import com.pulumi.gcp.databasemigrationservice.inputs.PrivateConnectionVpcPeeringConfigArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
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) {
        var default_ = new PrivateConnection("default", PrivateConnectionArgs.builder()
            .displayName("dbms_pc")
            .location("us-central1")
            .privateConnectionId("my-connection")
            .labels(Map.of("key", "value"))
            .vpcPeeringConfig(PrivateConnectionVpcPeeringConfigArgs.builder()
                .vpcName(googleComputeNetwork.default().id())
                .subnet("10.0.0.0/29")
                .build())
            .build());

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .name("my-network")
            .autoCreateSubnetworks(false)
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:databasemigrationservice:PrivateConnection
    properties:
      displayName: dbms_pc
      location: us-central1
      privateConnectionId: my-connection
      labels:
        key: value
      vpcPeeringConfig:
        vpcName: ${googleComputeNetwork.default.id}
        subnet: 10.0.0.0/29
  defaultNetwork:
    type: gcp:compute:Network
    name: default
    properties:
      name: my-network
      autoCreateSubnetworks: false
Copy

Create PrivateConnection Resource

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

Constructor syntax

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

@overload
def PrivateConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      private_connection_id: Optional[str] = None,
                      vpc_peering_config: Optional[PrivateConnectionVpcPeeringConfigArgs] = None,
                      display_name: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      project: Optional[str] = None)
func NewPrivateConnection(ctx *Context, name string, args PrivateConnectionArgs, opts ...ResourceOption) (*PrivateConnection, error)
public PrivateConnection(string name, PrivateConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateConnection(String name, PrivateConnectionArgs args)
public PrivateConnection(String name, PrivateConnectionArgs args, CustomResourceOptions options)

type: gcp:databasemigrationservice:PrivateConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PrivateConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PrivateConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PrivateConnectionArgs
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 privateConnectionResource = new Gcp.DatabaseMigrationService.PrivateConnection("privateConnectionResource", new()
{
    Location = "string",
    PrivateConnectionId = "string",
    VpcPeeringConfig = new Gcp.DatabaseMigrationService.Inputs.PrivateConnectionVpcPeeringConfigArgs
    {
        Subnet = "string",
        VpcName = "string",
    },
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});
Copy
example, err := databasemigrationservice.NewPrivateConnection(ctx, "privateConnectionResource", &databasemigrationservice.PrivateConnectionArgs{
	Location:            pulumi.String("string"),
	PrivateConnectionId: pulumi.String("string"),
	VpcPeeringConfig: &databasemigrationservice.PrivateConnectionVpcPeeringConfigArgs{
		Subnet:  pulumi.String("string"),
		VpcName: pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})
Copy
var privateConnectionResource = new com.pulumi.gcp.databasemigrationservice.PrivateConnection("privateConnectionResource", com.pulumi.gcp.databasemigrationservice.PrivateConnectionArgs.builder()
    .location("string")
    .privateConnectionId("string")
    .vpcPeeringConfig(PrivateConnectionVpcPeeringConfigArgs.builder()
        .subnet("string")
        .vpcName("string")
        .build())
    .displayName("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());
Copy
private_connection_resource = gcp.databasemigrationservice.PrivateConnection("privateConnectionResource",
    location="string",
    private_connection_id="string",
    vpc_peering_config={
        "subnet": "string",
        "vpc_name": "string",
    },
    display_name="string",
    labels={
        "string": "string",
    },
    project="string")
Copy
const privateConnectionResource = new gcp.databasemigrationservice.PrivateConnection("privateConnectionResource", {
    location: "string",
    privateConnectionId: "string",
    vpcPeeringConfig: {
        subnet: "string",
        vpcName: "string",
    },
    displayName: "string",
    labels: {
        string: "string",
    },
    project: "string",
});
Copy
type: gcp:databasemigrationservice:PrivateConnection
properties:
    displayName: string
    labels:
        string: string
    location: string
    privateConnectionId: string
    project: string
    vpcPeeringConfig:
        subnet: string
        vpcName: string
Copy

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

Location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this private connection is located in.
PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The private connectivity identifier.
VpcPeeringConfig
This property is required.
Changes to this property will trigger replacement.
PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
DisplayName Changes to this property will trigger replacement. string
Display name.
Labels Dictionary<string, string>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Project Changes to this property will trigger replacement. string
Location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this private connection is located in.
PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The private connectivity identifier.
VpcPeeringConfig
This property is required.
Changes to this property will trigger replacement.
PrivateConnectionVpcPeeringConfigArgs
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
DisplayName Changes to this property will trigger replacement. string
Display name.
Labels map[string]string
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Project Changes to this property will trigger replacement. string
location
This property is required.
Changes to this property will trigger replacement.
String
The name of the location this private connection is located in.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
The private connectivity identifier.
vpcPeeringConfig
This property is required.
Changes to this property will trigger replacement.
PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. String
Display name.
labels Map<String,String>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
project Changes to this property will trigger replacement. String
location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this private connection is located in.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The private connectivity identifier.
vpcPeeringConfig
This property is required.
Changes to this property will trigger replacement.
PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. string
Display name.
labels {[key: string]: string}
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
project Changes to this property will trigger replacement. string
location
This property is required.
Changes to this property will trigger replacement.
str
The name of the location this private connection is located in.
private_connection_id
This property is required.
Changes to this property will trigger replacement.
str
The private connectivity identifier.
vpc_peering_config
This property is required.
Changes to this property will trigger replacement.
PrivateConnectionVpcPeeringConfigArgs
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
display_name Changes to this property will trigger replacement. str
Display name.
labels Mapping[str, str]
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
project Changes to this property will trigger replacement. str
location
This property is required.
Changes to this property will trigger replacement.
String
The name of the location this private connection is located in.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
The private connectivity identifier.
vpcPeeringConfig
This property is required.
Changes to this property will trigger replacement.
Property Map
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. String
Display name.
labels Map<String>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
project Changes to this property will trigger replacement. String

Outputs

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

EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Errors List<PrivateConnectionError>
The PrivateConnection error in case of failure. Structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource's name.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
State of the PrivateConnection.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Errors []PrivateConnectionError
The PrivateConnection error in case of failure. Structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource's name.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
State of the PrivateConnection.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors List<PrivateConnectionError>
The PrivateConnection error in case of failure. Structure is documented below.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource's name.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
State of the PrivateConnection.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors PrivateConnectionError[]
The PrivateConnection error in case of failure. Structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource's name.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
state string
State of the PrivateConnection.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors Sequence[PrivateConnectionError]
The PrivateConnection error in case of failure. Structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource's name.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
state str
State of the PrivateConnection.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors List<Property Map>
The PrivateConnection error in case of failure. Structure is documented below.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource's name.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
State of the PrivateConnection.

Look up Existing PrivateConnection Resource

Get an existing PrivateConnection 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?: PrivateConnectionState, opts?: CustomResourceOptions): PrivateConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        errors: Optional[Sequence[PrivateConnectionErrorArgs]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        private_connection_id: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        state: Optional[str] = None,
        vpc_peering_config: Optional[PrivateConnectionVpcPeeringConfigArgs] = None) -> PrivateConnection
func GetPrivateConnection(ctx *Context, name string, id IDInput, state *PrivateConnectionState, opts ...ResourceOption) (*PrivateConnection, error)
public static PrivateConnection Get(string name, Input<string> id, PrivateConnectionState? state, CustomResourceOptions? opts = null)
public static PrivateConnection get(String name, Output<String> id, PrivateConnectionState state, CustomResourceOptions options)
resources:  _:    type: gcp:databasemigrationservice:PrivateConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DisplayName Changes to this property will trigger replacement. string
Display name.
EffectiveLabels Changes to this property will trigger replacement. Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Errors List<PrivateConnectionError>
The PrivateConnection error in case of failure. Structure is documented below.
Labels Dictionary<string, string>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The name of the location this private connection is located in.
Name string
The resource's name.
PrivateConnectionId Changes to this property will trigger replacement. string
The private connectivity identifier.
Project Changes to this property will trigger replacement. string
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
State of the PrivateConnection.
VpcPeeringConfig Changes to this property will trigger replacement. PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
DisplayName Changes to this property will trigger replacement. string
Display name.
EffectiveLabels Changes to this property will trigger replacement. map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Errors []PrivateConnectionErrorArgs
The PrivateConnection error in case of failure. Structure is documented below.
Labels map[string]string
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The name of the location this private connection is located in.
Name string
The resource's name.
PrivateConnectionId Changes to this property will trigger replacement. string
The private connectivity identifier.
Project Changes to this property will trigger replacement. string
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
State of the PrivateConnection.
VpcPeeringConfig Changes to this property will trigger replacement. PrivateConnectionVpcPeeringConfigArgs
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. String
Display name.
effectiveLabels Changes to this property will trigger replacement. Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors List<PrivateConnectionError>
The PrivateConnection error in case of failure. Structure is documented below.
labels Map<String,String>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The name of the location this private connection is located in.
name String
The resource's name.
privateConnectionId Changes to this property will trigger replacement. String
The private connectivity identifier.
project Changes to this property will trigger replacement. String
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
State of the PrivateConnection.
vpcPeeringConfig Changes to this property will trigger replacement. PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. string
Display name.
effectiveLabels Changes to this property will trigger replacement. {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors PrivateConnectionError[]
The PrivateConnection error in case of failure. Structure is documented below.
labels {[key: string]: string}
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. string
The name of the location this private connection is located in.
name string
The resource's name.
privateConnectionId Changes to this property will trigger replacement. string
The private connectivity identifier.
project Changes to this property will trigger replacement. string
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
state string
State of the PrivateConnection.
vpcPeeringConfig Changes to this property will trigger replacement. PrivateConnectionVpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
display_name Changes to this property will trigger replacement. str
Display name.
effective_labels Changes to this property will trigger replacement. Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors Sequence[PrivateConnectionErrorArgs]
The PrivateConnection error in case of failure. Structure is documented below.
labels Mapping[str, str]
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. str
The name of the location this private connection is located in.
name str
The resource's name.
private_connection_id Changes to this property will trigger replacement. str
The private connectivity identifier.
project Changes to this property will trigger replacement. str
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
state str
State of the PrivateConnection.
vpc_peering_config Changes to this property will trigger replacement. PrivateConnectionVpcPeeringConfigArgs
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.
displayName Changes to this property will trigger replacement. String
Display name.
effectiveLabels Changes to this property will trigger replacement. Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
errors List<Property Map>
The PrivateConnection error in case of failure. Structure is documented below.
labels Map<String>
Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The name of the location this private connection is located in.
name String
The resource's name.
privateConnectionId Changes to this property will trigger replacement. String
The private connectivity identifier.
project Changes to this property will trigger replacement. String
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
State of the PrivateConnection.
vpcPeeringConfig Changes to this property will trigger replacement. Property Map
The VPC Peering configuration is used to create VPC peering between databasemigrationservice and the consumer's VPC. Structure is documented below.

Supporting Types

PrivateConnectionError
, PrivateConnectionErrorArgs

Details Dictionary<string, string>
A list of messages that carry the error details.
Message string
A message containing more information about the error that occurred.
Details map[string]string
A list of messages that carry the error details.
Message string
A message containing more information about the error that occurred.
details Map<String,String>
A list of messages that carry the error details.
message String
A message containing more information about the error that occurred.
details {[key: string]: string}
A list of messages that carry the error details.
message string
A message containing more information about the error that occurred.
details Mapping[str, str]
A list of messages that carry the error details.
message str
A message containing more information about the error that occurred.
details Map<String>
A list of messages that carry the error details.
message String
A message containing more information about the error that occurred.

PrivateConnectionVpcPeeringConfig
, PrivateConnectionVpcPeeringConfigArgs

Subnet
This property is required.
Changes to this property will trigger replacement.
string
A free subnet for peering. (CIDR of /29)

VpcName
This property is required.
Changes to this property will trigger replacement.
string
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}
Subnet
This property is required.
Changes to this property will trigger replacement.
string
A free subnet for peering. (CIDR of /29)

VpcName
This property is required.
Changes to this property will trigger replacement.
string
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}
subnet
This property is required.
Changes to this property will trigger replacement.
String
A free subnet for peering. (CIDR of /29)

vpcName
This property is required.
Changes to this property will trigger replacement.
String
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}
subnet
This property is required.
Changes to this property will trigger replacement.
string
A free subnet for peering. (CIDR of /29)

vpcName
This property is required.
Changes to this property will trigger replacement.
string
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}
subnet
This property is required.
Changes to this property will trigger replacement.
str
A free subnet for peering. (CIDR of /29)

vpc_name
This property is required.
Changes to this property will trigger replacement.
str
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}
subnet
This property is required.
Changes to this property will trigger replacement.
String
A free subnet for peering. (CIDR of /29)

vpcName
This property is required.
Changes to this property will trigger replacement.
String
Fully qualified name of the VPC that Database Migration Service will peer to. Format: projects/{project}/global/{networks}/{name}

Import

PrivateConnection can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/privateConnections/{{private_connection_id}}

  • {{project}}/{{location}}/{{private_connection_id}}

  • {{location}}/{{private_connection_id}}

When using the pulumi import command, PrivateConnection can be imported using one of the formats above. For example:

$ pulumi import gcp:databasemigrationservice/privateConnection:PrivateConnection default projects/{{project}}/locations/{{location}}/privateConnections/{{private_connection_id}}
Copy
$ pulumi import gcp:databasemigrationservice/privateConnection:PrivateConnection default {{project}}/{{location}}/{{private_connection_id}}
Copy
$ pulumi import gcp:databasemigrationservice/privateConnection:PrivateConnection default {{location}}/{{private_connection_id}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi
pulumi/pulumi-gcp