Skip to content

[bugfix] aws_cognito_user_pool_client: Fix "unexpected new value" error when refresh_token_rotation.feature is switched to DISABLED #45650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tabito-hara wants to merge 4 commits into
base: main
Choose a base branch
from
+122 −9
Open

[bugfix] aws_cognito_user_pool_client: Fix "unexpected new value" error when refresh_token_rotation.feature is switched to DISABLED #45650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6edac69
Reset refresh_token_rotation by state values when disabled
tabito-hara Dec 18, 2025
6e0aa62
Add tests to verify if feature = "DISABLED" works
tabito-hara Dec 18, 2025
199e68b
Update the existing tests
tabito-hara Dec 18, 2025
f4e2975
add changelog
tabito-hara Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/45650.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
resource/aws_cognito_user_pool_client: Fix "unexpected new value" error when updating `refresh_token_rotation.feature` to `DISABLED`
```
30 changes: 30 additions & 0 deletions internal/service/cognitoidp/user_pool_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,16 @@ func (r *userPoolClientResource) Create(ctx context.Context, request resource.Cr
}
data.TokenValidityUnits = tvu

// Set config value to suppress diff for disabled rotation
var refreshTokenRotation []refreshTokenRotationModel
response.Diagnostics.Append(request.Plan.GetAttribute(ctx, path.Root("refresh_token_rotation"), &refreshTokenRotation)...)
if response.Diagnostics.HasError() {
return
}
if len(refreshTokenRotation) > 0 && refreshTokenRotation[0].Feature.ValueEnum() == awstypes.FeatureTypeDisabled {
data.RefreshTokenRotation = fwtypes.NewListNestedObjectValueOfPtrMust(ctx, &refreshTokenRotation[0])
}

response.Diagnostics.Append(response.State.Set(ctx, &data)...)
}

Expand Down Expand Up @@ -435,6 +445,16 @@ func (r *userPoolClientResource) Read(ctx context.Context, request resource.Read
data.TokenValidityUnits = tvu
}

// Use state value to suppress diff for disabled rotation
var refreshTokenRotation []refreshTokenRotationModel
response.Diagnostics.Append(request.State.GetAttribute(ctx, path.Root("refresh_token_rotation"), &refreshTokenRotation)...)
if response.Diagnostics.HasError() {
return
}
if len(refreshTokenRotation) > 0 && refreshTokenRotation[0].Feature.ValueEnum() == awstypes.FeatureTypeDisabled {
data.RefreshTokenRotation = fwtypes.NewListNestedObjectValueOfPtrMust(ctx, &refreshTokenRotation[0])
}

response.Diagnostics.Append(response.State.Set(ctx, &data)...)
}

Expand Down Expand Up @@ -499,6 +519,16 @@ func (r *userPoolClientResource) Update(ctx context.Context, request resource.Up
plan.TokenValidityUnits = tvu
}

// Set state value to suppress diff for disabled rotation
var refreshTokenRotation []refreshTokenRotationModel
response.Diagnostics.Append(request.Plan.GetAttribute(ctx, path.Root("refresh_token_rotation"), &refreshTokenRotation)...)
if response.Diagnostics.HasError() {
return
}
if len(refreshTokenRotation) > 0 && refreshTokenRotation[0].Feature.ValueEnum() == awstypes.FeatureTypeDisabled {
plan.RefreshTokenRotation = fwtypes.NewListNestedObjectValueOfPtrMust(ctx, &refreshTokenRotation[0])
}

response.Diagnostics.Append(response.State.Set(ctx, &plan)...)
}

Expand Down
2 changes: 1 addition & 1 deletion internal/service/cognitoidp/user_pool_client_data_source_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ data "aws_cognito_user_pool_client" "test" {
}

func testAccUserPoolClientDataSourceConfig_refreshTokenRotation(rName string, retryGracePeriodSeconds int32) string {
return acctest.ConfigCompose(testAccUserPoolClientConfig_refreshTokenRotation(rName, retryGracePeriodSeconds), `
return acctest.ConfigCompose(testAccUserPoolClientConfig_refreshTokenRotation(rName, string(awstypes.FeatureTypeEnabled), retryGracePeriodSeconds), `
data "aws_cognito_user_pool_client" "test" {
user_pool_id = aws_cognito_user_pool.test.id
client_id = aws_cognito_user_pool_client.test.id
Expand Down
96 changes: 88 additions & 8 deletions internal/service/cognitoidp/user_pool_client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1308,7 +1308,7 @@ func TestAccCognitoIDPUserPoolClient_refreshTokenRotation(t *testing.T) {
CheckDestroy: testAccCheckUserPoolClientDestroy(ctx),
Steps: []resource.TestStep{
{
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, 10),
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, string(awstypes.FeatureTypeEnabled), 10),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(ctx, resourceName, &client),
resource.TestCheckResourceAttr(resourceName, names.AttrName, rName),
Expand All @@ -1322,14 +1322,14 @@ func TestAccCognitoIDPUserPoolClient_refreshTokenRotation(t *testing.T) {
resource.TestCheckNoResourceAttr(resourceName, "generate_secret"),
resource.TestCheckResourceAttr(resourceName, "id_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "prevent_user_existence_errors", ""),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", "ENABLED"),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", string(awstypes.FeatureTypeEnabled)),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.retry_grace_period_seconds", "10"),
resource.TestCheckResourceAttr(resourceName, "refresh_token_validity", "30"),
resource.TestCheckResourceAttrPair(resourceName, names.AttrUserPoolID, "aws_cognito_user_pool.test", names.AttrID),
),
},
{
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, 20),
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, string(awstypes.FeatureTypeEnabled), 20),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(ctx, resourceName, &client),
resource.TestCheckResourceAttr(resourceName, names.AttrName, rName),
Expand All @@ -1343,7 +1343,7 @@ func TestAccCognitoIDPUserPoolClient_refreshTokenRotation(t *testing.T) {
resource.TestCheckNoResourceAttr(resourceName, "generate_secret"),
resource.TestCheckResourceAttr(resourceName, "id_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "prevent_user_existence_errors", ""),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", "ENABLED"),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", string(awstypes.FeatureTypeEnabled)),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.retry_grace_period_seconds", "20"),
resource.TestCheckResourceAttr(resourceName, "refresh_token_validity", "30"),
resource.TestCheckResourceAttrPair(resourceName, names.AttrUserPoolID, "aws_cognito_user_pool.test", names.AttrID),
Expand All @@ -1355,6 +1355,70 @@ func TestAccCognitoIDPUserPoolClient_refreshTokenRotation(t *testing.T) {
ImportState: true,
ImportStateVerify: true,
},
{
// Disabling refresh token rotation without retry grace period seconds
Config: testAccUserPoolClientConfig_refreshTokenRotationWithoutRetryGracePeriodSeconds(rName, string(awstypes.FeatureTypeDisabled)),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(ctx, resourceName, &client),
resource.TestCheckResourceAttr(resourceName, names.AttrName, rName),
resource.TestCheckResourceAttr(resourceName, "access_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "allowed_oauth_flows_user_pool_client", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "3"),
resource.TestCheckResourceAttr(resourceName, names.AttrClientSecret, ""),
resource.TestCheckResourceAttr(resourceName, "default_redirect_uri", ""),
resource.TestCheckResourceAttr(resourceName, "enable_propagate_additional_user_context_data", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "enable_token_revocation", acctest.CtTrue),
resource.TestCheckNoResourceAttr(resourceName, "generate_secret"),
resource.TestCheckResourceAttr(resourceName, "id_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "prevent_user_existence_errors", ""),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", string(awstypes.FeatureTypeDisabled)),
resource.TestCheckResourceAttr(resourceName, "refresh_token_validity", "30"),
resource.TestCheckResourceAttrPair(resourceName, names.AttrUserPoolID, "aws_cognito_user_pool.test", names.AttrID),
),
},
{
// Enabling refresh token rotation again
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, string(awstypes.FeatureTypeEnabled), 20),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(ctx, resourceName, &client),
resource.TestCheckResourceAttr(resourceName, names.AttrName, rName),
resource.TestCheckResourceAttr(resourceName, "access_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "allowed_oauth_flows_user_pool_client", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "3"),
resource.TestCheckResourceAttr(resourceName, names.AttrClientSecret, ""),
resource.TestCheckResourceAttr(resourceName, "default_redirect_uri", ""),
resource.TestCheckResourceAttr(resourceName, "enable_propagate_additional_user_context_data", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "enable_token_revocation", acctest.CtTrue),
resource.TestCheckNoResourceAttr(resourceName, "generate_secret"),
resource.TestCheckResourceAttr(resourceName, "id_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "prevent_user_existence_errors", ""),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", string(awstypes.FeatureTypeEnabled)),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.retry_grace_period_seconds", "20"),
resource.TestCheckResourceAttr(resourceName, "refresh_token_validity", "30"),
resource.TestCheckResourceAttrPair(resourceName, names.AttrUserPoolID, "aws_cognito_user_pool.test", names.AttrID),
),
},
{
// Disabling refresh token rotation while retaining retry grace period seconds
Config: testAccUserPoolClientConfig_refreshTokenRotation(rName, string(awstypes.FeatureTypeDisabled), 20),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(ctx, resourceName, &client),
resource.TestCheckResourceAttr(resourceName, names.AttrName, rName),
resource.TestCheckResourceAttr(resourceName, "access_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "allowed_oauth_flows_user_pool_client", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "3"),
resource.TestCheckResourceAttr(resourceName, names.AttrClientSecret, ""),
resource.TestCheckResourceAttr(resourceName, "default_redirect_uri", ""),
resource.TestCheckResourceAttr(resourceName, "enable_propagate_additional_user_context_data", acctest.CtFalse),
resource.TestCheckResourceAttr(resourceName, "enable_token_revocation", acctest.CtTrue),
resource.TestCheckNoResourceAttr(resourceName, "generate_secret"),
resource.TestCheckResourceAttr(resourceName, "id_token_validity", "0"),
resource.TestCheckResourceAttr(resourceName, "prevent_user_existence_errors", ""),
resource.TestCheckResourceAttr(resourceName, "refresh_token_rotation.0.feature", string(awstypes.FeatureTypeDisabled)),
resource.TestCheckResourceAttr(resourceName, "refresh_token_validity", "30"),
resource.TestCheckResourceAttrPair(resourceName, names.AttrUserPoolID, "aws_cognito_user_pool.test", names.AttrID),
),
},
},
})
}
Expand Down Expand Up @@ -1968,7 +2032,24 @@ resource "aws_cognito_user_pool_client" "test" {
`, rName, defaultRedirectUri, logoutUrl))
}

