Skip to content

Latest commit

 

History

History
187 lines (115 loc) · 6.34 KB

location_tracker.md

File metadata and controls

187 lines (115 loc) · 6.34 KB
Raw
permalink
/location_tracker/

location_tracker

location_tracker represents the aws_location_tracker Terraform resource.

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

Index

Fields

fn new

new()

aws.location_tracker.new injects a new aws_location_tracker 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
aws.location_tracker.new('some_id')

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

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

This is the same as directly entering "${ aws_location_tracker.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): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
  • kms_key_id (string): Set the kms_key_id field on the resulting resource block. When null, the kms_key_id field will be omitted from the resulting object.
  • position_filtering (string): Set the position_filtering field on the resulting resource block. When null, the position_filtering field will be omitted from the resulting object.
  • tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
  • tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
  • tracker_name (string): Set the tracker_name field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

aws.location_tracker.newAttrs constructs a new object with attributes and blocks configured for the location_tracker Terraform resource.

Unlike aws.location_tracker.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): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
  • kms_key_id (string): Set the kms_key_id field on the resulting object. When null, the kms_key_id field will be omitted from the resulting object.
  • position_filtering (string): Set the position_filtering field on the resulting object. When null, the position_filtering field will be omitted from 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.
  • tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
  • tracker_name (string): Set the tracker_name field on the resulting object.

Returns:

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

fn withDescription

withDescription()

aws.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 the description field.

fn withKmsKeyId

withKmsKeyId()

aws.string.withKmsKeyId constructs a mixin object that can be merged into the string Terraform resource block to set or update the kms_key_id field.

Args:

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

fn withPositionFiltering

withPositionFiltering()

aws.string.withPositionFiltering constructs a mixin object that can be merged into the string Terraform resource block to set or update the position_filtering field.

Args:

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

fn withTags

withTags()

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

Args:

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

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

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

fn withTrackerName

withTrackerName()

aws.string.withTrackerName constructs a mixin object that can be merged into the string Terraform resource block to set or update the tracker_name field.

Args:

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