1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datamigration
  5. datamigration/v1
  6. PrivateConnection

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.datamigration/v1.PrivateConnection

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Creates a new private connection in a given project and location.

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,
                      private_connection_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None,
                      request_id: Optional[str] = None,
                      skip_validation: Optional[bool] = None,
                      vpc_peering_config: Optional[VpcPeeringConfigArgs] = 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: google-native:datamigration/v1: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 GoogleNative.Datamigration.V1.PrivateConnection("privateConnectionResource", new()
{
    PrivateConnectionId = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
    SkipValidation = false,
    VpcPeeringConfig = new GoogleNative.Datamigration.V1.Inputs.VpcPeeringConfigArgs
    {
        Subnet = "string",
        VpcName = "string",
    },
});
Copy
example, err := datamigration.NewPrivateConnection(ctx, "privateConnectionResource", &datamigration.PrivateConnectionArgs{
	PrivateConnectionId: pulumi.String("string"),
	DisplayName:         pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	Project:        pulumi.String("string"),
	RequestId:      pulumi.String("string"),
	SkipValidation: pulumi.Bool(false),
	VpcPeeringConfig: &datamigration.VpcPeeringConfigArgs{
		Subnet:  pulumi.String("string"),
		VpcName: pulumi.String("string"),
	},
})
Copy
var privateConnectionResource = new PrivateConnection("privateConnectionResource", PrivateConnectionArgs.builder()
    .privateConnectionId("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .skipValidation(false)
    .vpcPeeringConfig(VpcPeeringConfigArgs.builder()
        .subnet("string")
        .vpcName("string")
        .build())
    .build());
Copy
private_connection_resource = google_native.datamigration.v1.PrivateConnection("privateConnectionResource",
    private_connection_id="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string",
    skip_validation=False,
    vpc_peering_config={
        "subnet": "string",
        "vpc_name": "string",
    })
Copy
const privateConnectionResource = new google_native.datamigration.v1.PrivateConnection("privateConnectionResource", {
    privateConnectionId: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
    skipValidation: false,
    vpcPeeringConfig: {
        subnet: "string",
        vpcName: "string",
    },
});
Copy
type: google-native:datamigration/v1:PrivateConnection
properties:
    displayName: string
    labels:
        string: string
    location: string
    name: string
    privateConnectionId: string
    project: string
    requestId: string
    skipValidation: false
    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:

PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
Required. The private connection identifier.
DisplayName string
The private connection display name.
Labels Dictionary<string, string>
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Location Changes to this property will trigger replacement. string
Name string
The name of the resource.
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
SkipValidation bool
Optional. If set to true, will skip validations.
VpcPeeringConfig Pulumi.GoogleNative.Datamigration.V1.Inputs.VpcPeeringConfig
VPC peering configuration.
PrivateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
Required. The private connection identifier.
DisplayName string
The private connection display name.
Labels map[string]string
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Location Changes to this property will trigger replacement. string
Name string
The name of the resource.
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
SkipValidation bool
Optional. If set to true, will skip validations.
VpcPeeringConfig VpcPeeringConfigArgs
VPC peering configuration.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
Required. The private connection identifier.
displayName String
The private connection display name.
labels Map<String,String>
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location Changes to this property will trigger replacement. String
name String
The name of the resource.
project Changes to this property will trigger replacement. String
requestId String
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation Boolean
Optional. If set to true, will skip validations.
vpcPeeringConfig VpcPeeringConfig
VPC peering configuration.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
string
Required. The private connection identifier.
displayName string
The private connection display name.
labels {[key: string]: string}
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location Changes to this property will trigger replacement. string
name string
The name of the resource.
project Changes to this property will trigger replacement. string
requestId string
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation boolean
Optional. If set to true, will skip validations.
vpcPeeringConfig VpcPeeringConfig
VPC peering configuration.
private_connection_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The private connection identifier.
display_name str
The private connection display name.
labels Mapping[str, str]
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location Changes to this property will trigger replacement. str
name str
The name of the resource.
project Changes to this property will trigger replacement. str
request_id str
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skip_validation bool
Optional. If set to true, will skip validations.
vpc_peering_config VpcPeeringConfigArgs
VPC peering configuration.
privateConnectionId
This property is required.
Changes to this property will trigger replacement.
String
Required. The private connection identifier.
displayName String
The private connection display name.
labels Map<String>
The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location Changes to this property will trigger replacement. String
name String
The name of the resource.
project Changes to this property will trigger replacement. String
requestId String
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation Boolean
Optional. If set to true, will skip validations.
vpcPeeringConfig Property Map
VPC peering configuration.

Outputs

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

CreateTime string
The create time of the resource.
Error Pulumi.GoogleNative.Datamigration.V1.Outputs.StatusResponse
The error details in case of state FAILED.
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the private connection.
UpdateTime string
The last update time of the resource.
CreateTime string
The create time of the resource.
Error StatusResponse
The error details in case of state FAILED.
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the private connection.
UpdateTime string
The last update time of the resource.
createTime String
The create time of the resource.
error StatusResponse
The error details in case of state FAILED.
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the private connection.
updateTime String
The last update time of the resource.
createTime string
The create time of the resource.
error StatusResponse
The error details in case of state FAILED.
id string
The provider-assigned unique ID for this managed resource.
state string
The state of the private connection.
updateTime string
The last update time of the resource.
create_time str
The create time of the resource.
error StatusResponse
The error details in case of state FAILED.
id str
The provider-assigned unique ID for this managed resource.
state str
The state of the private connection.
update_time str
The last update time of the resource.
createTime String
The create time of the resource.
error Property Map
The error details in case of state FAILED.
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the private connection.
updateTime String
The last update time of the resource.

Supporting Types

StatusResponse
, StatusResponseArgs

Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. List<ImmutableDictionary<string, string>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []map[string]string
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String,String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[key: string]: string}[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. Sequence[Mapping[str, str]]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. str
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

VpcPeeringConfig
, VpcPeeringConfigArgs

Subnet This property is required. string
A free subnet for peering. (CIDR of /29)
VpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
Subnet This property is required. string
A free subnet for peering. (CIDR of /29)
VpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. String
A free subnet for peering. (CIDR of /29)
vpcName This property is required. String
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. string
A free subnet for peering. (CIDR of /29)
vpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. str
A free subnet for peering. (CIDR of /29)
vpc_name This property is required. str
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. String
A free subnet for peering. (CIDR of /29)
vpcName This property is required. String
Fully qualified name of the VPC that Database Migration Service will peer to.

VpcPeeringConfigResponse
, VpcPeeringConfigResponseArgs

Subnet This property is required. string
A free subnet for peering. (CIDR of /29)
VpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
Subnet This property is required. string
A free subnet for peering. (CIDR of /29)
VpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. String
A free subnet for peering. (CIDR of /29)
vpcName This property is required. String
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. string
A free subnet for peering. (CIDR of /29)
vpcName This property is required. string
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. str
A free subnet for peering. (CIDR of /29)
vpc_name This property is required. str
Fully qualified name of the VPC that Database Migration Service will peer to.
subnet This property is required. String
A free subnet for peering. (CIDR of /29)
vpcName This property is required. String
Fully qualified name of the VPC that Database Migration Service will peer to.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi