Skip to content

Latest commit

 

History

History
111 lines (67 loc) · 3.47 KB

region.md

File metadata and controls

111 lines (67 loc) · 3.47 KB
Raw
permalink
/data/region/

data.region

region represents the aws_region Terraform data source.

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

Index

Fields

fn new

new()

aws.data.region.new injects a new data_aws_region 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
aws.data.region.new('some_id')

You can get the reference to the id field of the created aws.data.region using the reference:

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

This is the same as directly entering "${ data_aws_region.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.
  • endpoint (string): Set the endpoint field on the resulting data source block. When null, the endpoint field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting data source block. When null, the name 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()

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

Unlike aws.data.region.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:

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

Returns:

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

fn withEndpoint

withEndpoint()

aws.string.withEndpoint constructs a mixin object that can be merged into the string Terraform data source block to set or update the endpoint field.

Args:

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

fn withName

withName()

aws.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.