Python: TerraformVariable - CDK Terrain (CDKTN)

Implements: ITerraformAddressable

Initializers

import cdktn

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

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No 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.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`default`^Optional

Type: typing.Any

`description`^Optional

Type: str

`nullable`^Optional

Type: bool

`sensitive`^Optional

Type: bool

`type`^Optional

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

Type: typing.List[TerraformVariableValidationConfig]

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	No description.
`add_validation`	No description.
`synthesize_attributes`	No description.
`synthesize_hcl_attributes`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

`add_validation`

def add_validation(
  condition: typing.Any,
  error_message: str
) -> None

`condition`^Required

Type: typing.Any

This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not.

`error_message`^Required

Type: str

This contains the text that Terraform will include as part of error messages when it detects an unmet condition.

`synthesize_attributes`

def synthesize_attributes() -> typing.Mapping[typing.Any]

`synthesize_hcl_attributes`

def synthesize_hcl_attributes() -> typing.Mapping[typing.Any]

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.

`is_construct`

import cdktn

cdktn.TerraformVariable.is_construct(
  x: typing.Any
)

Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

import cdktn

cdktn.TerraformVariable.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`boolean_value`	`IResolvable`	No description.
`list_value`	`typing.List[str]`	No description.
`number_value`	`typing.Union[int, float]`	No description.
`string_value`	`str`	No description.
`value`	`typing.Any`	No description.
`default`	`typing.Any`	No description.
`description`	`str`	No description.
`nullable`	`bool`	No description.
`sensitive`	`bool`	No description.
`type`	`str`	No description.
`validation`	`typing.List[TerraformVariableValidationConfig]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`boolean_value`^Required

boolean_value: IResolvable

Type: IResolvable

`list_value`^Required

list_value: typing.List[str]

Type: typing.List[str]

`number_value`^Required

number_value: typing.Union[int, float]

Type: typing.Union[int, float]

`string_value`^Required

string_value: str

Type: str

`value`^Required

value: typing.Any

Type: typing.Any

`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

`validation`^Optional

validation: typing.List[TerraformVariableValidationConfig]

Type: typing.List[TerraformVariableValidationConfig]

​Initializers

​scopeRequired

​idRequired

​defaultOptional

​descriptionOptional

​nullableOptional

​sensitiveOptional

​typeOptional

​validationOptional

​Methods

​to_string

​with

​mixinsRequired

​add_override

​pathRequired

​valueRequired

​override_logical_id

​new_logical_idRequired

​reset_override_logical_id

​to_hcl_terraform

​to_metadata

​to_terraform

​add_validation

​conditionRequired

​error_messageRequired

​synthesize_attributes

​synthesize_hcl_attributes

​Static Functions

​is_construct

​xRequired

​is_terraform_element

​xRequired

​Properties

​nodeRequired

​cdktf_stackRequired

​fqnRequired

​friendly_unique_idRequired

​boolean_valueRequired

​list_valueRequired

​number_valueRequired

​string_valueRequired

​valueRequired

​defaultOptional

​descriptionOptional

​nullableOptional

​sensitiveOptional

​typeOptional

​validationOptional

Initializers

`scope`^Required

`id`^Required

`default`^Optional

`description`^Optional

`nullable`^Optional

`sensitive`^Optional

`type`^Optional

`validation`^Optional

Methods

`to_string`

`with`

`mixins`^Required

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_validation`

`condition`^Required

`error_message`^Required

`synthesize_attributes`

`synthesize_hcl_attributes`

Static Functions

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

Properties

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required

`boolean_value`^Required

`list_value`^Required

`number_value`^Required

`string_value`^Required

`value`^Required

`default`^Optional

`description`^Optional

`nullable`^Optional

`sensitive`^Optional

`type`^Optional

`validation`^Optional