Python: TerraformVariableConfig

CDKTN Core API Reference for TerraformVariableConfig in Python.

Initializer

import cdktn

cdktn.TerraformVariableConfig(
  default: typing.Any = None,
  description: str = None,
  nullable: bool = None,
  sensitive: bool = None,
  type: str = None,
  validation: typing.List[TerraformVariableValidationConfig] = None
)

Properties

Name	Type	Description
default	typing.Any	No description.
description	str	No description.
nullable	bool	No description.
sensitive	bool	No description.
type	str	The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.
validation	typing.List[TerraformVariableValidationConfig]	Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.

---

default^Optional

default: typing.Any

• Type: typing.Any

---

description^Optional

description: str

• Type: str

---

nullable^Optional

nullable: bool

• Type: bool

---

sensitive^Optional

sensitive: bool

• Type: bool

---

type^Optional

type: str

• Type: str

The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.

If no type constraint is set then a value of any type is accepted.

While type constraints are optional, we recommend specifying them; they serve as easy reminders for users of the module, and allow Terraform to return a helpful error message if the wrong type is used.

Type constraints are created from a mixture of type keywords and type constructors. The supported type keywords are:

• string
• number
• bool

The type constructors allow you to specify complex types such as collections:

• list(< TYPE >)
• set(< TYPE >)
• map(< TYPE >)
• object({< ATTR NAME > = < TYPE >, … })
• tuple([< TYPE >, …])

The keyword any may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, refer to Type Constraints.

If both the type and default arguments are specified, the given default value must be convertible to the specified type.

---

validation^Optional

validation: typing.List[TerraformVariableValidationConfig]

• Type: typing.List[TerraformVariableValidationConfig]

Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.

---