Skip to content

Latest commit

 

History

History
255 lines (157 loc) · 8.26 KB

wafregional_rate_based_rule.md

File metadata and controls

255 lines (157 loc) · 8.26 KB
Raw
permalink
/wafregional_rate_based_rule/

wafregional_rate_based_rule

wafregional_rate_based_rule represents the aws_wafregional_rate_based_rule Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

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

Returns:

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

fn newAttrs

newAttrs()

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

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

  • metric_name (string): Set the metric_name field on the resulting object.
  • name (string): Set the name field on the resulting object.
  • rate_key (string): Set the rate_key field on the resulting object.
  • rate_limit (number): Set the rate_limit 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.
  • predicate (list[obj]): Set the predicate field on the resulting object. When null, the predicate sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.wafregional_rate_based_rule.predicate.new constructor.

Returns:

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

fn withMetricName

withMetricName()

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

Args:

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

withPredicate()

aws.list[obj].withPredicate constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the predicate 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].withPredicateMixin function.

Args:

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

fn withPredicateMixin

withPredicateMixin()

aws.list[obj].withPredicateMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the predicate 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].withPredicate function.

Args:

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

fn withRateKey

withRateKey()

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

Args:

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

fn withRateLimit

withRateLimit()

aws.number.withRateLimit constructs a mixin object that can be merged into the number Terraform resource block to set or update the rate_limit field.

Args:

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

fn predicate.new

new()

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

Args:

  • data_id (string): Set the data_id field on the resulting object.
  • negated (bool): Set the negated field on the resulting object.
  • type (string): Set the type field on the resulting object.

Returns:

  • An attribute object that represents the predicate sub block.