compute_network_endpoint.md

permalink
/compute_network_endpoint/

compute_network_endpoint

compute_network_endpoint represents the google_compute_network_endpoint Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withInstance()
• fn withIpAddress()
• fn withNetworkEndpointGroup()
• fn withPort()
• fn withProject()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withZone()
• obj timeouts
  • fn new()

Fields

fn new

new()

google.compute_network_endpoint.new injects a new google_compute_network_endpoint Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.compute_network_endpoint.new('some_id')

You can get the reference to the id field of the created google.compute_network_endpoint using the reference:

$._ref.google_compute_network_endpoint.some_id.get('id')

This is the same as directly entering "${ google_compute_network_endpoint.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• 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. When null, the instance field will be omitted from the resulting object.
• ip_address (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).
• network_endpoint_group (string): The network endpoint group this endpoint is part of.
• port (number): Port number of network endpoint. Note 'port' is required unless the Network Endpoint Group is created with the type of 'GCE_VM_IP' When null, the port field will be omitted from the resulting object.
• project (string): Set the project field on the resulting resource block. When null, the project field will be omitted from the resulting object.
• zone (string): Zone where the containing network endpoint group is located. When null, the zone field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_network_endpoint.timeouts.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.compute_network_endpoint.newAttrs constructs a new object with attributes and blocks configured for the compute_network_endpoint Terraform resource.

Unlike google.compute_network_endpoint.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• 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. When null, the instance field will be omitted from the resulting object.
• ip_address (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).
• network_endpoint_group (string): The network endpoint group this endpoint is part of.
• port (number): Port number of network endpoint. Note 'port' is required unless the Network Endpoint Group is created with the type of 'GCE_VM_IP' When null, the port field will be omitted from the resulting object.
• project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.
• zone (string): Zone where the containing network endpoint group is located. When null, the zone field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_network_endpoint.timeouts.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new compute_network_endpoint resource into the root Terraform configuration.

fn withInstance

withInstance()

google.string.withInstance constructs a mixin object that can be merged into the string Terraform resource block to set or update the instance field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the instance field.

fn withIpAddress

withIpAddress()

google.string.withIpAddress constructs a mixin object that can be merged into the string Terraform resource block to set or update the ip_address field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the ip_address field.

fn withNetworkEndpointGroup

withNetworkEndpointGroup()

google.string.withNetworkEndpointGroup constructs a mixin object that can be merged into the string Terraform resource block to set or update the network_endpoint_group field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the network_endpoint_group field.

fn withPort

withPort()

google.number.withPort constructs a mixin object that can be merged into the number Terraform resource block to set or update the port field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the port field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the project field.

fn withTimeouts

withTimeouts()

google.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the google.obj.withTimeoutsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

google.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the google.obj.withTimeouts function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

fn withZone

withZone()

google.string.withZone constructs a mixin object that can be merged into the string Terraform resource block to set or update the zone field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the zone field.

obj timeouts

fn timeouts.new

new()

google.compute_network_endpoint.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

• create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
• delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.