Default Values
Default values support is only available in the Framework for resources. Handle default values for data source attributes within the data source Read
method and default values for provider attributes within the provider Configure
method.
Default values set a value for an attribute when the Terraform configuration does not provide one. In SDKv2 and the
Framework default values are set via the Default
field on an attribute's schema.
Refer to
Default
in the Framework documentation for details.
This page explains how to migrate attribute defaults in SDKv2 to the Framework.
SDKv2
In SDKv2, default values are defined for a primitive attribute type (i.e., TypeBool
, TypeFloat
, TypeInt
,
TypeString
) by the Default
field on the attribute's schema. Alternatively, the DefaultFunc
function is used to
compute a default value for an attribute.
The following code shows a basic implementation of a default value for a primitive attribute type in SDKv2.
Framework
In the Framework, you set default values with the Default
field on your attribute's definition.
Migration Notes
Remember the following differences between SDKv2 and the Framework when completing the migration.
- In SDKv2, default values are set with the
Default
orDefaultFunc
fields on an attribute'sschema.Schema
struct. In the Framework, you must assign set theDefault
field on an attribute to set a default value.
Example
SDKv2
The following example shows the implementation of the Default
field for the
example_attribute
attribute on the exampleResource
resource with SDKv2.
Framework
The following shows the same section of code after the migration.
This code implements the PlanModifiers
field for the example_attribute
attribute with the Framework.