Skip to content

Latest commit

 

History

History
111 lines (67 loc) · 3.22 KB

elb.md

File metadata and controls

111 lines (67 loc) · 3.22 KB
Raw
permalink
/data/elb/

data.elb

elb represents the aws_elb 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.elb.new injects a new data_aws_elb 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.elb.new('some_id')

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

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

This is the same as directly entering "${ data_aws_elb.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): Set the name field on the resulting data source block.
  • tags (obj): Set the tags field on the resulting data source block. When null, the tags 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.elb.newAttrs constructs a new object with attributes and blocks configured for the elb Terraform data source.

Unlike aws.data.elb.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): Set the name field on the resulting object.
  • tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.

Returns:

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

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.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform data source block to set or update the tags field.

Args:

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