Skip to content
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.

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

cognito user pool client - add auth_session_validity arg #27620

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/27620.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/aws_cognito_user_pool_client: Add `auth_session_validity` argument
```
15 changes: 15 additions & 0 deletions internal/service/cognitoidp/user_pool_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@ func ResourceUserPoolClient() *schema.Resource {
},
},
},
"auth_session_validity": {
Type: schema.TypeInt,
Optional: true,
Default: 3,
ValidateFunc: validation.IntBetween(3, 15),
},
"callback_urls": {
Type: schema.TypeSet,
Optional: true,
Expand Down Expand Up @@ -261,6 +267,10 @@ func resourceUserPoolClientCreate(d *schema.ResourceData, meta interface{}) erro
UserPoolId: aws.String(d.Get("user_pool_id").(string)),
}

if v, ok := d.GetOk("auth_session_validity"); ok {
params.AuthSessionValidity = aws.Int64(int64(v.(int)))
}

if v, ok := d.GetOk("generate_secret"); ok {
params.GenerateSecret = aws.Bool(v.(bool))
}
Expand Down Expand Up @@ -384,6 +394,7 @@ func resourceUserPoolClientRead(d *schema.ResourceData, meta interface{}) error
d.Set("supported_identity_providers", flex.FlattenStringSet(userPoolClient.SupportedIdentityProviders))
d.Set("enable_token_revocation", userPoolClient.EnableTokenRevocation)
d.Set("enable_propagate_additional_user_context_data", userPoolClient.EnablePropagateAdditionalUserContextData)
d.Set("auth_session_validity", userPoolClient.AuthSessionValidity)

if err := d.Set("analytics_configuration", flattenUserPoolClientAnalyticsConfig(userPoolClient.AnalyticsConfiguration)); err != nil {
return fmt.Errorf("error setting analytics_configuration: %w", err)
Expand Down Expand Up @@ -477,6 +488,10 @@ func resourceUserPoolClientUpdate(d *schema.ResourceData, meta interface{}) erro
params.EnablePropagateAdditionalUserContextData = aws.Bool(v.(bool))
}

if v, ok := d.GetOk("auth_session_validity"); ok {
params.AuthSessionValidity = aws.Int64(int64(v.(int)))
}

log.Printf("[DEBUG] Updating Cognito User Pool Client: %s", params)

_, err := tfresource.RetryWhenAWSErrCodeEquals(2*time.Minute, func() (interface{}, error) {
Expand Down
47 changes: 47 additions & 0 deletions internal/service/cognitoidp/user_pool_client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ func TestAccCognitoIDPUserPoolClient_basic(t *testing.T) {
resource.TestCheckTypeSetElemAttr(resourceName, "explicit_auth_flows.*", "ADMIN_NO_SRP_AUTH"),
resource.TestCheckResourceAttr(resourceName, "token_validity_units.#", "0"),
resource.TestCheckResourceAttr(resourceName, "analytics_configuration.#", "0"),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "3"),
),
},
{
Expand Down Expand Up @@ -521,6 +522,41 @@ func TestAccCognitoIDPUserPoolClient_analyticsWithARN(t *testing.T) {
})
}

func TestAccCognitoIDPUserPoolClient_authSessionValidity(t *testing.T) {
var client cognitoidentityprovider.UserPoolClientType
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
resourceName := "aws_cognito_user_pool_client.test"

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(t); testAccPreCheckIdentityProvider(t) },
ErrorCheck: acctest.ErrorCheck(t, cognitoidentityprovider.EndpointsID),
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
CheckDestroy: testAccCheckUserPoolClientDestroy,
Steps: []resource.TestStep{
{
Config: testAccUserPoolClientConfig_authSessionValidity(rName, 3),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(resourceName, &client),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "3"),
),
},
{
ResourceName: resourceName,
ImportStateIdFunc: testAccUserPoolClientImportStateIDFunc(resourceName),
ImportState: true,
ImportStateVerify: true,
},
{
Config: testAccUserPoolClientConfig_authSessionValidity(rName, 15),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckUserPoolClientExists(resourceName, &client),
resource.TestCheckResourceAttr(resourceName, "auth_session_validity", "15"),
),
},
},
})
}

func TestAccCognitoIDPUserPoolClient_disappears(t *testing.T) {
var client cognitoidentityprovider.UserPoolClientType
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
Expand Down Expand Up @@ -860,6 +896,17 @@ resource "aws_cognito_user_pool_client" "test" {
`, rName)
}

func testAccUserPoolClientConfig_authSessionValidity(rName string, validity int) string {
return testAccUserPoolClientBaseConfig(rName) + fmt.Sprintf(`
resource "aws_cognito_user_pool_client" "test" {
name = %[1]q
auth_session_validity = %[2]d
user_pool_id = aws_cognito_user_pool.test.id
explicit_auth_flows = ["ADMIN_NO_SRP_AUTH"]
}
`, rName, validity)
}

func testAccPreCheckPinpointApp(t *testing.T) {
conn := acctest.Provider.Meta().(*conns.AWSClient).PinpointConn

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cognito_user_pool_client.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ The following arguments are optional:
* `allowed_oauth_flows` - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
* `allowed_oauth_scopes` - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
* `analytics_configuration` - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. [Detailed below](#analytics_configuration).
* `auth_session_validity` - (Optional) Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. Valid values between `3` and `15`. Default value is `3`.
* `callback_urls` - (Optional) List of allowed callback URLs for the identity providers.
* `default_redirect_uri` - (Optional) Default redirect URI. Must be in the list of callback URLs.
* `enable_token_revocation` - (Optional) Enables or disables token revocation.
Expand Down