r/aws_apigatewayv2_authorizer: Skip ttl when there are no identity sources

[dekimsey]

Description

This change alters the Create behavior of apigatewayv2_authorizer to disable setting a TTL when there are no defined identity sources. Attempting to set the value is invalid and results in the following error:

Error: creating API Gateway v2 authorizer: BadRequestException: Identity source must be set if authorizer caching is enabled (TTL is greater than 0)

Example

resource "aws_apigatewayv2_authorizer" "this" {
  api_id                            = "..."
  name                              = "missing-auth-token"
  authorizer_type                   = "REQUEST"
  authorizer_payload_format_version = "2.0"
  authorizer_uri                    = "..."
}

aws_apigatewayv2_authorizer.this: Creating...
╷
│ Error: creating API Gateway v2 authorizer: BadRequestException: Identity source must be set if authorizer caching is enabled (TTL is greater than 0)
│ 
│   with aws_apigatewayv2_authorizer.this,
│   on api-gateway.tf line 24, in resource "aws_apigatewayv2_authorizer" "this":
│   24: resource "aws_apigatewayv2_authorizer" "this" {
│ 
╵
Operation failed: failed running terraform apply (exit 1)

Output from Acceptance Testing

$ make testacc TESTS=TestAccAPIGatewayV2Authorizer_basic pkg=apigatewayv2_test
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/... -v -count 1 -parallel 20 -run='TestAccAPIGatewayV2Authorizer_basic'  -timeout 180m
ok      github.com/hashicorp/terraform-provider-aws/internal/service/apigateway 5.469s [no tests to run]
=== RUN   TestAccAPIGatewayV2Authorizer_basic
=== PAUSE TestAccAPIGatewayV2Authorizer_basic
=== CONT  TestAccAPIGatewayV2Authorizer_basic
--- PASS: TestAccAPIGatewayV2Authorizer_basic (89.32s)
PASS
...

[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]

Hey @dekimsey 👋 Thank you very much for your contribution! At times, our maintainers need to make direct edits to pull requests in order to help get it ready to be merged. Your current settings do not allow maintainers to make such edits. To help facilitate this, update your pull request to allow such edits as described in GitHub's Allowing changes to a pull request branch created from a fork documentation. (If you're using a fork owned by an organization, your organization may not allow you to change this setting. If that is the case, let us know.)

[github-actions]

Welcome @dekimsey 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

[ewbankkit]

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccAPIGatewayV2Authorizer_' PKG=apigatewayv2 ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/apigatewayv2/... -v -count 1 -parallel 2  -run=TestAccAPIGatewayV2Authorizer_ -timeout 180m
=== RUN   TestAccAPIGatewayV2Authorizer_basic
=== PAUSE TestAccAPIGatewayV2Authorizer_basic
=== RUN   TestAccAPIGatewayV2Authorizer_disappears
=== PAUSE TestAccAPIGatewayV2Authorizer_disappears
=== RUN   TestAccAPIGatewayV2Authorizer_credentials
=== PAUSE TestAccAPIGatewayV2Authorizer_credentials
=== RUN   TestAccAPIGatewayV2Authorizer_jwt
=== PAUSE TestAccAPIGatewayV2Authorizer_jwt
=== RUN   TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialMissingCacheTTL
=== PAUSE TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialMissingCacheTTL
=== RUN   TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialZeroCacheTTL
=== PAUSE TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialZeroCacheTTL
=== CONT  TestAccAPIGatewayV2Authorizer_basic
=== CONT  TestAccAPIGatewayV2Authorizer_jwt
--- PASS: TestAccAPIGatewayV2Authorizer_basic (83.33s)
=== CONT  TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialZeroCacheTTL
--- PASS: TestAccAPIGatewayV2Authorizer_jwt (87.30s)
=== CONT  TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialMissingCacheTTL
--- PASS: TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialZeroCacheTTL (80.79s)
=== CONT  TestAccAPIGatewayV2Authorizer_credentials
--- PASS: TestAccAPIGatewayV2Authorizer_HTTPAPILambdaRequestAuthorizer_initialMissingCacheTTL (107.30s)
=== CONT  TestAccAPIGatewayV2Authorizer_disappears
--- PASS: TestAccAPIGatewayV2Authorizer_disappears (47.92s)
--- PASS: TestAccAPIGatewayV2Authorizer_credentials (96.36s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigatewayv2	265.611s

[ewbankkit]

@dekimsey Thanks for the contribution 🎉 👏.

[github-actions]

This functionality has been released in v5.10.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.