resourceconverter

Documentation

Index

• func SendAllConverted[T any](ctx context.Context, output chan<- model.Resource, converter ResourceConverter, ...) error
• type MapConverter
  • func (mc *MapConverter) ToResource(ctx context.Context, x any, tags model.Tags) (model.Resource, error)
• type ReflectionConverter
  • func (rc *ReflectionConverter) ToResource(ctx context.Context, x any, tags model.Tags) (model.Resource, error)
• type ResourceConverter
• type ResourceFactory
• type TagField
  • func (f TagField) IsZero() bool
• type TagFunc
• type TransformFunc
  • func TagTransformer[T any](f TagFunc[T]) TransformFunc[T]
• type TransformResourceFunc
• type Transformers
  • func (t *Transformers[T]) Add(funcs ...TransformFunc[T])
  • func (t *Transformers[T]) AddNamed(name string, f TransformFunc[T])
  • func (t *Transformers[T]) AddNamedResource(name string, f TransformResourceFunc)
  • func (t *Transformers[T]) AddResource(funcs ...TransformResourceFunc)
  • func (t *Transformers[T]) AddTags(f TagFunc[T])
  • func (t Transformers[T]) Apply(ctx context.Context, raw T, resource *model.Resource) error

Functions

func SendAllConverted

func SendAllConverted[T any](ctx context.Context, output chan<- model.Resource, converter ResourceConverter, resources []T, transformerLists ...Transformers[T]) error

Types

type MapConverter

type MapConverter struct {
	ResourceFactory ResourceFactory
	IdField         string
	DisplayIdField  string
	TagField        TagField
}

func (*MapConverter) ToResource

func (mc *MapConverter) ToResource(ctx context.Context, x any, tags model.Tags) (model.Resource, error)

type ReflectionConverter

type ReflectionConverter struct {
	ResourceFactory ResourceFactory
	IdField         string
	DisplayIdField  string
	TagField        TagField
}

func (*ReflectionConverter) ToResource

func (rc *ReflectionConverter) ToResource(ctx context.Context, x any, tags model.Tags) (model.Resource, error)

type ResourceConverter

type ResourceConverter interface {
	ToResource(context.Context, any, model.Tags) (model.Resource, error)
}

type ResourceFactory

type ResourceFactory func() model.Resource

ResourceFactory is a factory function configured on a ResourceConverter to create a new resource with the standard, known fields filed, namely type, region, and account ID.

type TagField

type TagField struct {
	//how to fetch the tags
	//field name
	Name string `yaml:"name"`
	//name of key attribute
	Key string `yaml:"key"`
	//name of value attribute
	Value string `yaml:"value"`
}

func (TagField) IsZero

func (f TagField) IsZero() bool

type TagFunc

type TagFunc[T any] func(context.Context, T) (model.Tags, error)

TagFunc is a function that returns the tags for a given SDK value.

type TransformFunc

type TransformFunc[T any] func(context.Context, T, *model.Resource) error

TransformFunc is a function that receives a raw SDK value and uses it to mutate the passed model.Resource in some way.

func TagTransformer

func TagTransformer[T any](f TagFunc[T]) TransformFunc[T]

TagTransformer converts a TagFunc[T] into a TransformFunc[T]

type TransformResourceFunc

type TransformResourceFunc func(context.Context, *model.Resource) error

TransformResourceFunc is a function that modifies a model.Resource in some way

type Transformers

type Transformers[T any] struct {
	// contains filtered or unexported fields
}

Transformers is a constructed sequence of TransformFunc and TransformResourceFunc to modify created model.Resources.

func (*Transformers[T]) Add

func (t *Transformers[T]) Add(funcs ...TransformFunc[T])

Add adds new TransformFuncs to the list, automatically assigning names to each.

func (*Transformers[T]) AddNamed

func (t *Transformers[T]) AddNamed(name string, f TransformFunc[T])

AddNamed adds the given TransformFunc to the list under the specified name.

func (*Transformers[T]) AddNamedResource

func (t *Transformers[T]) AddNamedResource(name string, f TransformResourceFunc)

AddNamedResource adds the given TransformResourceFunc to the list under the specified name.

func (*Transformers[T]) AddResource

func (t *Transformers[T]) AddResource(funcs ...TransformResourceFunc)

AddResource adds new TransformResourceFuncs to the list, automatically assigning names to each.

func (*Transformers[T]) AddTags

func (t *Transformers[T]) AddTags(f TagFunc[T])

AddTags is a convienience function to add a tag func as a transformer

func (Transformers[T]) Apply

func (t Transformers[T]) Apply(ctx context.Context, raw T, resource *model.Resource) error

Apply applies all transform funcs in order to the specified raw SDK value and model.Resource.