Skip to content

Latest commit

 

History

History
234 lines (144 loc) · 8.03 KB

default_route_table.md

File metadata and controls

234 lines (144 loc) · 8.03 KB
permalink
/default_route_table/

default_route_table

default_route_table represents the aws_default_route_table Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_default_route_table.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.
  • default_route_table_id (string): Set the default_route_table_id field on the resulting resource block.
  • propagating_vgws (list): Set the propagating_vgws field on the resulting resource block. When null, the propagating_vgws field will be omitted from the resulting object.
  • route (list): Set the route field on the resulting resource block. When null, the route 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.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.default_route_table.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • default_route_table_id (string): Set the default_route_table_id field on the resulting object.
  • propagating_vgws (list): Set the propagating_vgws field on the resulting object. When null, the propagating_vgws field will be omitted from the resulting object.
  • route (list): Set the route field on the resulting object. When null, the route 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.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.default_route_table.timeouts.new constructor.

Returns:

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

fn withDefaultRouteTableId

withDefaultRouteTableId()

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

Args:

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

fn withPropagatingVgws

withPropagatingVgws()

aws.list.withPropagatingVgws constructs a mixin object that can be merged into the list Terraform resource block to set or update the propagating_vgws field.

Args:

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

fn withRoute

withRoute()

aws.list.withRoute constructs a mixin object that can be merged into the list Terraform resource block to set or update the route field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list): The value to set for the route 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 withTimeouts

withTimeouts()

aws.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 aws.obj.withTimeoutsMixin function.

Args:

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

fn withTimeoutsMixin

withTimeoutsMixin()

aws.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 aws.obj.withTimeouts function.

Args:

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

obj timeouts

fn timeouts.new

new()

aws.default_route_table.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

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

Returns:

  • An attribute object that represents the timeouts sub block.