com.hashicorp.cdktf

Interface TerraformVariableConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TerraformVariableConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-04-14T14:24:19.209Z")
 @Stability(value=Experimental)
public interface TerraformVariableConfig
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TerraformVariableConfig.Builder A builder for TerraformVariableConfig
static class	TerraformVariableConfig.Jsii$Proxy An implementation for TerraformVariableConfig

Method Summary

Modifier and Type	Method and Description
static TerraformVariableConfig.Builder	builder()
default Object	getDefaultValue()
default String	getDescription()
default Boolean	getNullable()
default Boolean	getSensitive()
default String	getType() (experimental) 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.
default List<TerraformVariableValidationConfig>	getValidation() (experimental) Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDefaultValue

@Stability(value=Experimental)
 @Nullable
default Object getDefaultValue()

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

getNullable

@Stability(value=Experimental)
 @Nullable
default Boolean getNullable()

getSensitive

@Stability(value=Experimental)
 @Nullable
default Boolean getSensitive()

getType

@Stability(value=Experimental)
 @Nullable
default String getType()

(experimental) 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()
• set()
• map()
• object({ = , ... })
• tuple([, ...])

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 {@link https://developer.hashicorp.com/terraform/language/expressions/type-constraints Type Constraints}.

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

getValidation

@Stability(value=Experimental)
 @Nullable
default List<TerraformVariableValidationConfig> getValidation()

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

builder

@Stability(value=Experimental)
static TerraformVariableConfig.Builder builder()

Returns:

a TerraformVariableConfig.Builder of TerraformVariableConfig