gcp.datastream.PrivateConnection
Explore with Pulumi AI
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
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=gcp.datastream.PrivateConnectionVpcPeeringConfigArgs(
vpc=default_network.id,
subnet="10.0.0.0/29",
))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v7/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(),
Subnet: pulumi.String("10.0.0.0/29"),
},
})
if err != nil {
return err
}
return nil
})
}
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 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.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 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
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,
display_name: Optional[str] = None,
location: Optional[str] = None,
private_connection_id: Optional[str] = None,
vpc_peering_config: Optional[PrivateConnectionVpcPeeringConfigArgs] = None,
create_without_validation: Optional[bool] = 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:datastream:PrivateConnection
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 PrivateConnectionArgs
- 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 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 string
- The unique name of the resource.
- args PrivateConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 gcpPrivateConnectionResource = new Gcp.Datastream.PrivateConnection("gcpPrivateConnectionResource", new()
{
DisplayName = "string",
Location = "string",
PrivateConnectionId = "string",
VpcPeeringConfig = new Gcp.Datastream.Inputs.PrivateConnectionVpcPeeringConfigArgs
{
Subnet = "string",
Vpc = "string",
},
CreateWithoutValidation = false,
Labels =
{
{ "string", "string" },
},
Project = "string",
});
example, err := datastream.NewPrivateConnection(ctx, "gcpPrivateConnectionResource", &datastream.PrivateConnectionArgs{
DisplayName: pulumi.String("string"),
Location: pulumi.String("string"),
PrivateConnectionId: pulumi.String("string"),
VpcPeeringConfig: &datastream.PrivateConnectionVpcPeeringConfigArgs{
Subnet: pulumi.String("string"),
Vpc: pulumi.String("string"),
},
CreateWithoutValidation: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Project: pulumi.String("string"),
})
var gcpPrivateConnectionResource = new PrivateConnection("gcpPrivateConnectionResource", PrivateConnectionArgs.builder()
.displayName("string")
.location("string")
.privateConnectionId("string")
.vpcPeeringConfig(PrivateConnectionVpcPeeringConfigArgs.builder()
.subnet("string")
.vpc("string")
.build())
.createWithoutValidation(false)
.labels(Map.of("string", "string"))
.project("string")
.build());
gcp_private_connection_resource = gcp.datastream.PrivateConnection("gcpPrivateConnectionResource",
display_name="string",
location="string",
private_connection_id="string",
vpc_peering_config=gcp.datastream.PrivateConnectionVpcPeeringConfigArgs(
subnet="string",
vpc="string",
),
create_without_validation=False,
labels={
"string": "string",
},
project="string")
const gcpPrivateConnectionResource = new gcp.datastream.PrivateConnection("gcpPrivateConnectionResource", {
displayName: "string",
location: "string",
privateConnectionId: "string",
vpcPeeringConfig: {
subnet: "string",
vpc: "string",
},
createWithoutValidation: false,
labels: {
string: "string",
},
project: "string",
});
type: gcp:datastream:PrivateConnection
properties:
createWithoutValidation: false
displayName: string
labels:
string: string
location: string
privateConnectionId: string
project: string
vpcPeeringConfig:
subnet: string
vpc: string
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
The PrivateConnection resource accepts the following input properties:
- Display
Name string - Display name.
- Location string
- The name of the location this private connection is located in.
- Private
Connection stringId - The private connectivity identifier.
- Vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- Create
Without boolValidation - If set to true, will skip validations.
- 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 string
- Display
Name string - Display name.
- Location string
- The name of the location this private connection is located in.
- Private
Connection stringId - The private connectivity identifier.
- Vpc
Peering PrivateConfig Connection Vpc Peering Config Args - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- Create
Without boolValidation - If set to true, will skip validations.
- 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 string
- display
Name String - Display name.
- location String
- The name of the location this private connection is located in.
- private
Connection StringId - The private connectivity identifier.
- vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without BooleanValidation - If set to true, will skip validations.
- 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 String
- display
Name string - Display name.
- location string
- The name of the location this private connection is located in.
- private
Connection stringId - The private connectivity identifier.
- vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without booleanValidation - If set to true, will skip validations.
- 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 string
- display_
name str - Display name.
- location str
- The name of the location this private connection is located in.
- private_
connection_ strid - The private connectivity identifier.
- vpc_
peering_ Privateconfig Connection Vpc Peering Config Args - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create_
without_ boolvalidation - If set to true, will skip validations.
- 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 str
- display
Name String - Display name.
- location String
- The name of the location this private connection is located in.
- private
Connection StringId - The private connectivity identifier.
- vpc
Peering Property MapConfig - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without BooleanValidation - If set to true, will skip validations.
- 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 String
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateConnection resource produces the following output properties:
- Effective
Labels 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<Private
Connection Error> - 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.
- Pulumi
Labels 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.
- Effective
Labels 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
[]Private
Connection Error - 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.
- Pulumi
Labels 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.
- effective
Labels 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<Private
Connection Error> - 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.
- pulumi
Labels 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.
- effective
Labels {[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
Private
Connection Error[] - 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.
- pulumi
Labels {[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[Private
Connection Error] - 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.
- effective
Labels 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.
- pulumi
Labels 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,
create_without_validation: Optional[bool] = 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Without boolValidation - If set to true, will skip validations.
- Display
Name string - Display name.
- Effective
Labels 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<Private
Connection Error> - 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 string
- The name of the location this private connection is located in.
- Name string
- The resource's name.
- Private
Connection stringId - The private connectivity identifier.
- Project string
- Pulumi
Labels 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.
- Vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- Create
Without boolValidation - If set to true, will skip validations.
- Display
Name string - Display name.
- Effective
Labels 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
[]Private
Connection Error Args - 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 string
- The name of the location this private connection is located in.
- Name string
- The resource's name.
- Private
Connection stringId - The private connectivity identifier.
- Project string
- Pulumi
Labels 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.
- Vpc
Peering PrivateConfig Connection Vpc Peering Config Args - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without BooleanValidation - If set to true, will skip validations.
- display
Name String - Display name.
- effective
Labels 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<Private
Connection Error> - 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 String
- The name of the location this private connection is located in.
- name String
- The resource's name.
- private
Connection StringId - The private connectivity identifier.
- project String
- pulumi
Labels 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.
- vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without booleanValidation - If set to true, will skip validations.
- display
Name string - Display name.
- effective
Labels {[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
Private
Connection Error[] - 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 string
- The name of the location this private connection is located in.
- name string
- The resource's name.
- private
Connection stringId - The private connectivity identifier.
- project string
- pulumi
Labels {[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.
- vpc
Peering PrivateConfig Connection Vpc Peering Config - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create_
without_ boolvalidation - If set to true, will skip validations.
- display_
name str - Display name.
- 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[Private
Connection Error Args] - 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 str
- The name of the location this private connection is located in.
- name str
- The resource's name.
- private_
connection_ strid - The private connectivity identifier.
- project 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_ Privateconfig Connection Vpc Peering Config Args - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
- create
Without BooleanValidation - If set to true, will skip validations.
- display
Name String - Display name.
- effective
Labels 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 String
- The name of the location this private connection is located in.
- name String
- The resource's name.
- private
Connection StringId - The private connectivity identifier.
- project String
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- State of the PrivateConnection.
- vpc
Peering Property MapConfig - The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. Structure is documented below.
Supporting Types
PrivateConnectionError, PrivateConnectionErrorArgs
PrivateConnectionVpcPeeringConfig, PrivateConnectionVpcPeeringConfigArgs
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}}
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.