pulumi-gcp 8.37.0a1751903932__py3-none-any.whl → 8.39.0a1752699425__py3-none-any.whl

pulumi_gcp/networkmanagement/get_connectivity_test_run.py

@@ -0,0 +1,255 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+
+__all__ = [
+    'GetConnectivityTestRunResult',
+    'AwaitableGetConnectivityTestRunResult',
+    'get_connectivity_test_run',
+    'get_connectivity_test_run_output',
+]
+
+@pulumi.output_type
+class GetConnectivityTestRunResult:
+    """
+    A collection of values returned by getConnectivityTestRun.
+    """
+    def __init__(__self__, id=None, name=None, project=None, reachability_details=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if project and not isinstance(project, str):
+            raise TypeError("Expected argument 'project' to be a str")
+        pulumi.set(__self__, "project", project)
+        if reachability_details and not isinstance(reachability_details, list):
+            raise TypeError("Expected argument 'reachability_details' to be a list")
+        pulumi.set(__self__, "reachability_details", reachability_details)
+
+    @property
+    @pulumi.getter
+    def id(self) -> builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> builtins.str:
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def project(self) -> builtins.str:
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter(name="reachabilityDetails")
+    def reachability_details(self) -> Sequence['outputs.GetConnectivityTestRunReachabilityDetailResult']:
+        """
+        Connectivity test reachability details.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "reachability_details")
+
+
+class AwaitableGetConnectivityTestRunResult(GetConnectivityTestRunResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetConnectivityTestRunResult(
+            id=self.id,
+            name=self.name,
+            project=self.project,
+            reachability_details=self.reachability_details)
+
+
+def get_connectivity_test_run(name: Optional[builtins.str] = None,
+                              project: Optional[builtins.str] = None,
+                              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetConnectivityTestRunResult:
+    """
+    !> This datasource triggers side effects on the target resource. It will take a long time to refresh (i.e. `pulumi preview` will take much longer than usual) and may modify the state of the parent resource or other copies of the resource copying the same parent.
+
+    A connectivity test is 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. This data source allows
+    you to trigger a rerun operation on a connectivity test and return the results.
+
+    To get more information about connectivity tests, see:
+
+    * [API documentation](https://cloud.google.com/network-intelligence-center/docs/reference/networkmanagement/rest/v1/projects.locations.global.connectivityTests/rerun)
+    * How-to Guides
+        * [Official Documentation](https://cloud.google.com/network-intelligence-center/docs)
+
+    ## Example Usage
+
+    ### Network Management Connectivity Test Run Instances
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    vpc = gcp.compute.Network("vpc", name="conn-test-net")
+    debian9 = gcp.compute.get_image(family="debian-11",
+        project="debian-cloud")
+    source = gcp.compute.Instance("source",
+        network_interfaces=[{
+            "access_configs": [{}],
+            "network": vpc.id,
+        }],
+        name="source-vm",
+        machine_type="e2-medium",
+        boot_disk={
+            "initialize_params": {
+                "image": debian9.id,
+            },
+        })
+    destination = gcp.compute.Instance("destination",
+        network_interfaces=[{
+            "access_configs": [{}],
+            "network": vpc.id,
+        }],
+        name="dest-vm",
+        machine_type="e2-medium",
+        boot_disk={
+            "initialize_params": {
+                "image": debian9.id,
+            },
+        })
+    instance_test = gcp.networkmanagement.ConnectivityTest("instance-test",
+        name="conn-test-instances",
+        source={
+            "instance": source.id,
+        },
+        destination={
+            "instance": destination.id,
+        },
+        protocol="TCP",
+        labels={
+            "env": "test",
+        })
+    instance_test_run = gcp.networkmanagement.get_connectivity_test_run_output(name=instance_test.name)
+    ```
+
+
+    :param builtins.str name: Unique name for the connectivity test.
+           
+           
+           - - -
+    :param builtins.str project: The ID of the project in which the resource belongs.
+           If it is not provided, the provider project is used.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    __args__['project'] = project
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('gcp:networkmanagement/getConnectivityTestRun:getConnectivityTestRun', __args__, opts=opts, typ=GetConnectivityTestRunResult).value
+
+    return AwaitableGetConnectivityTestRunResult(
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        project=pulumi.get(__ret__, 'project'),
+        reachability_details=pulumi.get(__ret__, 'reachability_details'))
+def get_connectivity_test_run_output(name: Optional[pulumi.Input[builtins.str]] = None,
+                                     project: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetConnectivityTestRunResult]:
+    """
+    !> This datasource triggers side effects on the target resource. It will take a long time to refresh (i.e. `pulumi preview` will take much longer than usual) and may modify the state of the parent resource or other copies of the resource copying the same parent.
+
+    A connectivity test is 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. This data source allows
+    you to trigger a rerun operation on a connectivity test and return the results.
+
+    To get more information about connectivity tests, see:
+
+    * [API documentation](https://cloud.google.com/network-intelligence-center/docs/reference/networkmanagement/rest/v1/projects.locations.global.connectivityTests/rerun)
+    * How-to Guides
+        * [Official Documentation](https://cloud.google.com/network-intelligence-center/docs)
+
+    ## Example Usage
+
+    ### Network Management Connectivity Test Run Instances
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    vpc = gcp.compute.Network("vpc", name="conn-test-net")
+    debian9 = gcp.compute.get_image(family="debian-11",
+        project="debian-cloud")
+    source = gcp.compute.Instance("source",
+        network_interfaces=[{
+            "access_configs": [{}],
+            "network": vpc.id,
+        }],
+        name="source-vm",
+        machine_type="e2-medium",
+        boot_disk={
+            "initialize_params": {
+                "image": debian9.id,
+            },
+        })
+    destination = gcp.compute.Instance("destination",
+        network_interfaces=[{
+            "access_configs": [{}],
+            "network": vpc.id,
+        }],
+        name="dest-vm",
+        machine_type="e2-medium",
+        boot_disk={
+            "initialize_params": {
+                "image": debian9.id,
+            },
+        })
+    instance_test = gcp.networkmanagement.ConnectivityTest("instance-test",
+        name="conn-test-instances",
+        source={
+            "instance": source.id,
+        },
+        destination={
+            "instance": destination.id,
+        },
+        protocol="TCP",
+        labels={
+            "env": "test",
+        })
+    instance_test_run = gcp.networkmanagement.get_connectivity_test_run_output(name=instance_test.name)
+    ```
+
+
+    :param builtins.str name: Unique name for the connectivity test.
+           
+           
+           - - -
+    :param builtins.str project: The ID of the project in which the resource belongs.
+           If it is not provided, the provider project is used.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    __args__['project'] = project
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('gcp:networkmanagement/getConnectivityTestRun:getConnectivityTestRun', __args__, opts=opts, typ=GetConnectivityTestRunResult)
+    return __ret__.apply(lambda __response__: GetConnectivityTestRunResult(
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name'),
+        project=pulumi.get(__response__, 'project'),
+        reachability_details=pulumi.get(__response__, 'reachability_details')))

pulumi_gcp/networkmanagement/outputs.py

@@ -22,6 +22,10 @@ __all__ = [
     'ConnectivityTestSourceAppEngineVersion',
     'ConnectivityTestSourceCloudFunction',
     'ConnectivityTestSourceCloudRunRevision',
+    'GetConnectivityTestRunReachabilityDetailResult',
+    'GetConnectivityTestRunReachabilityDetailTraceResult',
+    'GetConnectivityTestRunReachabilityDetailTraceEndpointInfoResult',
+    'GetConnectivityTestRunReachabilityDetailTraceStepResult',
 ]
 
 @pulumi.output_type
@@ -89,8 +93,6 @@ class ConnectivityTestDestination(dict):
                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.
-               
-               - - -
         :param builtins.str redis_cluster: A Redis Cluster URI.
         :param builtins.str redis_instance: A Redis Instance URI.
         """
@@ -198,8 +200,6 @@ class ConnectivityTestDestination(dict):
         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.
-
-        - - -
         """
         return pulumi.get(self, "project_id")
 
@@ -473,3 +473,273 @@ class ConnectivityTestSourceCloudRunRevision(dict):
         return pulumi.get(self, "uri")
 
 
+@pulumi.output_type
+class GetConnectivityTestRunReachabilityDetailResult(dict):
+    def __init__(__self__, *,
+                 result: builtins.str,
+                 traces: Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceResult'],
+                 verify_time: builtins.str):
+        """
+        :param builtins.str result: (Output)
+               Status of the connectivity test: RESULT_UNSPECIFIED, REACHABLE, UNREACHABLE, AMBIGUOUS or UNDETERMINED.
+        :param Sequence['GetConnectivityTestRunReachabilityDetailTraceArgs'] traces: (Output)
+               List of connectivity test traces.
+               Structure is documented below.
+        :param builtins.str verify_time: (Output)
+               Time when reachability details were determined. An RFC3339 timestamp in UTC time.
+               This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ.
+        """
+        pulumi.set(__self__, "result", result)
+        pulumi.set(__self__, "traces", traces)
+        pulumi.set(__self__, "verify_time", verify_time)
+
+    @property
+    @pulumi.getter
+    def result(self) -> builtins.str:
+        """
+        (Output)
+        Status of the connectivity test: RESULT_UNSPECIFIED, REACHABLE, UNREACHABLE, AMBIGUOUS or UNDETERMINED.
+        """
+        return pulumi.get(self, "result")
+
+    @property
+    @pulumi.getter
+    def traces(self) -> Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceResult']:
+        """
+        (Output)
+        List of connectivity test traces.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "traces")
+
+    @property
+    @pulumi.getter(name="verifyTime")
+    def verify_time(self) -> builtins.str:
+        """
+        (Output)
+        Time when reachability details were determined. An RFC3339 timestamp in UTC time.
+        This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ.
+        """
+        return pulumi.get(self, "verify_time")
+
+
+@pulumi.output_type
+class GetConnectivityTestRunReachabilityDetailTraceResult(dict):
+    def __init__(__self__, *,
+                 endpoint_infos: Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceEndpointInfoResult'],
+                 forward_trace_id: builtins.int,
+                 steps: Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceStepResult']):
+        """
+        :param Sequence['GetConnectivityTestRunReachabilityDetailTraceEndpointInfoArgs'] endpoint_infos: (Output)
+               Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model.
+               Structure is documented below.
+        :param builtins.int forward_trace_id: (Output)
+               ID of the trace.
+        :param Sequence['GetConnectivityTestRunReachabilityDetailTraceStepArgs'] steps: (Output)
+               A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted).
+               Structure is documented below.
+        """
+        pulumi.set(__self__, "endpoint_infos", endpoint_infos)
+        pulumi.set(__self__, "forward_trace_id", forward_trace_id)
+        pulumi.set(__self__, "steps", steps)
+
+    @property
+    @pulumi.getter(name="endpointInfos")
+    def endpoint_infos(self) -> Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceEndpointInfoResult']:
+        """
+        (Output)
+        Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "endpoint_infos")
+
+    @property
+    @pulumi.getter(name="forwardTraceId")
+    def forward_trace_id(self) -> builtins.int:
+        """
+        (Output)
+        ID of the trace.
+        """
+        return pulumi.get(self, "forward_trace_id")
+
+    @property
+    @pulumi.getter
+    def steps(self) -> Sequence['outputs.GetConnectivityTestRunReachabilityDetailTraceStepResult']:
+        """
+        (Output)
+        A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted).
+        Structure is documented below.
+        """
+        return pulumi.get(self, "steps")
+
+
+@pulumi.output_type
+class GetConnectivityTestRunReachabilityDetailTraceEndpointInfoResult(dict):
+    def __init__(__self__, *,
+                 destination_ip: builtins.str,
+                 destination_network_uri: builtins.str,
+                 destination_port: builtins.int,
+                 protocol: builtins.str,
+                 source_agent_uri: builtins.str,
+                 source_ip: builtins.str,
+                 source_network_uri: builtins.str,
+                 source_port: builtins.int):
+        """
+        :param builtins.str destination_ip: (Output)
+               Destination IP address.
+        :param builtins.str destination_network_uri: (Output)
+               URI of the network where this packet is sent to.
+        :param builtins.int destination_port: (Output)
+               Destination port. Only valid when protocol is TCP or UDP.
+        :param builtins.str protocol: (Output)
+               IP protocol in string format, for example: "TCP", "UDP", "ICMP".
+        :param builtins.str source_agent_uri: (Output)
+               URI of the source telemetry agent this packet originates from.
+        :param builtins.str source_ip: (Output)
+               Source IP address.
+        :param builtins.str source_network_uri: (Output)
+               URI of the network where this packet originates from.
+        :param builtins.int source_port: (Output)
+               Source port. Only valid when protocol is TCP or UDP.
+        """
+        pulumi.set(__self__, "destination_ip", destination_ip)
+        pulumi.set(__self__, "destination_network_uri", destination_network_uri)
+        pulumi.set(__self__, "destination_port", destination_port)
+        pulumi.set(__self__, "protocol", protocol)
+        pulumi.set(__self__, "source_agent_uri", source_agent_uri)
+        pulumi.set(__self__, "source_ip", source_ip)
+        pulumi.set(__self__, "source_network_uri", source_network_uri)
+        pulumi.set(__self__, "source_port", source_port)
+
+    @property
+    @pulumi.getter(name="destinationIp")
+    def destination_ip(self) -> builtins.str:
+        """
+        (Output)
+        Destination IP address.
+        """
+        return pulumi.get(self, "destination_ip")
+
+    @property
+    @pulumi.getter(name="destinationNetworkUri")
+    def destination_network_uri(self) -> builtins.str:
+        """
+        (Output)
+        URI of the network where this packet is sent to.
+        """
+        return pulumi.get(self, "destination_network_uri")
+
+    @property
+    @pulumi.getter(name="destinationPort")
+    def destination_port(self) -> builtins.int:
+        """
+        (Output)
+        Destination port. Only valid when protocol is TCP or UDP.
+        """
+        return pulumi.get(self, "destination_port")
+
+    @property
+    @pulumi.getter
+    def protocol(self) -> builtins.str:
+        """
+        (Output)
+        IP protocol in string format, for example: "TCP", "UDP", "ICMP".
+        """
+        return pulumi.get(self, "protocol")
+
+    @property
+    @pulumi.getter(name="sourceAgentUri")
+    def source_agent_uri(self) -> builtins.str:
+        """
+        (Output)
+        URI of the source telemetry agent this packet originates from.
+        """
+        return pulumi.get(self, "source_agent_uri")
+
+    @property
+    @pulumi.getter(name="sourceIp")
+    def source_ip(self) -> builtins.str:
+        """
+        (Output)
+        Source IP address.
+        """
+        return pulumi.get(self, "source_ip")
+
+    @property
+    @pulumi.getter(name="sourceNetworkUri")
+    def source_network_uri(self) -> builtins.str:
+        """
+        (Output)
+        URI of the network where this packet originates from.
+        """
+        return pulumi.get(self, "source_network_uri")
+
+    @property
+    @pulumi.getter(name="sourcePort")
+    def source_port(self) -> builtins.int:
+        """
+        (Output)
+        Source port. Only valid when protocol is TCP or UDP.
+        """
+        return pulumi.get(self, "source_port")
+
+
+@pulumi.output_type
+class GetConnectivityTestRunReachabilityDetailTraceStepResult(dict):
+    def __init__(__self__, *,
+                 causes_drop: builtins.bool,
+                 description: builtins.str,
+                 project_id: builtins.str,
+                 state: builtins.str):
+        """
+        :param builtins.bool causes_drop: (Output)
+               If this step leads to the final state Drop.
+        :param builtins.str description: (Output)
+               Description of the connectivity test step.
+        :param builtins.str project_id: (Output)
+               Project ID of the connectivity test step.
+        :param builtins.str state: (Output)
+               State of the connectivity test step.
+        """
+        pulumi.set(__self__, "causes_drop", causes_drop)
+        pulumi.set(__self__, "description", description)
+        pulumi.set(__self__, "project_id", project_id)
+        pulumi.set(__self__, "state", state)
+
+    @property
+    @pulumi.getter(name="causesDrop")
+    def causes_drop(self) -> builtins.bool:
+        """
+        (Output)
+        If this step leads to the final state Drop.
+        """
+        return pulumi.get(self, "causes_drop")
+
+    @property
+    @pulumi.getter
+    def description(self) -> builtins.str:
+        """
+        (Output)
+        Description of the connectivity test step.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> builtins.str:
+        """
+        (Output)
+        Project ID of the connectivity test step.
+        """
+        return pulumi.get(self, "project_id")
+
+    @property
+    @pulumi.getter
+    def state(self) -> builtins.str:
+        """
+        (Output)
+        State of the connectivity test step.
+        """
+        return pulumi.get(self, "state")
+
+

pulumi_gcp/networkmanagement/vpc_flow_logs_config.py

@@ -39,9 +39,6 @@ class VpcFlowLogsConfigArgs:
                within its parent collection as described in https://google.aip.dev/122. See documentation
                for resource type `networkmanagement.googleapis.com/VpcFlowLogsConfig`.
         :param pulumi.Input[builtins.str] vpc_flow_logs_config_id: Required. ID of the `VpcFlowLogsConfig`.
-               
-               
-               - - -
         :param pulumi.Input[builtins.str] aggregation_interval: Optional. The aggregation interval for the logs. Default value is
                INTERVAL_5_SEC.   Possible values:  AGGREGATION_INTERVAL_UNSPECIFIED INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN"
         :param pulumi.Input[builtins.str] description: Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum
@@ -111,9 +108,6 @@ class VpcFlowLogsConfigArgs:
     def vpc_flow_logs_config_id(self) -> pulumi.Input[builtins.str]:
         """
         Required. ID of the `VpcFlowLogsConfig`.
-
-
-        - - -
         """
         return pulumi.get(self, "vpc_flow_logs_config_id")
 
@@ -323,9 +317,6 @@ class _VpcFlowLogsConfigState:
                is ENABLED. When creating a new configuration, it must be enabled.   Possible
         :param pulumi.Input[builtins.str] update_time: Output only. The time the config was updated.
         :param pulumi.Input[builtins.str] vpc_flow_logs_config_id: Required. ID of the `VpcFlowLogsConfig`.
-               
-               
-               - - -
         :param pulumi.Input[builtins.str] vpn_tunnel: Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
         """
         if aggregation_interval is not None:
@@ -578,9 +569,6 @@ class _VpcFlowLogsConfigState:
     def vpc_flow_logs_config_id(self) -> Optional[pulumi.Input[builtins.str]]:
         """
         Required. ID of the `VpcFlowLogsConfig`.
-
-
-        - - -
         """
         return pulumi.get(self, "vpc_flow_logs_config_id")
 
@@ -840,9 +828,6 @@ class VpcFlowLogsConfig(pulumi.CustomResource):
         :param pulumi.Input[builtins.str] state: Optional. The state of the VPC Flow Log configuration. Default value
                is ENABLED. When creating a new configuration, it must be enabled.   Possible
         :param pulumi.Input[builtins.str] vpc_flow_logs_config_id: Required. ID of the `VpcFlowLogsConfig`.
-               
-               
-               - - -
         :param pulumi.Input[builtins.str] vpn_tunnel: Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
         """
         ...
@@ -1170,9 +1155,6 @@ class VpcFlowLogsConfig(pulumi.CustomResource):
                is ENABLED. When creating a new configuration, it must be enabled.   Possible
         :param pulumi.Input[builtins.str] update_time: Output only. The time the config was updated.
         :param pulumi.Input[builtins.str] vpc_flow_logs_config_id: Required. ID of the `VpcFlowLogsConfig`.
-               
-               
-               - - -
         :param pulumi.Input[builtins.str] vpn_tunnel: Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
@@ -1348,9 +1330,6 @@ class VpcFlowLogsConfig(pulumi.CustomResource):
     def vpc_flow_logs_config_id(self) -> pulumi.Output[builtins.str]:
         """
         Required. ID of the `VpcFlowLogsConfig`.
-
-
-        - - -
         """
         return pulumi.get(self, "vpc_flow_logs_config_id")