hcltypes

Documentation

Index

• type OptionalSecret
• type Secret

Types

type OptionalSecret

type OptionalSecret struct {
	IsSecret bool
	Value    string
}

OptionalSecret holds a potentially sensitive value. When IsSecret is true, Value will be treated as a Secret and its value will be hidden from users.

HCL expressions permit converting both Strings and Secrets may be converted into OptionalSecret, which will set the IsSecret field accordingly.

HCL expressions may also convert OptionalSecret into a Secret regardless of the value of IsSecret. However, OptionalSecret may only be converted into a String if IsSecret is false.

type Secret

type Secret string

Secret holds a sensitive value. Secrets are never displayed to the user when rendering HCL.

HCL expressions permit implicitly converting string values to a Secret, but not the inverse. This ensures that a user can't accidentally leak a sensitive value.