func testAccUserPoolClientConfig_refreshTokenRotation(rName string, retryGracePeriodSeconds int32) string {
func testAccUserPoolClientConfig_refreshTokenRotation(rName, feature string, retryGracePeriodSeconds int32) string {
return acctest.ConfigCompose(
testAccUserPoolClientConfig_base(rName),
fmt.Sprintf(`
resource "aws_cognito_user_pool_client" "test" {
name = %[1]q
user_pool_id = aws_cognito_user_pool.test.id
explicit_auth_flows = ["ADMIN_NO_SRP_AUTH"]

refresh_token_rotation {
feature = %[2]q
retry_grace_period_seconds = %[3]d
}
}
`, rName, feature, retryGracePeriodSeconds))
}

func testAccUserPoolClientConfig_refreshTokenRotationWithoutRetryGracePeriodSeconds(rName, feature string) string {
return acctest.ConfigCompose(
testAccUserPoolClientConfig_base(rName),
fmt.Sprintf(`
Expand All @@ -1978,9 +2059,8 @@ resource "aws_cognito_user_pool_client" "test" {
explicit_auth_flows = ["ADMIN_NO_SRP_AUTH"]

refresh_token_rotation {
feature = "ENABLED"
retry_grace_period_seconds = %[2]d
feature = %[2]q
}
}
`, rName, retryGracePeriodSeconds))
`, rName, feature))
}
Loading