TfRef<T> class sealed

A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).

T is the Dart type of the referenced value. A reference is a TfArg, so an attribute getter fills an argument of that type directly: pushEndpoint: api.uri. Synth writes it as its interpolation.

Inheritance

• Object
• TfArg<T>
• TfRef

Implemented types

• Sensitive<T>
• ReplaceTrigger

Implementers

• AttributeRef
• DataRef
• ResourceRef

Available extensions

• RefToList

Properties

bareAddress → String

Bare address form: address.attr (no ${...}). Used in depends_on, replace_triggered_by, for_each positions where Terraform expects a raw reference.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

interpolation → String

Terraform interpolation form: ${address.attr}. Used in resource argument JSON values.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

encodeAs(String attribute) → TfArg<Object?>

Available on TfArg<List<RefTo<R>>>, provided by the RefToList extension

The argument value: each element's RefTo.encodeAs for a literal list, the value itself otherwise.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

toTfJson() → Object?

Value emitted into Terraform JSON.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

attribute<T>(TfAddressed owner, String attr) → TfRef<T>

Reference to an attribute of a Resource.

data<T>(TfAddressed owner, String attr) → TfRef<T>

Reference to an attribute of a Data.

resource(TfAddressed owner) → TfRef<Object?>

Whole-resource reference (no attribute suffix). Used in reference-only positions like replace_triggered_by = [<address>] and for_each = <resource>.iterable.