Skip to content

Latest commit

 

History

History
130 lines (79 loc) · 4.29 KB

vpc_access_connector.md

File metadata and controls

130 lines (79 loc) · 4.29 KB
Raw
permalink
/data/vpc_access_connector/

data.vpc_access_connector

vpc_access_connector represents the google_vpc_access_connector Terraform data source.

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

Index

Fields

fn new

new()

google.data.vpc_access_connector.new injects a new data_google_vpc_access_connector Terraform data source 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.data.vpc_access_connector.new('some_id')

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

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

This is the same as directly entering "${ data_google_vpc_access_connector.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:

  • dataSrcLabel (string): The name label of the block.
  • name (string): The name of the resource (Max 25 characters).
  • project (string): Set the project field on the resulting data source block. When null, the project field will be omitted from the resulting object.
  • region (string): Region where the VPC Access connector resides. If it is not provided, the provider region is used. When null, the region field will be omitted from the resulting object.

Returns:

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

fn newAttrs

newAttrs()

google.data.vpc_access_connector.newAttrs constructs a new object with attributes and blocks configured for the vpc_access_connector Terraform data source.

Unlike google.data.vpc_access_connector.new, this function will not inject the data source block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withData 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:

  • name (string): The name of the resource (Max 25 characters).
  • project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.
  • region (string): Region where the VPC Access connector resides. If it is not provided, the provider region is used. When null, the region field will be omitted from the resulting object.

Returns:

  • An attribute object that can be used with tf.withData to construct a new vpc_access_connector data source into the root Terraform configuration.

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform data source block to set or update the name field.

Args:

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

fn withProject

withProject()

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

Args:

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

fn withRegion

withRegion()

google.string.withRegion constructs a mixin object that can be merged into the string Terraform data source block to set or update the region field.

Args:

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