Skip to main content

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.

​
Initializer 

import { TerraformVariableConfig } from 'cdktn'

const terraformVariableConfig: TerraformVariableConfig = { ... }

​
Properties

NameTypeDescription
defaultanyNo description.
descriptionstringNo description.
nullablebooleanNo description.
sensitivebooleanNo description.
typestringThe type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.
validationTerraformVariableValidationConfig[]Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.

​
defaultOptional 

public readonly default: any;
  • Type: any

​
descriptionOptional 

public readonly description: string;
  • Type: string

​
nullableOptional 

public readonly nullable: boolean;
  • Type: boolean

​
sensitiveOptional 

public readonly sensitive: boolean;
  • Type: boolean

​
typeOptional 

public readonly type: string;
  • Type: string
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.

​
validationOptional 

public readonly validation: TerraformVariableValidationConfig[];
Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.