permalink |
---|
/compute_target_instance/ |
compute_target_instance
represents the google_compute_target_instance
Terraform resource.
This package contains functions and utilities for setting up the resource using Jsonnet code.
fn new()
fn newAttrs()
fn withDescription()
fn withInstance()
fn withName()
fn withNatPolicy()
fn withProject()
fn withTimeouts()
fn withTimeoutsMixin()
fn withZone()
obj timeouts
new()
google.compute_target_instance.new
injects a new google_compute_target_instance
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_target_instance.new('some_id')
You can get the reference to the id
field of the created google.compute_target_instance
using the reference:
$._ref.google_compute_target_instance.some_id.get('id')
This is the same as directly entering "${ google_compute_target_instance.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.description
(string
): An optional description of this resource. Whennull
, thedescription
field will be omitted from the resulting object.instance
(string
): The Compute instance VM handling traffic for this target instance. Accepts the instance self-link, relative path (e.g. 'projects/project/zones/zone/instances/instance') or name. If name is given, the zone will default to the given zone or the provider-default zone and the project will default to the provider-level project.name
(string
): Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.nat_policy
(string
): NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] Whennull
, thenat_policy
field will be omitted from the resulting object.project
(string
): Set theproject
field on the resulting resource block. Whennull
, theproject
field will be omitted from the resulting object.zone
(string
): URL of the zone where the target instance resides. Whennull
, thezone
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting resource block. Whennull
, thetimeouts
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_target_instance.timeouts.new constructor.
Returns:
- A mixin object that injects the new resource into the root Terraform configuration.
newAttrs()
google.compute_target_instance.newAttrs
constructs a new object with attributes and blocks configured for the compute_target_instance
Terraform resource.
Unlike google.compute_target_instance.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:
description
(string
): An optional description of this resource. Whennull
, thedescription
field will be omitted from the resulting object.instance
(string
): The Compute instance VM handling traffic for this target instance. Accepts the instance self-link, relative path (e.g. 'projects/project/zones/zone/instances/instance') or name. If name is given, the zone will default to the given zone or the provider-default zone and the project will default to the provider-level project.name
(string
): Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.nat_policy
(string
): NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] Whennull
, thenat_policy
field will be omitted from the resulting object.project
(string
): Set theproject
field on the resulting object. Whennull
, theproject
field will be omitted from the resulting object.zone
(string
): URL of the zone where the target instance resides. Whennull
, thezone
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting object. Whennull
, thetimeouts
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_target_instance.timeouts.new constructor.
Returns:
- An attribute object that can be used with tf.withResource to construct a new
compute_target_instance
resource into the root Terraform configuration.
withDescription()
google.string.withDescription
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the description field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thedescription
field.
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 theinstance
field.
withName()
google.string.withName
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the name field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thename
field.
withNatPolicy()
google.string.withNatPolicy
constructs a mixin object that can be merged into the string
Terraform resource block to set or update the nat_policy field.
Args:
resourceLabel
(string
): The name label of the block to update.value
(string
): The value to set for thenat_policy
field.
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 theproject
field.
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 thetimeouts
field.
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 thetimeouts
field.
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 thezone
field.
new()
google.compute_target_instance.timeouts.new
constructs a new object with attributes and blocks configured for the timeouts
Terraform sub block.
Args:
create
(string
): Set thecreate
field on the resulting object. Whennull
, thecreate
field will be omitted from the resulting object.delete
(string
): Set thedelete
field on the resulting object. Whennull
, thedelete
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
timeouts
sub block.