Skip to main content

Initializers


elementRequired


Methods


dynamic

Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString. See https://cdktn.io/docs/concepts/iterators#using-iterators-for-list-attributes

attributesRequired

  • Type: java.util.Map< java.lang.String, java.lang.Object >

forExpressionForList

Creates a for expression that results in a list. This method allows you to create every possible for expression, but requires more knowledge about Terraform’s for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead. You may write any valid Terraform for each expression, e.g. TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true") will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

expressionRequired

The expression to use in the for mapping.

forExpressionForMap

Creates a for expression that results in a map. This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead. You may write any valid Terraform for each expression, e.g. TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true") will result in \{ for key, val in var.myIteratorSource: key => val.foo if val.bar == true }. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

keyExpressionRequired

The expression to use as key in the for mapping.

valueExpressionRequired

The expression to use as value in the for mapping.

getAny

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getAnyMap

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getBoolean

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getBooleanMap

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getList

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getMap

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getNumber

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getNumberList

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getNumberMap

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getString

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

getStringMap

attributeRequired

  • Type: java.lang.String
name of the property to retrieve.

keys

Creates a for expression that maps the iterators to its keys. For lists these would be the indices, for maps the keys. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

pluckProperty

Creates a for expression that accesses the key on each element of the iterator. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

propertyRequired

  • Type: java.lang.String
The property of the iterators values to map to.

values

Creates a for expression that maps the iterators to its value in case it is a map. For lists these would stay the same. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

Static Functions


fromComplexList

Creates a new iterator from a complex list. One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key. Example

listRequired

the list to iterate over.

mapKeyAttributeNameRequired

  • Type: java.lang.String
the name of the attribute that should be used as the key in the map. Visit https://cdktn.io/docs/concepts/iterators#using-iterators-on-complex-lists for more information.

fromDataSources

Creates a new iterator from a data source that has been created with the for_each argument.

resourceRequired


fromList

Creates a new iterator from a list.

listRequired

  • Type: java.util.List< java.lang.String >|IResolvable|java.util.List< java.lang.Number >|java.util.List<java.lang.Boolean|IResolvable>

fromMap

Creates a new iterator from a map.

mapRequired

  • Type: ComplexMap|java.util.Map< java.lang.String, java.lang.Object >|java.util.Map< java.lang.String, java.lang.String >|java.util.Map< java.lang.String, java.lang.Number >|java.util.Map< java.lang.String, java.lang.Boolean >

fromResources

Creates a new iterator from a resource that has been created with the for_each argument.

resourceRequired


Properties


keyRequired

  • Type: java.lang.Object
Returns the current entry in the list or set that is being iterated over. For lists this is the same as iterator.value. If you need the index, use count via TerraformCount: https://cdktn.io/docs/concepts/iterators#using-count

valueRequired

  • Type: java.lang.Object
Returns the value of the current item iterated over.