> ## 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: Lazy

> CDKTN Core API Reference for Lazy in Python.

Lazily produce a value.

Can be used to return a string, list or numeric value whose actual value
will only be calculated later, during synthesis.

## Initializers <a name="Initializers" id="cdktn.Lazy.Initializer" />

```python theme={null}
import cdktn

cdktn.Lazy()
```

| **Name** | **Type** | **Description** |
| -------- | -------- | --------------- |

***

## Static Functions <a name="Static Functions" id="Static Functions" />

| **Name**                                                         | **Description**                               |
| ---------------------------------------------------------------- | --------------------------------------------- |
| <code><a href="#cdktn.Lazy.anyValue">any\_value</a></code>       | Produces a lazy token from an untyped value.  |
| <code><a href="#cdktn.Lazy.listValue">list\_value</a></code>     | Returns a list-ified token for a lazy value.  |
| <code><a href="#cdktn.Lazy.numberValue">number\_value</a></code> | Returns a numberified token for a lazy value. |
| <code><a href="#cdktn.Lazy.stringValue">string\_value</a></code> | Returns a stringified token for a lazy value. |

***

### `any_value` <a name="any_value" id="cdktn.Lazy.anyValue" />

```python theme={null}
import cdktn

cdktn.Lazy.any_value(
  producer: IAnyProducer,
  display_hint: str = None,
  omit_empty_array: bool = None
)
```

Produces a lazy token from an untyped value.

#### `producer`<sup>Required</sup> <a name="producer" id="cdktn.Lazy.anyValue.parameter.producer" />

* *Type:* <a href="#cdktn.IAnyProducer">IAnyProducer</a>

The lazy producer.

***

#### `display_hint`<sup>Optional</sup> <a name="display_hint" id="cdktn.Lazy.anyValue.parameter.displayHint" />

* *Type:* str
* *Default:* No hint

Use the given name as a display hint.

***

#### `omit_empty_array`<sup>Optional</sup> <a name="omit_empty_array" id="cdktn.Lazy.anyValue.parameter.omitEmptyArray" />

* *Type:* bool
* *Default:* false

If the produced value is an array and it is empty, return 'undefined' instead.

***

### `list_value` <a name="list_value" id="cdktn.Lazy.listValue" />

```python theme={null}
import cdktn

cdktn.Lazy.list_value(
  producer: IListProducer,
  display_hint: str = None,
  omit_empty: bool = None
)
```

Returns a list-ified token for a lazy value.

#### `producer`<sup>Required</sup> <a name="producer" id="cdktn.Lazy.listValue.parameter.producer" />

* *Type:* <a href="#cdktn.IListProducer">IListProducer</a>

The producer.

***

#### `display_hint`<sup>Optional</sup> <a name="display_hint" id="cdktn.Lazy.listValue.parameter.displayHint" />

* *Type:* str
* *Default:* No hint

Use the given name as a display hint.

***

#### `omit_empty`<sup>Optional</sup> <a name="omit_empty" id="cdktn.Lazy.listValue.parameter.omitEmpty" />

* *Type:* bool
* *Default:* false

If the produced list is empty, return 'undefined' instead.

***

### `number_value` <a name="number_value" id="cdktn.Lazy.numberValue" />

```python theme={null}
import cdktn

cdktn.Lazy.number_value(
  producer: INumberProducer
)
```

Returns a numberified token for a lazy value.

#### `producer`<sup>Required</sup> <a name="producer" id="cdktn.Lazy.numberValue.parameter.producer" />

* *Type:* <a href="#cdktn.INumberProducer">INumberProducer</a>

The producer.

***

### `string_value` <a name="string_value" id="cdktn.Lazy.stringValue" />

```python theme={null}
import cdktn

cdktn.Lazy.string_value(
  producer: IStringProducer,
  display_hint: str = None
)
```

Returns a stringified token for a lazy value.

#### `producer`<sup>Required</sup> <a name="producer" id="cdktn.Lazy.stringValue.parameter.producer" />

* *Type:* <a href="#cdktn.IStringProducer">IStringProducer</a>

The producer.

***

#### `display_hint`<sup>Optional</sup> <a name="display_hint" id="cdktn.Lazy.stringValue.parameter.displayHint" />

* *Type:* str
* *Default:* No hint

Use the given name as a display hint.

***
