[New Provider Function]: arn_parse and arn_build

[jar-b]

Description

The arn_parse and arn_build provider functions will allow practioners to handle ARN (Amazon Resource Name) manipulation with built-in provider functions. The arn_parse function provides similar utility to the aws_arn data source, but with the benefit of running earlier in the execution order.

Relations

• Relates tfprotov5+tfprotov6: Initial provider defined functions implementation terraform-plugin-go#351
• Relates function: Initial provider defined functions implementation terraform-plugin-framework#889
• Relates all: Initial provider defined functions implementation terraform-plugin-mux#209
• Relates all: Initial provider defined functions implementation terraform-plugin-sdk#1288
• Relates Add protobuf for provider-defined functions terraform#34383

References

Output from Acceptance Testing

% TF_ACC_TERRAFORM_PATH=/Users/jaredbaker/go/bin/terraform go test -count=1 -run='^TestARN' -v ./internal/function/
=== RUN   TestARNBuildFunction_known
=== PAUSE TestARNBuildFunction_known
=== RUN   TestARNParseFunction_known
=== PAUSE TestARNParseFunction_known
=== RUN   TestARNParseFunction_invalid
=== PAUSE TestARNParseFunction_invalid
=== CONT  TestARNBuildFunction_known
=== CONT  TestARNParseFunction_invalid
=== CONT  TestARNParseFunction_known
--- PASS: TestARNParseFunction_invalid (1.01s)
--- PASS: TestARNParseFunction_known (9.21s)
--- PASS: TestARNBuildFunction_known (9.25s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/function   12.461s

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull 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.

For Submitters

• Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
• Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

[github-actions]

Thank you for your contribution! 🚀

A new usage of AWS SDK for Go V1 was detected. Please prefer AWS SDK for Go V2 for all net-new services. If this is an enhancement or bug fix to an existing AWS SDK Go V1 based resource, this comment can be safely ignored.

For additional information refer to the AWS SDK for Go Versions page in the contributor guide.

[jar-b]

With Terraform 1.8.0-beta1:

% go test -count=1 -v ./internal/function/...

--- PASS: TestARNParseFunction_invalid (0.88s)
--- PASS: TestARNBuildFunction_known (4.91s)
--- PASS: TestARNParseFunction_known (4.91s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/function   9.017s

With Terraform 1.7.X:

% go test -count=1 -v ./internal/function/...

    arn_parse_function_test.go:20: Terraform CLI version 1.7.4 is below minimum version 1.8.0-beta1: skipping test
--- SKIP: TestARNParseFunction_known (0.46s)
=== NAME  TestARNBuildFunction_known
    arn_build_function_test.go:18: Terraform CLI version 1.7.4 is below minimum version 1.8.0-beta1: skipping test
--- SKIP: TestARNBuildFunction_known (0.47s)
=== NAME  TestARNParseFunction_invalid
    arn_parse_function_test.go:40: Terraform CLI version 1.7.4 is below minimum version 1.8.0-beta1: skipping test
--- SKIP: TestARNParseFunction_invalid (0.48s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/function   4.578s

[ewbankkit]

Not a blocker: We need to add a new-function GitHub label.

[ewbankkit]

LGTM 🚀.

% go test -count=1 -v ./internal/function/...
=== RUN   TestARNBuildFunction_known
=== PAUSE TestARNBuildFunction_known
=== RUN   TestARNParseFunction_known
=== PAUSE TestARNParseFunction_known
=== RUN   TestARNParseFunction_invalid
=== PAUSE TestARNParseFunction_invalid
=== CONT  TestARNBuildFunction_known
=== CONT  TestARNParseFunction_known
=== CONT  TestARNParseFunction_invalid
    arn_parse_function_test.go:40: Terraform CLI version 1.0.11 is below minimum version 1.8.0-beta1: skipping test
=== NAME  TestARNBuildFunction_known
    arn_build_function_test.go:18: Terraform CLI version 1.0.11 is below minimum version 1.8.0-beta1: skipping test
=== NAME  TestARNParseFunction_known
    arn_parse_function_test.go:20: Terraform CLI version 1.0.11 is below minimum version 1.8.0-beta1: skipping test
--- SKIP: TestARNParseFunction_invalid (0.50s)
--- SKIP: TestARNBuildFunction_known (0.50s)
--- SKIP: TestARNParseFunction_known (0.50s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/function	7.893s

% go test -count=1 -v ./internal/function/...
=== RUN   TestARNBuildFunction_known
=== PAUSE TestARNBuildFunction_known
=== RUN   TestARNParseFunction_known
=== PAUSE TestARNParseFunction_known
=== RUN   TestARNParseFunction_invalid
=== PAUSE TestARNParseFunction_invalid
=== CONT  TestARNBuildFunction_known
=== CONT  TestARNParseFunction_invalid
=== CONT  TestARNParseFunction_known
--- PASS: TestARNParseFunction_invalid (1.70s)
--- PASS: TestARNBuildFunction_known (8.16s)
--- PASS: TestARNParseFunction_known (8.22s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/function	15.317s

[github-actions]

This functionality has been released in v5.40.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.