Skip to main content

Initializers


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: typing.Mapping[typing.Any]

for_expression_for_list

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.

for_expression_for_map

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.

key_expressionRequired

The expression to use as key in the for mapping.

value_expressionRequired

The expression to use as value in the for mapping.

get_any

attributeRequired

  • Type: str
name of the property to retrieve.

get_any_map

attributeRequired

  • Type: str
name of the property to retrieve.

get_boolean

attributeRequired

  • Type: str
name of the property to retrieve.

get_boolean_map

attributeRequired

  • Type: str
name of the property to retrieve.

get_list

attributeRequired

  • Type: str
name of the property to retrieve.

get_map

attributeRequired

  • Type: str
name of the property to retrieve.

get_number

attributeRequired

  • Type: str
name of the property to retrieve.

get_number_list

attributeRequired

  • Type: str
name of the property to retrieve.

get_number_map

attributeRequired

  • Type: str
name of the property to retrieve.

get_string

attributeRequired

  • Type: str
name of the property to retrieve.

get_string_map

attributeRequired

  • Type: str
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.

pluck_property

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: str
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


from_complex_list

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.

map_key_attribute_nameRequired

  • Type: str
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.

from_data_sources

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

resourceRequired


from_list

Creates a new iterator from a list.

listRequired

  • Type: typing.List[str] | IResolvable | typing.List[typing.Union[int, float]] | typing.List[bool | IResolvable]

from_map

Creates a new iterator from a map.

mapRequired

  • Type: ComplexMap | typing.Mapping[typing.Any] | typing.Mapping[str] | typing.Mapping[typing.Union[int, float]] | typing.Mapping[bool]

from_resources

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

resourceRequired