Skip to content

Latest commit

 

History

History
168 lines (103 loc) · 5.28 KB

evidently_segment.md

File metadata and controls

168 lines (103 loc) · 5.28 KB
Raw
permalink
/evidently_segment/

evidently_segment

evidently_segment represents the aws_evidently_segment Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_evidently_segment.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.
  • pattern (string): Set the pattern 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.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.evidently_segment.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.
  • pattern (string): Set the pattern 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.

Returns:

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

withPattern()

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

Args:

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