Skip to content

Latest commit

 

History

History
216 lines (132 loc) · 7.07 KB

workspaces_ip_group.md

File metadata and controls

216 lines (132 loc) · 7.07 KB
Raw
permalink
/workspaces_ip_group/

workspaces_ip_group

workspaces_ip_group represents the aws_workspaces_ip_group Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

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

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.workspaces_ip_group.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.
  • 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.
  • 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.
  • rules (list[obj]): Set the rules field on the resulting object. When null, the rules sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.workspaces_ip_group.rules.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new workspaces_ip_group 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 withName

withName()

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

Args:

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

fn withRules

withRules()

aws.list[obj].withRules constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the rules field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withRulesMixin function.

Args:

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

fn withRulesMixin

withRulesMixin()

aws.list[obj].withRulesMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the rules field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withRules function.

Args:

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

obj rules

fn rules.new

new()

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

Args:

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

Returns:

  • An attribute object that represents the rules sub block.