NetworkEndpoint

A Network endpoint represents a IP address and port combination that is part of a specific network endpoint group (NEG). NEGs are zonals collection of these endpoints for GCP resources within a single subnet. NOTE: Network endpoints cannot be created outside of a network endpoint group.

To get more information about NetworkEndpoint, see:

API documentation
How-to Guides
- Official Documentation

Create a NetworkEndpoint Resource

new NetworkEndpoint(name: string, args: NetworkEndpointArgs, opts?: CustomResourceOptions);

def NetworkEndpoint(resource_name, opts=None, instance=None, ip_address=None, network_endpoint_group=None, port=None, project=None, zone=None, __props__=None);

func NewNetworkEndpoint(ctx *Context, name string, args NetworkEndpointArgs, opts ...ResourceOption) (*NetworkEndpoint, error)

public NetworkEndpoint(string name, NetworkEndpointArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkEndpointArgs: 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 NetworkEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

NetworkEndpoint Resource Properties

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

Inputs

The NetworkEndpoint resource accepts the following input properties:

Instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
IpAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
NetworkEndpointGroup string: The network endpoint group this endpoint is part of.
Port int: Port number of network endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where the containing network endpoint group is located.

Instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
IpAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
NetworkEndpointGroup string: The network endpoint group this endpoint is part of.
Port int: Port number of network endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where the containing network endpoint group is located.

instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
ipAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
networkEndpointGroup string: The network endpoint group this endpoint is part of.
port number: Port number of network endpoint.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone string: Zone where the containing network endpoint group is located.

instance str: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
ip_address str: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
network_endpoint_group str: The network endpoint group this endpoint is part of.
port float: Port number of network endpoint.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone str: Zone where the containing network endpoint group is located.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkEndpoint 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 NetworkEndpoint Resource

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

static get(resource_name, id, opts=None, instance=None, ip_address=None, network_endpoint_group=None, port=None, project=None, zone=None, __props__=None);

func GetNetworkEndpoint(ctx *Context, name string, id IDInput, state *NetworkEndpointState, opts ...ResourceOption) (*NetworkEndpoint, error)

public static NetworkEndpoint Get(string name, Input<string> id, NetworkEndpointState? 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:

Instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
IpAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
NetworkEndpointGroup string: The network endpoint group this endpoint is part of.
Port int: Port number of network endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where the containing network endpoint group is located.

Instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
IpAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
NetworkEndpointGroup string: The network endpoint group this endpoint is part of.
Port int: Port number of network endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where the containing network endpoint group is located.

instance string: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
ipAddress string: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
networkEndpointGroup string: The network endpoint group this endpoint is part of.
port number: Port number of network endpoint.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone string: Zone where the containing network endpoint group is located.

instance str: The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
ip_address str: IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).
network_endpoint_group str: The network endpoint group this endpoint is part of.
port float: Port number of network endpoint.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone str: Zone where the containing network endpoint group is located.

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