> ## Documentation Index
> Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Python: ListTerraformIterator
> CDKTN Core API Reference for ListTerraformIterator in Python.
## Initializers
```python theme={null}
import cdktn
cdktn.ListTerraformIterator(
list: typing.List[str] | IResolvable | typing.List[typing.Union[int, float]] | typing.List[bool | IResolvable]
)
```
| **Name** | **Type** | **Description** |
| --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| list | typing.List\[str] \| IResolvable \| typing.List\[typing.Union\[int, float]] \| typing.List\[bool \| IResolvable] | *No description.* |
***
### `list`Required
* *Type:* typing.List\[str] | IResolvable | typing.List\[typing.Union\[int, float]] | typing.List\[bool | IResolvable]
***
## Methods
| **Name** | **Description** |
| ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
| for\_expression\_for\_list | Creates a for expression that results in a list. |
| for\_expression\_for\_map | Creates a for expression that results in a map. |
| get\_any | *No description.* |
| get\_any\_map | *No description.* |
| get\_boolean | *No description.* |
| get\_boolean\_map | *No description.* |
| get\_list | *No description.* |
| get\_map | *No description.* |
| get\_number | *No description.* |
| get\_number\_list | *No description.* |
| get\_number\_map | *No description.* |
| get\_string | *No description.* |
| get\_string\_map | *No description.* |
| keys | Creates a for expression that maps the iterators to its keys. |
| pluck\_property | Creates a for expression that accesses the key on each element of the iterator. |
| values | Creates a for expression that maps the iterators to its value in case it is a map. |
***
### `dynamic`
```python theme={null}
def dynamic(
attributes: typing.Mapping[typing.Any]
) -> IResolvable
```
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](https://cdktn.io/docs/concepts/iterators#using-iterators-for-list-attributes)
#### `attributes`Required
* *Type:* typing.Mapping\[typing.Any]
***
### `for_expression_for_list`
```python theme={null}
def for_expression_for_list(
expression: str | IResolvable
) -> IResolvable
```
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`.
#### `expression`Required
* *Type:* str | IResolvable
The expression to use in the for mapping.
***
### `for_expression_for_map`
```python theme={null}
def for_expression_for_map(
key_expression: str | IResolvable,
value_expression: str | IResolvable
) -> IResolvable
```
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_expression`Required
* *Type:* str | IResolvable
The expression to use as key in the for mapping.
***
#### `value_expression`Required
* *Type:* str | IResolvable
The expression to use as value in the for mapping.
***
### `get_any`
```python theme={null}
def get_any(
attribute: str
) -> IResolvable
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_any_map`
```python theme={null}
def get_any_map(
attribute: str
) -> typing.Mapping[typing.Any]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_boolean`
```python theme={null}
def get_boolean(
attribute: str
) -> IResolvable
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_boolean_map`
```python theme={null}
def get_boolean_map(
attribute: str
) -> typing.Mapping[bool]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_list`
```python theme={null}
def get_list(
attribute: str
) -> typing.List[str]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_map`
```python theme={null}
def get_map(
attribute: str
) -> typing.Mapping[typing.Any]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_number`
```python theme={null}
def get_number(
attribute: str
) -> typing.Union[int, float]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_number_list`
```python theme={null}
def get_number_list(
attribute: str
) -> typing.List[typing.Union[int, float]]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_number_map`
```python theme={null}
def get_number_map(
attribute: str
) -> typing.Mapping[typing.Union[int, float]]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_string`
```python theme={null}
def get_string(
attribute: str
) -> str
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `get_string_map`
```python theme={null}
def get_string_map(
attribute: str
) -> typing.Mapping[str]
```
#### `attribute`Required
* *Type:* str
name of the property to retrieve.
***
### `keys`
```python theme={null}
def keys() -> IResolvable
```
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`
```python theme={null}
def pluck_property(
property: str
) -> IResolvable
```
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`.
#### `property`Required
* *Type:* str
The property of the iterators values to map to.
***
### `values`
```python theme={null}
def values() -> IResolvable
```
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
| **Name** | **Description** |
| ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| from\_complex\_list | Creates a new iterator from a complex list. |
| from\_data\_sources | Creates a new iterator from a data source that has been created with the `for_each` argument. |
| from\_list | Creates a new iterator from a list. |
| from\_map | Creates a new iterator from a map. |
| from\_resources | Creates a new iterator from a resource that has been created with the `for_each` argument. |
***
### `from_complex_list`
```python theme={null}
import cdktn
cdktn.ListTerraformIterator.from_complex_list(
list: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList,
map_key_attribute_name: str
)
```
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*
```python theme={null}
# Example automatically generated from non-compiling source. May contain errors.
cert = AcmCertificate(self, "cert",
domain_name="example.com",
validation_method="DNS"
)
dvo_iterator = TerraformIterator.from_complex_list(cert.domain_validation_options, "domain_name")
Route53Record(self, "record",
allow_overwrite=True,
name=dvo_iterator.get_string("name"),
records=[dvo_iterator.get_string("record")],
ttl=60,
type=dvo_iterator.get_string("type"),
zone_id=Token.as_string(data_aws_route53_zone_example.zone_id),
for_each=dvo_iterator
)
```
#### `list`Required
* *Type:* IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
***
#### `map_key_attribute_name`Required
* *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](https://cdktn.io/docs/concepts/iterators#using-iterators-on-complex-lists) for more information.
***
### `from_data_sources`
```python theme={null}
import cdktn
cdktn.ListTerraformIterator.from_data_sources(
resource: ITerraformResource
)
```
Creates a new iterator from a data source that has been created with the `for_each` argument.
#### `resource`Required
* *Type:* ITerraformResource
***
### `from_list`
```python theme={null}
import cdktn
cdktn.ListTerraformIterator.from_list(
list: typing.List[str] | IResolvable | typing.List[typing.Union[int, float]] | typing.List[bool | IResolvable]
)
```
Creates a new iterator from a list.
#### `list`Required
* *Type:* typing.List\[str] | IResolvable | typing.List\[typing.Union\[int, float]] | typing.List\[bool | IResolvable]
***
### `from_map`
```python theme={null}
import cdktn
cdktn.ListTerraformIterator.from_map(
map: ComplexMap | typing.Mapping[typing.Any] | typing.Mapping[str] | typing.Mapping[typing.Union[int, float]] | typing.Mapping[bool]
)
```
Creates a new iterator from a map.
#### `map`Required
* *Type:* ComplexMap | typing.Mapping\[typing.Any] | typing.Mapping\[str] | typing.Mapping\[typing.Union\[int, float]] | typing.Mapping\[bool]
***
### `from_resources`
```python theme={null}
import cdktn
cdktn.ListTerraformIterator.from_resources(
resource: ITerraformResource
)
```
Creates a new iterator from a resource that has been created with the `for_each` argument.
#### `resource`Required
* *Type:* ITerraformResource
***
## Properties
| **Name** | **Type** | **Description** |
| ---------------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------------------- |
| key | typing.Any | Returns the currently entry in the list or set that is being iterated over. |
| value | typing.Any | Returns the value of the current item iterated over. |
***
### `key`Required
```python theme={null}
key: typing.Any
```
* *Type:* typing.Any
Returns the currently 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](https://cdktn.io/docs/concepts/iterators#using-count)
***
### `value`Required
```python theme={null}
value: typing.Any
```
* *Type:* typing.Any
Returns the value of the current item iterated over.
***