This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.
networkmanagement¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.
- class
pulumi_gcp.networkmanagement.ConnectivityTest(resource_name, opts=None, description=None, destination=None, labels=None, name=None, project=None, protocol=None, related_projects=None, source=None, __props__=None, __name__=None, __opts__=None)¶ Create a ConnectivityTest resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The user-supplied description of the Connectivity Test. Maximum of 512 characters. :param pulumi.Input[dict] destination: 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.
- Parameters
labels (pulumi.Input[dict]) – Resource labels to represent user-provided metadata.
name (pulumi.Input[str]) – Unique name for the connectivity test.
protocol (pulumi.Input[str]) – IP Protocol of the test. When not provided, “TCP” is assumed.
related_projects (pulumi.Input[list]) – Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
source (pulumi.Input[dict]) – 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.
The destination object supports the following:
instance(pulumi.Input[str])ip_address(pulumi.Input[str])network(pulumi.Input[str])port(pulumi.Input[float])project_id(pulumi.Input[str])
The source object supports the following:
instance(pulumi.Input[str])ip_address(pulumi.Input[str])network(pulumi.Input[str])networkType(pulumi.Input[str])port(pulumi.Input[float])project_id(pulumi.Input[str])
description: pulumi.Output[str] = None¶The user-supplied description of the Connectivity Test. Maximum of 512 characters.
destination: pulumi.Output[dict] = None¶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.
instance(str)ip_address(str)network(str)port(float)project_id(str)
labels: pulumi.Output[dict] = None¶Resource labels to represent user-provided metadata.
name: pulumi.Output[str] = None¶Unique name for the connectivity test.
protocol: pulumi.Output[str] = None¶IP Protocol of the test. When not provided, “TCP” is assumed.
Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
source: pulumi.Output[dict] = None¶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.
instance(str)ip_address(str)network(str)networkType(str)port(float)project_id(str)
- static
get(resource_name, id, opts=None, description=None, destination=None, labels=None, name=None, project=None, protocol=None, related_projects=None, source=None)¶ Get an existing ConnectivityTest resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The user-supplied description of the Connectivity Test. Maximum of 512 characters.
destination (pulumi.Input[dict]) – 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.
labels (pulumi.Input[dict]) – Resource labels to represent user-provided metadata.
name (pulumi.Input[str]) – Unique name for the connectivity test.
protocol (pulumi.Input[str]) – IP Protocol of the test. When not provided, “TCP” is assumed.
related_projects (pulumi.Input[list]) – Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
source (pulumi.Input[dict]) – 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.
The destination object supports the following:
instance(pulumi.Input[str])ip_address(pulumi.Input[str])network(pulumi.Input[str])port(pulumi.Input[float])project_id(pulumi.Input[str])
The source object supports the following:
instance(pulumi.Input[str])ip_address(pulumi.Input[str])network(pulumi.Input[str])networkType(pulumi.Input[str])port(pulumi.Input[float])project_id(pulumi.Input[str])
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str