[Tech Debt]: Migrate AutoFlex ResourcePrefix workflow to an option

[jar-b]

Description

#36437 introduced the concept of option functions to AutoFlex.

AutoFlex also has a special case of field name matching which allows for a "resource prefix" to be specified in cases where multiple field names from an AWS struct will have an expected prefix. This optional resource prefix is currently passed into the flex.Expand or flex.Flatten function via a context value:

	resp.Diagnostics.Append(flex.Flatten(context.WithValue(ctx, flex.ResourcePrefix, ResNameIntent), out, &data)...)

Now that we have option functions, this workflow can be migrated to a formal, documented AutoFlex option to make it more discoverable for contributors outside the core team.

// AutoFlexOptions stores configurable options for an auto-flattener or expander.
type AutoFlexOptions struct {
        // Other stuff...

	// resourcePrefix specifies a common prefix which may be applied to one or more fields on an AWS data structure
	resourcePrefix string
}

func (o *AutoFlexOptions) SetResourcePrefix(s string) {
	o.resourcePrefix = s
}

Once implemented, the appropriate flex function can be called with the new option.

	opt := []AutoFlexOptionsFunc{
		func(opts *AutoFlexOptions) {
			opts.SetResourcePrefix(ResNameIntent)
		},
	}

         resp.Diagnostics.Append(flex.Flatten(ctx, out, &data, opt...)...)

References

• Relates autoflex: wire up option functions, add IgnoreFieldNames option #36437

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.