tfresource

Documentation

Index

• Constants
• func DiagsError(diags tfdiag.Diagnostics) error
• func NotFound(err error) bool
• func PrefixedUniqueId(prefix string) string
• func UniqueId() string
• type NotFoundError
  • func (e *NotFoundError) Error() string
  • func (e *NotFoundError) Unwrap() error

Constants

const UniqueIDSuffixLength = 26

UniqueIDSuffixLength is the string length of the suffix generated by PrefixedUniqueId. This can be used by length validation functions to ensure prefixes are the correct length for the target field.

const UniqueIdPrefix = `terraform-`

Functions

func DiagsError

func DiagsError(diags tfdiag.Diagnostics) error

func NotFound

func NotFound(err error) bool

NotFound returns true if the error represents a "resource not found" condition. Specifically, NotFound returns true if the error or a wrapped error is of type resource.NotFoundError.

func PrefixedUniqueId

func PrefixedUniqueId(prefix string) string

Helper for a resource to generate a unique identifier w/ given prefix

After the prefix, the ID consists of an incrementing 26 digit value (to match previous timestamp output). After the prefix, the ID consists of a timestamp and an incrementing 8 hex digit value The timestamp means that multiple IDs created with the same prefix will sort in the order of their creation, even across multiple terraform executions, as long as the clock is not turned back between calls, and as long as any given terraform execution generates fewer than 4 billion IDs.

func UniqueId

func UniqueId() string

Helper for a resource to generate a unique identifier w/ default prefix

Types

type NotFoundError

type NotFoundError struct {
	LastError error
	Message   string
}

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

func (*NotFoundError) Unwrap

func (e *NotFoundError) Unwrap() error