PrivateConnection class
The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
To get more information about PrivateConnection, see:
- API documentation
- How-to Guides
- Official Documentation
Example Usage
Datastream Private Connection Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultNetwork = new gcp.compute.Network("default", {name: "my-network"});
const _default = new gcp.datastream.PrivateConnection("default", {
displayName: "Connection profile",
location: "us-central1",
privateConnectionId: "my-connection",
labels: {
key: "value",
},
vpcPeeringConfig: {
vpc: defaultNetwork.id,
subnet: "10.0.0.0/29",
},
});
import pulumi
import pulumi_gcp as gcp
default_network = gcp.compute.Network("default", name="my-network")
default = gcp.datastream.PrivateConnection("default",
display_name="Connection profile",
location="us-central1",
private_connection_id="my-connection",
labels={
"key": "value",
},
vpc_peering_config={
"vpc": default_network.id,
"subnet": "10.0.0.0/29",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultNetwork = new Gcp.Compute.Network("default", new()
{
Name = "my-network",
});
var @default = new Gcp.Datastream.PrivateConnection("default", new()
{
DisplayName = "Connection profile",
Location = "us-central1",
PrivateConnectionId = "my-connection",
Labels =
{
{ "key", "value" },
},
VpcPeeringConfig = new Gcp.Datastream.Inputs.PrivateConnectionVpcPeeringConfigArgs
{
Vpc = defaultNetwork.Id,
Subnet = "10.0.0.0/29",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/datastream"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
Name: pulumi.String("my-network"),
})
if err != nil {
return err
}
_, err = datastream.NewPrivateConnection(ctx, "default", &datastream.PrivateConnectionArgs{
DisplayName: pulumi.String("Connection profile"),
Location: pulumi.String("us-central1"),
PrivateConnectionId: pulumi.String("my-connection"),
Labels: pulumi.StringMap{
"key": pulumi.String("value"),
},
VpcPeeringConfig: &datastream.PrivateConnectionVpcPeeringConfigArgs{
Vpc: defaultNetwork.ID().ToIDOutput().ToStringOutput(),
Subnet: pulumi.String("10.0.0.0/29"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_datastream_privateconnection" "default" {
display_name = "Connection profile"
location = "us-central1"
private_connection_id = "my-connection"
labels = {
"key" = "value"
}
vpc_peering_config = {
vpc = gcp_compute_network.default.id
subnet = "10.0.0.0/29"
}
}
resource "gcp_compute_network" "default" {
name = "my-network"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.datastream.PrivateConnection;
import com.pulumi.gcp.datastream.PrivateConnectionArgs;
import com.pulumi.gcp.datastream.inputs.PrivateConnectionVpcPeeringConfigArgs;
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 defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.name("my-network")
.build());
var default_ = new PrivateConnection("default", PrivateConnectionArgs.builder()
.displayName("Connection profile")
.location("us-central1")
.privateConnectionId("my-connection")
.labels(Map.of("key", "value"))
.vpcPeeringConfig(PrivateConnectionVpcPeeringConfigArgs.builder()
.vpc(defaultNetwork.id())
.subnet("10.0.0.0/29")
.build())
.build());
}
}
resources:
default:
type: gcp:datastream:PrivateConnection
properties:
displayName: Connection profile
location: us-central1
privateConnectionId: my-connection
labels:
key: value
vpcPeeringConfig:
vpc: ${defaultNetwork.id}
subnet: 10.0.0.0/29
defaultNetwork:
type: gcp:compute:Network
name: default
properties:
name: my-network
Datastream Private Connection Force Delete
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultNetwork = new gcp.compute.Network("default", {name: "my-network"});
const _default = new gcp.datastream.PrivateConnection("default", {
displayName: "Connection profile",
location: "us-central1",
privateConnectionId: "my-connection",
deletionPolicy: "FORCE",
labels: {
key: "value",
},
vpcPeeringConfig: {
vpc: defaultNetwork.id,
subnet: "10.0.0.0/29",
},
});
import pulumi
import pulumi_gcp as gcp
default_network = gcp.compute.Network("default", name="my-network")
default = gcp.datastream.PrivateConnection("default",
display_name="Connection profile",
location="us-central1",
private_connection_id="my-connection",
deletion_policy="FORCE",
labels={
"key": "value",
},
vpc_peering_config={
"vpc": default_network.id,
"subnet": "10.0.0.0/29",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultNetwork = new Gcp.Compute.Network("default", new()
{
Name = "my-network",
});
var @default = new Gcp.Datastream.PrivateConnection("default", new()
{
DisplayName = "Connection profile",
Location = "us-central1",
PrivateConnectionId = "my-connection",
DeletionPolicy = "FORCE",
Labels =
{
{ "key", "value" },
},
VpcPeeringConfig = new Gcp.Datastream.Inputs.PrivateConnectionVpcPeeringConfigArgs
{
Vpc = defaultNetwork.Id,
Subnet = "10.0.0.0/29",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/datastream"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
Name: pulumi.String("my-network"),
})
if err != nil {
return err
}
_, err = datastream.NewPrivateConnection(ctx, "default", &datastream.PrivateConnectionArgs{
DisplayName: pulumi.String("Connection profile"),
Location: pulumi.String("us-central1"),
PrivateConnectionId: pulumi.String("my-connection"),
DeletionPolicy: pulumi.String("FORCE"),
Labels: pulumi.StringMap{
"key": pulumi.String("value"),
},
VpcPeeringConfig: &datastream.PrivateConnectionVpcPeeringConfigArgs{
Vpc: defaultNetwork.ID().ToIDOutput().ToStringOutput(),
Subnet: pulumi.String("10.0.0.0/29"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_datastream_privateconnection" "default" {
display_name = "Connection profile"
location = "us-central1"
private_connection_id = "my-connection"
deletion_policy = "FORCE"
labels = {
"key" = "value"
}
vpc_peering_config = {
vpc = gcp_compute_network.default.id
subnet = "10.0.0.0/29"
}
}
resource "gcp_compute_network" "default" {
name = "my-network"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.datastream.PrivateConnection;
import com.pulumi.gcp.datastream.PrivateConnectionArgs;
import com.pulumi.gcp.datastream.inputs.PrivateConnectionVpcPeeringConfigArgs;
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 defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.name("my-network")
.build());
var default_ = new PrivateConnection("default", PrivateConnectionArgs.builder()
.displayName("Connection profile")
.location("us-central1")
.privateConnectionId("my-connection")
.deletionPolicy("FORCE")
.labels(Map.of("key", "value"))
.vpcPeeringConfig(PrivateConnectionVpcPeeringConfigArgs.builder()
.vpc(defaultNetwork.id())
.subnet("10.0.0.0/29")
.build())
.build());
}
}
resources:
default:
type: gcp:datastream:PrivateConnection
properties:
displayName: Connection profile
location: us-central1
privateConnectionId: my-connection
deletionPolicy: FORCE
labels:
key: value
vpcPeeringConfig:
vpc: ${defaultNetwork.id}
subnet: 10.0.0.0/29
defaultNetwork:
type: gcp:compute:Network
name: default
properties:
name: my-network
Datastream Private Connection Psc Interface
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultNetwork = new gcp.compute.Network("default", {
name: "my-network",
autoCreateSubnetworks: false,
});
const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
name: "my-subnetwork",
region: "us-west1",
network: defaultNetwork.id,
ipCidrRange: "10.0.0.0/16",
});
const defaultNetworkAttachment = new gcp.compute.NetworkAttachment("default", {
name: "my-network-attachment",
region: "us-west1",
description: "basic network attachment description",
connectionPreference: "ACCEPT_AUTOMATIC",
subnetworks: [defaultSubnetwork.selfLink],
});
const _default = new gcp.datastream.PrivateConnection("default", {
displayName: "Connection profile",
location: "us-west1",
privateConnectionId: "my-connection",
labels: {
key: "value",
},
pscInterfaceConfig: {
networkAttachment: defaultNetworkAttachment.id,
},
});
import pulumi
import pulumi_gcp as gcp
default_network = gcp.compute.Network("default",
name="my-network",
auto_create_subnetworks=False)
default_subnetwork = gcp.compute.Subnetwork("default",
name="my-subnetwork",
region="us-west1",
network=default_network.id,
ip_cidr_range="10.0.0.0/16")
default_network_attachment = gcp.compute.NetworkAttachment("default",
name="my-network-attachment",
region="us-west1",
description="basic network attachment description",
connection_preference="ACCEPT_AUTOMATIC",
subnetworks=[default_subnetwork.self_link])
default = gcp.datastream.PrivateConnection("default",
display_name="Connection profile",
location="us-west1",
private_connection_id="my-connection",
labels={
"key": "value",
},
psc_interface_config={
"network_attachment": default_network_attachment.id,
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultNetwork = new Gcp.Compute.Network("default", new()
{
Name = "my-network",
AutoCreateSubnetworks = false,
});
var defaultSubnetwork = new Gcp.Compute.Subnetwork("default", new()
{
Name = "my-subnetwork",
Region = "us-west1",
Network = defaultNetwork.Id,
IpCidrRange = "10.0.0.0/16",
});
var defaultNetworkAttachment = new Gcp.Compute.NetworkAttachment("default", new()
{
Name = "my-network-attachment",
Region = "us-west1",
Description = "basic network attachment description",
ConnectionPreference = "ACCEPT_AUTOMATIC",
Subnetworks = new[]
{
defaultSubnetwork.SelfLink,
},
});
var @default = new Gcp.Datastream.PrivateConnection("default", new()
{
DisplayName = "Connection profile",
Location = "us-west1",
PrivateConnectionId = "my-connection",
Labels =
{
{ "key", "value" },
},
PscInterfaceConfig = new Gcp.Datastream.Inputs.PrivateConnectionPscInterfaceConfigArgs
{
NetworkAttachment = defaultNetworkAttachment.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/datastream"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
Name: pulumi.String("my-network"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
defaultSubnetwork, err := compute.NewSubnetwork(ctx, "default", &compute.SubnetworkArgs{
Name: pulumi.String("my-subnetwork"),
Region: pulumi.String("us-west1"),
Network: defaultNetwork.ID().ToIDOutput().ToStringOutput(),
IpCidrRange: pulumi.String("10.0.0.0/16"),
})
if err != nil {
return err
}
defaultNetworkAttachment, err := compute.NewNetworkAttachment(ctx, "default", &compute.NetworkAttachmentArgs{
Name: pulumi.String("my-network-attachment"),
Region: pulumi.String("us-west1"),
Description: pulumi.String("basic network attachment description"),
ConnectionPreference: pulumi.String("ACCEPT_AUTOMATIC"),
Subnetworks: pulumi.StringArray{
defaultSubnetwork.SelfLink,
},
})
if err != nil {
return err
}
_, err = datastream.NewPrivateConnection(ctx, "default", &datastream.PrivateConnectionArgs{
DisplayName: pulumi.String("Connection profile"),
Location: pulumi.String("us-west1"),
PrivateConnectionId: pulumi.String("my-connection"),
Labels: pulumi.StringMap{
"key": pulumi.String("value"),
},
PscInterfaceConfig: &datastream.PrivateConnectionPscInterfaceConfigArgs{
NetworkAttachment: defaultNetworkAttachment.ID().ToIDOutput().ToStringOutput(),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_datastream_privateconnection" "default" {
display_name = "Connection profile"
location = "us-west1"
private_connection_id = "my-connection"
labels = {
"key" = "value"
}
psc_interface_config = {
network_attachment = gcp_compute_networkattachment.default.id
}
}
resource "gcp_compute_networkattachment" "default" {
name = "my-network-attachment"
region = "us-west1"
description = "basic network attachment description"
connection_preference = "ACCEPT_AUTOMATIC"
subnetworks = [gcp_compute_subnetwork.default.self_link]
}
resource "gcp_compute_network" "default" {
name = "my-network"
auto_create_subnetworks = false
}
resource "gcp_compute_subnetwork" "default" {
name = "my-subnetwork"
region = "us-west1"
network = gcp_compute_network.default.id
ip_cidr_range = "10.0.0.0/16"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.NetworkAttachment;
import com.pulumi.gcp.compute.NetworkAttachmentArgs;
import com.pulumi.gcp.datastream.PrivateConnection;
import com.pulumi.gcp.datastream.PrivateConnectionArgs;
import com.pulumi.gcp.datastream.inputs.PrivateConnectionPscInterfaceConfigArgs;
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 defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.name("my-network")
.autoCreateSubnetworks(false)
.build());
var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()
.name("my-subnetwork")
.region("us-west1")
.network(defaultNetwork.id())
.ipCidrRange("10.0.0.0/16")
.build());
var defaultNetworkAttachment = new NetworkAttachment("defaultNetworkAttachment", NetworkAttachmentArgs.builder()
.name("my-network-attachment")
.region("us-west1")
.description("basic network attachment description")
.connectionPreference("ACCEPT_AUTOMATIC")
.subnetworks(defaultSubnetwork.selfLink())
.build());
var default_ = new PrivateConnection("default", PrivateConnectionArgs.builder()
.displayName("Connection profile")
.location("us-west1")
.privateConnectionId("my-connection")
.labels(Map.of("key", "value"))
.pscInterfaceConfig(PrivateConnectionPscInterfaceConfigArgs.builder()
.networkAttachment(defaultNetworkAttachment.id())
.build())
.build());
}
}
resources:
default:
type: gcp:datastream:PrivateConnection
properties:
displayName: Connection profile
location: us-west1
privateConnectionId: my-connection
labels:
key: value
pscInterfaceConfig:
networkAttachment: ${defaultNetworkAttachment.id}
defaultNetworkAttachment:
type: gcp:compute:NetworkAttachment
name: default
properties:
name: my-network-attachment
region: us-west1
description: basic network attachment description
connectionPreference: ACCEPT_AUTOMATIC
subnetworks:
- ${defaultSubnetwork.selfLink}
defaultNetwork:
type: gcp:compute:Network
name: default
properties:
name: my-network
autoCreateSubnetworks: false
defaultSubnetwork:
type: gcp:compute:Subnetwork
name: default
properties:
name: my-subnetwork
region: us-west1
network: ${defaultNetwork.id}
ipCidrRange: 10.0.0.0/16
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:datastream/privateConnection:PrivateConnection default projects/{{project}}/locations/{{location}}/privateConnections/{{private_connection_id}}
$ pulumi import gcp:datastream/privateConnection:PrivateConnection default {{project}}/{{location}}/{{private_connection_id}}
$ pulumi import gcp:datastream/privateConnection:PrivateConnection default {{location}}/{{private_connection_id}}
Constructors
- PrivateConnection(String name, {PrivateConnectionArgs? args, CustomResourceOptions? options})
-
Creates a new PrivateConnection.
nameThe Pulumi resource name.argsArguments used to configure this PrivateConnection. The set of arguments for PrivateConnection.optionsResource options controlling this resource's behavior. - PrivateConnection.reference(String urn)
- Creates a typed reference to an existing PrivateConnection resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createWithoutValidation
↔ Output<
bool?> -
If set to true, will skip validations.
latefinal
-
deletionPolicy
↔ Output<
String> -
The deletion policy for the private connection. Setting
FORCEwill also delete any child routes that belong to this private connection. SettingDEFAULTwill fail the delete if child routes exist. Defaults toFORCEfor backwards compatibility.latefinal -
displayName
↔ Output<
String> -
Display name.
latefinal
-
effectiveLabels
↔ Output<
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.
latefinal
-
errors
↔ Output<
List< PrivateConnectionError> > -
The PrivateConnection error in case of failure.
Structure is documented below.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
labels
↔ Output<
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
effectiveLabelsfor all of the labels present on the resource.latefinal -
location
↔ Output<
String> -
The name of the location this private connection is located in.
latefinal
-
name
↔ Output<
String> -
The resource's name.
latefinal
-
privateConnectionId
↔ Output<
String> -
The private connectivity identifier.
latefinal
-
project
↔ Output<
String> -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
latefinal
-
pscInterfaceConfig
↔ Output<
PrivateConnectionPscInterfaceConfig?> -
The PSC Interface configuration is used to create PSC Interface
between Datastream and the consumer's PSC.
Structure is documented below.
latefinal
-
pulumiLabels
↔ Output<
Map< String, String> > -
The combination of labels configured directly on the resource
and default labels configured on the provider.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String> -
State of the PrivateConnection.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcPeeringConfig
↔ Output<
PrivateConnectionVpcPeeringConfig?> -
The VPC Peering configuration is used to create VPC peering
between Datastream and the consumer's VPC.
Structure is documented below.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PrivateConnectionState? state, CustomResourceOptions? options}) → PrivateConnection -
Gets an existing PrivateConnection resource's state with the given
nameandid.