ConnectivityTest

A connectivity test are a static analysis of your resource configurations that enables you to evaluate connectivity to and from Google Cloud resources in your Virtual Private Cloud (VPC) network.

To get more information about ConnectivityTest, see:

API documentation
How-to Guides
- Official Documentation

Create a ConnectivityTest Resource

new ConnectivityTest(name: string, args: ConnectivityTestArgs, opts?: CustomResourceOptions);

def ConnectivityTest(resource_name, opts=None, description=None, destination=None, labels=None, name=None, project=None, protocol=None, related_projects=None, source=None, __props__=None);

func NewConnectivityTest(ctx *Context, name string, args ConnectivityTestArgs, opts ...ResourceOption) (*ConnectivityTest, error)

public ConnectivityTest(string name, ConnectivityTestArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ConnectivityTestArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectivityTestArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectivityTestArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ConnectivityTest Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ConnectivityTest resource accepts the following input properties:

Destination ConnectivityTestDestinationArgs: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
Source ConnectivityTestSourceArgs: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.
Description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
Labels Dictionary<string, string>: Resource labels to represent user-provided metadata.
Name string: Unique name for the connectivity test.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
RelatedProjects List<string>: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Destination ConnectivityTestDestination: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
Source ConnectivityTestSource: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.
Description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
Labels map[string]string: Resource labels to represent user-provided metadata.
Name string: Unique name for the connectivity test.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
RelatedProjects []string: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

destination ConnectivityTestDestination: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
source ConnectivityTestSource: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.
description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
labels {[key: string]: string}: Resource labels to represent user-provided metadata.
name string: Unique name for the connectivity test.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
relatedProjects string[]: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

destination Dict[ConnectivityTestDestination]: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
source Dict[ConnectivityTestSource]: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.
description str: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
labels Dict[str, str]: Resource labels to represent user-provided metadata.
name str: Unique name for the connectivity test.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
protocol str: IP Protocol of the test. When not provided, “TCP” is assumed.
related_projects List[str]: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ConnectivityTest Resource

Get an existing ConnectivityTest 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?: ConnectivityTestState, opts?: CustomResourceOptions): ConnectivityTest

static get(resource_name, id, opts=None, description=None, destination=None, labels=None, name=None, project=None, protocol=None, related_projects=None, source=None, __props__=None);

func GetConnectivityTest(ctx *Context, name string, id IDInput, state *ConnectivityTestState, opts ...ResourceOption) (*ConnectivityTest, error)

public static ConnectivityTest Get(string name, Input<string> id, ConnectivityTestState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
Destination ConnectivityTestDestinationArgs: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
Labels Dictionary<string, string>: Resource labels to represent user-provided metadata.
Name string: Unique name for the connectivity test.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
RelatedProjects List<string>: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
Source ConnectivityTestSourceArgs: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.

Description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
Destination ConnectivityTestDestination: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
Labels map[string]string: Resource labels to represent user-provided metadata.
Name string: Unique name for the connectivity test.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
RelatedProjects []string: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
Source ConnectivityTestSource: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.

description string: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
destination ConnectivityTestDestination: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
labels {[key: string]: string}: Resource labels to represent user-provided metadata.
name string: Unique name for the connectivity test.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
protocol string: IP Protocol of the test. When not provided, “TCP” is assumed.
relatedProjects string[]: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
source ConnectivityTestSource: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.

description str: The user-supplied description of the Connectivity Test. Maximum of 512 characters.
destination Dict[ConnectivityTestDestination]: Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test. Structure is documented below.
labels Dict[str, str]: Resource labels to represent user-provided metadata.
name str: Unique name for the connectivity test.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
protocol str: IP Protocol of the test. When not provided, “TCP” is assumed.
related_projects List[str]: Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
source Dict[ConnectivityTestSource]: Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test. Structure is documented below.

Supporting Types

ConnectivityTestDestination

See the input and output API doc for this type.

Instance string: A Compute Engine instance URI.
IpAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
Network string: A Compute Engine network URI.
Port int: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
ProjectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Instance string: A Compute Engine instance URI.
IpAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
Network string: A Compute Engine network URI.
Port int: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
ProjectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

instance string: A Compute Engine instance URI.
ipAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
network string: A Compute Engine network URI.
port number: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
projectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

instance str: A Compute Engine instance URI.
ip_address str: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
network str: A Compute Engine network URI.
port float: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
project_id str: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

ConnectivityTestSource

See the input and output API doc for this type.

Instance string: A Compute Engine instance URI.
IpAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
Network string: A Compute Engine network URI.
NetworkType string: Type of the network where the endpoint is located.
Port int: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
ProjectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Instance string: A Compute Engine instance URI.
IpAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
Network string: A Compute Engine network URI.
NetworkType string: Type of the network where the endpoint is located.
Port int: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
ProjectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

instance string: A Compute Engine instance URI.
ipAddress string: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
network string: A Compute Engine network URI.
networkType string: Type of the network where the endpoint is located.
port number: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
projectId string: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

instance str: A Compute Engine instance URI.
ip_address str: The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.
network str: A Compute Engine network URI.
networkType str: Type of the network where the endpoint is located.
port float: The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
project_id str: Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud