Python: ComplexObject

CDKTN Core API Reference for ComplexObject in Python.

• Implements: IInterpolatingParent, IResolvable, ITerraformAddressable

Initializers

import cdktn

cdktn.ComplexObject(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_is_from_set: bool,
  complex_object_index: str | typing.Union[int, float] = None
)

Name	Type	Description
terraform_resource	IInterpolatingParent	No description.
terraform_attribute	str	No description.
complex_object_is_from_set	bool	set to true if this item is from inside a set and needs tolist() for accessing it set to “0” for single list items.
complex_object_index	str | typing.Union[int, float]	the index of the complex object in a list.

---

terraform_resource^Required

• Type: IInterpolatingParent

---

terraform_attribute^Required

• Type: str

---

complex_object_is_from_set^Required

• Type: bool

set to true if this item is from inside a set and needs tolist() for accessing it set to “0” for single list items.

---

complex_object_index^Optional

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

the index of the complex object in a list.

---

Methods

Name	Description
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token’s value at resolution time.
to_string	Return a string representation of this resolvable object.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token’s value at resolution time.

_context^Required

• Type: IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

fqn: str

• Type: str

---