Documentation
¶
Index ¶
Constants ¶
View Source
const TransformerTypePlaceholder = "%type"
Variables ¶
This section is empty.
Functions ¶
func TagFieldValidStyles ¶
func TagFieldValidStyles() []string
Types ¶
type Config ¶
type Config struct {
Services []Service
}
Config contains the aggregated service configuration after parsing.
type Field ¶
type Field struct {
// Name is the identifier of the field. It must be a valid exported Go identifier.
Name string `yaml:"name"`
// SliceType sets the type of the slice this field is, if it is a slice. If not a slice, must be the empty string.
SliceType string `yaml:"sliceType"`
// Pointer controls if this field is a pointer that must be dereferenced.
// Cannot be used with SliceType
Pointer bool `yaml:"pointer"`
}
Field holds a reference to a field in a struct. This type supports YAML decoding as a plain string, in which case the string's value will be used for the `Name` and all other struct fields will be set to their zero value.
func (*Field) UnmarshalYAML ¶
type GetTagsAPI ¶
type GetTagsAPI struct {
// Call is the AWS API call to make within the service
Call string `yaml:"call"`
// InputIDField is the field within the API call's input where we put the resource's ID (from the ListAPI.IDField)
InputIDField Field `yaml:"inputIDField"`
// InputOverrides stores configuration for setting input fields
InputOverrides InputOverrides `yaml:"inputOverrides"`
// Tags defines where tags are present in the API call output.
Tags *TagField `yaml:"tags"`
// AllowedAPIErrorCodes is a list of error codes to ignore when making the API call (treating the resource as having no tags)
AllowedAPIErrorCodes []string `yaml:"allowedApiErrorCodes"`
}
GetTags is configuration for calling an AWS API to get the tags on a particular resource
func (GetTagsAPI) Has ¶
func (c GetTagsAPI) Has() bool
func (GetTagsAPI) Validate ¶
func (api GetTagsAPI) Validate() []error
type InputOverrides ¶
type InputOverrides struct {
// FieldFuncs is a mapping of input field names to function names for setting single fields on the input struct.
// Each function is called without any arguments, and its return type must be the type of the field.
FieldFuncs map[string]string `yaml:"fieldFuncs"`
// FullFuncs is a list functions to call with a pointer to the input struct.
// Each function must have a return type of an error.
FullFuncs []string `yaml:"fullFuncs"`
}
InputOverrides configures functions to call to set values in the API input struct.
type ListAPI ¶
type ListAPI struct {
// Call is the AWS API call to make within the service
Call string `yaml:"call"`
// InputOverrides stores configuration for setting input fields
InputOverrides InputOverrides `yaml:"inputOverrides"`
// Pagination should be set to true if this API has pagination support.
Pagination bool `yaml:"pagination"`
// OutputKey sets the "path" to the list of resources within the API response.
// Each item must be a valid Go identifier.
// Pointer and SliceType are not yet supported in these fields.
OutputKey NestedField `yaml:"outputKey"`
// SDKType is the name of the struct type in the service's `types` package returned by the API.
// Defaults to `Type.Name`
SDKType string `yaml:"sdkType"`
// IDField points to the field within each resource struct that stores the ID of that resource
IDField Field `yaml:"id"`
// DisplayIDField points to the field within each resource struct that stores the display ID of that resource.
// The display ID should be an easily readable identifier, and is intended to be consumed by humans.
DisplayIDField Field `yaml:"displayId"`
// Tags configures where to look for tags on this resource.
// Required if the getTagsApi is not configured.
Tags *TagField `yaml:"tags"`
}
ListAPI is configuration for calling an AWS API to list resources of a type
type NestedField ¶
type NestedField []Field
NestedField is a list of nested Fields, where each successive field is a subfield of the previous. Within YAML, if there is only one field, and it only the "Name" field is being set, NestedField can be specified as a single plain string.
func (NestedField) Empty ¶
func (f NestedField) Empty() bool
func (NestedField) Last ¶
func (f NestedField) Last() Field
func (*NestedField) UnmarshalYAML ¶
func (f *NestedField) UnmarshalYAML(value *yaml.Node) error
func (NestedField) Validate ¶
func (nf NestedField) Validate(ctx string) []error
func (NestedField) ValidateSimple ¶
func (nf NestedField) ValidateSimple(ctx string) []error
ValidateSimple is like Validate, but additionally enforces that sliceType and pointer are not set
type Root ¶
type Root struct {
// Services is a list of service names (where each is a file with a basename of `NAME.yaml`)
Services []string `yaml:"services"`
}
Root is the schema for the root config.yaml file, which is currently just a list of services
type Service ¶
type Service struct {
// Name is the canonical initialized name of the service, in lower case.
// The name is used for constructing the type identifiers of each resource
Name string
// ServicePackage is the name of the service package used by the github.com/aws/aws-sdk-go-v2 module.
// For example, for the `elb` service, the ServicePackage is `elasticloadbalancingv2`.
// Defaults to Name.
ServicePackage string `yaml:"servicePackage"`
// EndpointID is the identifier for the service in the endpoints file located at https://github.com/aws/aws-sdk-go/blob/v1.44.33/aws/endpoints/defaults.go.
// For example, for the `elb` service, the EndpointID is `elasticloadbalancing`.
// Defaults to Name if not specified.
EndpointID string `yaml:"endpointId"`
// Global controls whether or not all types in this service default to global, but can be overriden on a per-type basis.
// A global service is one where resources are not defined in a specific region.
Global bool `yaml:"global"`
// Types is the configuration for each type of resource
Types []Type `yaml:"types"`
}
Service defines the configuration for a specific AWS service
type TagField ¶
type TagField struct {
// Field defines where the tags are located.
Field NestedField `yaml:"field"`
/*
Style sets the style the API uses to store the tags.
The supported styles are "map" and "struct".
"map" stores the tags in a map[string]string mapping.
"struct" stores the tags in something that looks like []struct{Key string; Value string}
*/
Style string `yaml:"style"`
// Pointer sets whether the keys and values are pointers to strings instead of just plain strings.
// Only supported with the "struct" style.
Pointer bool `yaml:"pointer"`
// Key sets the name of the struct field that holds the tag's key.
Key string `yaml:"key"`
// Value sets the name of the struct field that holds the tag's value.
Value string `yaml:"value"`
}
TagField defines where tags can be found and how they are accessed.
type Transformer ¶ added in v0.2.0
type Transformer struct {
// Name is an optional identifier for this transformer, which will be used to add error information.
Name string `yaml:"name"`
// Expr is the Go expression that evaluates to a transformer function.
// If the expression needs to resolve the ListAPI.SDKType, it can use the special replacement string "%type",
// which will be replaced before validating the expression.
// If "%type" is not included and ForceGeneric is false, the expression must evalutate to a resourceconverter.TransformResourceFunc value.
// Otherwise, the expression must evaluate to a TransformFunc[%type]
Expr string `yaml:"expr"`
// ForceGeneric causes the Expr to be treated as resolving to a resourceconverter.TransformFunc[%type], regardless of the expression's contents.
ForceGeneric bool `yaml:"generic"`
}
Transformer refers to a transformer function that modifies the created resource in some way before it is persisted. If specified as a plain string in YAML, it will be decoded with the string in the `Expr` field.
func (Transformer) Expression ¶ added in v0.2.0
func (t Transformer) Expression(genericType string) string
func (Transformer) IsGeneric ¶ added in v0.2.0
func (t Transformer) IsGeneric() bool
func (*Transformer) UnmarshalYAML ¶ added in v0.2.0
func (t *Transformer) UnmarshalYAML(value *yaml.Node) error
func (Transformer) Validate ¶ added in v0.2.0
func (t Transformer) Validate() []error
type Type ¶
type Type struct {
// Name is the name of this resource type.
// It has the same formatting requirements as an exported Go identifier.
Name string `yaml:"name"`
// Global overrides the Service.Global setting
Global *bool `yaml:"global"`
// ListAPI contains the configuration used for listing all resources of this type.
ListAPI ListAPI `yaml:"listApi"`
// GetTagsAPI contains the configuration used for pulling the tags for each resource of this type.
// It is not required if the ListAPI is able to pull tags itself.
GetTagsAPI GetTagsAPI `yaml:"getTagsApi"`
// Transformers is the list of transformer functions to apply to resources before persisting them.
Transformers []Transformer `yaml:"transformers"`
}
Source Files
Click to show internal directories.
Click to hide internal directories.