This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::Cognito::UserPoolClient The `AWS::Cognito::UserPoolClient` resource specifies an Amazon Cognito user pool client. **Note** If you don't specify a value for a parameter, Amazon Cognito sets it to a default value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Cognito::UserPoolClient", "Properties" : { "[AccessTokenValidity](#cfn-cognito-userpoolclient-accesstokenvalidity)" : Integer, "[AllowedOAuthFlows](#cfn-cognito-userpoolclient-allowedoauthflows)" : [ String, ... ], "[AllowedOAuthFlowsUserPoolClient](#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient)" : Boolean, "[AllowedOAuthScopes](#cfn-cognito-userpoolclient-allowedoauthscopes)" : [ String, ... ], "[AnalyticsConfiguration](#cfn-cognito-userpoolclient-analyticsconfiguration)" : AnalyticsConfiguration, "[AuthSessionValidity](#cfn-cognito-userpoolclient-authsessionvalidity)" : Integer, "[CallbackURLs](#cfn-cognito-userpoolclient-callbackurls)" : [ String, ... ], "[ClientName](#cfn-cognito-userpoolclient-clientname)" : String, "[DefaultRedirectURI](#cfn-cognito-userpoolclient-defaultredirecturi)" : String, "[EnablePropagateAdditionalUserContextData](#cfn-cognito-userpoolclient-enablepropagateadditionalusercontextdata)" : Boolean, "[EnableTokenRevocation](#cfn-cognito-userpoolclient-enabletokenrevocation)" : Boolean, "[ExplicitAuthFlows](#cfn-cognito-userpoolclient-explicitauthflows)" : [ String, ... ], "[GenerateSecret](#cfn-cognito-userpoolclient-generatesecret)" : Boolean, "[IdTokenValidity](#cfn-cognito-userpoolclient-idtokenvalidity)" : Integer, "[LogoutURLs](#cfn-cognito-userpoolclient-logouturls)" : [ String, ... ], "[PreventUserExistenceErrors](#cfn-cognito-userpoolclient-preventuserexistenceerrors)" : String, "[ReadAttributes](#cfn-cognito-userpoolclient-readattributes)" : [ String, ... ], "[RefreshTokenRotation](#cfn-cognito-userpoolclient-refreshtokenrotation)" : RefreshTokenRotation, "[RefreshTokenValidity](#cfn-cognito-userpoolclient-refreshtokenvalidity)" : Integer, "[SupportedIdentityProviders](#cfn-cognito-userpoolclient-supportedidentityproviders)" : [ String, ... ], "[TokenValidityUnits](#cfn-cognito-userpoolclient-tokenvalidityunits)" : TokenValidityUnits, "[UserPoolId](#cfn-cognito-userpoolclient-userpoolid)" : String, "[WriteAttributes](#cfn-cognito-userpoolclient-writeattributes)" : [ String, ... ] } } ``` ### YAML ``` Type: AWS::Cognito::UserPoolClient Properties: [AccessTokenValidity](#cfn-cognito-userpoolclient-accesstokenvalidity): Integer [AllowedOAuthFlows](#cfn-cognito-userpoolclient-allowedoauthflows): - String [AllowedOAuthFlowsUserPoolClient](#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient): Boolean [AllowedOAuthScopes](#cfn-cognito-userpoolclient-allowedoauthscopes): - String [AnalyticsConfiguration](#cfn-cognito-userpoolclient-analyticsconfiguration): AnalyticsConfiguration [AuthSessionValidity](#cfn-cognito-userpoolclient-authsessionvalidity): Integer [CallbackURLs](#cfn-cognito-userpoolclient-callbackurls): - String [ClientName](#cfn-cognito-userpoolclient-clientname): String [DefaultRedirectURI](#cfn-cognito-userpoolclient-defaultredirecturi): String [EnablePropagateAdditionalUserContextData](#cfn-cognito-userpoolclient-enablepropagateadditionalusercontextdata): Boolean [EnableTokenRevocation](#cfn-cognito-userpoolclient-enabletokenrevocation): Boolean [ExplicitAuthFlows](#cfn-cognito-userpoolclient-explicitauthflows): - String [GenerateSecret](#cfn-cognito-userpoolclient-generatesecret): Boolean [IdTokenValidity](#cfn-cognito-userpoolclient-idtokenvalidity): Integer [LogoutURLs](#cfn-cognito-userpoolclient-logouturls): - String [PreventUserExistenceErrors](#cfn-cognito-userpoolclient-preventuserexistenceerrors): String [ReadAttributes](#cfn-cognito-userpoolclient-readattributes): - String [RefreshTokenRotation](#cfn-cognito-userpoolclient-refreshtokenrotation): RefreshTokenRotation [RefreshTokenValidity](#cfn-cognito-userpoolclient-refreshtokenvalidity): Integer [SupportedIdentityProviders](#cfn-cognito-userpoolclient-supportedidentityproviders): - String [TokenValidityUnits](#cfn-cognito-userpoolclient-tokenvalidityunits): TokenValidityUnits [UserPoolId](#cfn-cognito-userpoolclient-userpoolid): String [WriteAttributes](#cfn-cognito-userpoolclient-writeattributes): - String ``` ## Properties `AccessTokenValidity` The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request. For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours. The default time unit for `AccessTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `86400` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedOAuthFlows` The OAuth grant types that you want your app client to generate for clients in managed login authentication. To create an app client that generates client credentials grants, you must add `client_credentials` as the only allowed OAuth flow. code Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint. implicit Issue the access token, and the ID token when scopes like `openid` and `profile` are requested, directly to your user. client\$1credentials Issue the access token from the `/oauth2/token` endpoint directly to a non-person user, authorized by a combination of the client ID and client secret. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedOAuthFlowsUserPoolClient` Set to `true` to use OAuth 2.0 authorization server features in your app client. This parameter must have a value of `true` before you can configure the following features in your app client. + `CallBackURLs`: Callback URLs. + `LogoutURLs`: Sign-out redirect URLs. + `AllowedOAuthScopes`: OAuth 2.0 scopes. + `AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants. To use authorization server features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false`. When `false`, only SDK-based API sign-in is permitted. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedOAuthScopes` The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Scope values include `phone`, `email`, `openid`, and `profile`. The `aws.cognito.signin.user.admin` scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs. *Required*: No *Type*: Array of String *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AnalyticsConfiguration` The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html). *Required*: No *Type*: [AnalyticsConfiguration](aws-properties-cognito-userpoolclient-analyticsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthSessionValidity` 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. *Required*: No *Type*: Integer *Minimum*: `3` *Maximum*: `15` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CallbackURLs` A list of allowed redirect, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes. A redirect URI must meet the following requirements: + Be an absolute URI. + Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. + Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires HTTPS over HTTP except for callback URLs to `http://localhost`, `http://127.0.0.1` and `http://[::1]`. These callback URLs are for testing purposes only. You can specify custom TCP ports for your callback URLs. App callback URLs such as `myapp://example` are also supported. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientName` A friendly name for the app client that you want to create. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultRedirectURI` The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. *Required*: No *Type*: String *Pattern*: `[\p{L}\p{M}\p{S}\p{N}\p{P}]+` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnablePropagateAdditionalUserContextData` When `true`, your application can include additional `UserContextData` in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see [Adding session data to API requests](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnableTokenRevocation` Activates or deactivates token revocation. If you don't include this parameter, token revocation is automatically activated for the new user pool client. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExplicitAuthFlows` The [authentication flows](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html) that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. If you don't specify a value for `ExplicitAuthFlows`, your app client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`. The values for authentication flow options include the following. + `ALLOW_USER_AUTH`: Enable selection-based sign-in with `USER_AUTH`. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other `ExplicitAuthFlows` permitting them. For example users can complete an SRP challenge through `USER_AUTH` without the flow `USER_SRP_AUTH` being active for the app client. This flow doesn't include `CUSTOM_AUTH`. To activate this setting, your user pool must be in the [ Essentials tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html) or higher. + `ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. + `ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication. + `ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. + `ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication. + `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens. In some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerateSecret` When `true`, generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types). *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IdTokenValidity` The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request. For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours. The default time unit for `IdTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `86400` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogoutURLs` A list of allowed logout URLs for managed login authentication. When you pass `logout_uri` and `client_id` parameters to `/logout`, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of `logout_uri`. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html). *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreventUserExistenceErrors` Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. Valid values include: + `ENABLED` - This prevents user existence-related errors. + `LEGACY` - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented. Defaults to `LEGACY` when you don't provide a value. *Required*: No *Type*: String *Allowed values*: `LEGACY | ENABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ReadAttributes` The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshTokenRotation` The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens. *Required*: No *Type*: [RefreshTokenRotation](aws-properties-cognito-userpoolclient-refreshtokenrotation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshTokenValidity` The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request. For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `315360000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SupportedIdentityProviders` A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`. This parameter sets the IdPs that [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) will display on the login page for your app client. The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html). *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenValidityUnits` The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. *Required*: No *Type*: [TokenValidityUnits](aws-properties-cognito-userpoolclient-tokenvalidityunits.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserPoolId` The ID of the user pool where you want to create an app client. *Required*: Yes *Type*: String *Pattern*: `[\w-]+_[0-9a-zA-Z]+` *Minimum*: `1` *Maximum*: `55` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `WriteAttributes` The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Cognito user pool client ID, such as `1h57kf5cpq17m0eml12EXAMPLE`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt #### `ClientId` The ID of the app client, for example `1example23456789`. ## Examples ### Creating a new app client for a user pool The following example creates an app client with analytics, custom scopes, OAuth services, and third-party identity providers. An app client with this configuration is used with managed login. #### JSON ``` { "UserPoolClient": { "Properties": { "AccessTokenValidity": 30, "AllowedOAuthFlows": [ "code", "implicit" ], "AllowedOAuthFlowsUserPoolClient": true, "AllowedOAuthScopes": [ "openid", "profile", "email", "myapi.example.com/international.read", "myapi.example.com/domestic.read" ], "AnalyticsConfiguration": { "ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/d70b2ba36a8c4dc5a04a0451aEXAMPLE", "UserDataShared": true }, "AuthSessionValidity": 9, "CallbackURLs": [ "https://www.example.com", "myapp://example" ], "ClientName": "my-test-app-client", "DefaultRedirectURI": "https://www.example.com", "EnablePropagateAdditionalUserContextData": true, "EnableTokenRevocation": true, "ExplicitAuthFlows": [ "ALLOW_USER_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "GenerateSecret": true, "IdTokenValidity": 30, "LogoutURLs": [ "https://www.example.com/logout", "http://localhost:8080" ], "PreventUserExistenceErrors": "ENABLED", "ReadAttributes": [ "email", "phone_number", "oidc:profile", "custom:department" ], "RefreshTokenValidity": 10, "SupportedIdentityProviders": [ "Google", "LoginWithAmazon", "SignInWithApple", "Facebook", "MYSSO" ], "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "UserPoolId": "us-west-2_EXAMPLE", "WriteAttributes": [ "email", "oidc:profile", "custom:department" ] }, "Type": "AWS::Cognito::UserPoolClient" } } ``` #### YAML ``` UserPoolClient: Type: AWS::Cognito::UserPoolClient Properties: AccessTokenValidity: 30 AllowedOAuthFlows: - code - implicit AllowedOAuthFlowsUserPoolClient: true AllowedOAuthScopes: - openid - profile - email - myapi.example.com/international.read - myapi.example.com/domestic.read AnalyticsConfiguration: ApplicationArn: arn:aws:mobiletargeting:us-west-2:123456789012:apps/d70b2ba36a8c4dc5a04a0451aEXAMPLE UserDataShared: true AuthSessionValidity: 9 CallbackURLs: - https://www.example.com - myapp://example ClientName: my-test-app-client DefaultRedirectURI: https://www.example.com EnablePropagateAdditionalUserContextData: true EnableTokenRevocation: true ExplicitAuthFlows: - ALLOW_USER_AUTH - ALLOW_ADMIN_USER_PASSWORD_AUTH - ALLOW_USER_PASSWORD_AUTH - ALLOW_REFRESH_TOKEN_AUTH GenerateSecret: true IdTokenValidity: 30 LogoutURLs: - https://www.example.com/logout - http://localhost:8080 PreventUserExistenceErrors: ENABLED ReadAttributes: - email - phone_number - oidc:profile - custom:department RefreshTokenValidity: 10 SupportedIdentityProviders: - Google - LoginWithAmazon - SignInWithApple - Facebook - MYSSO TokenValidityUnits: AccessToken: minutes IdToken: minutes RefreshToken: days UserPoolId: us-west-2_EXAMPLE WriteAttributes: - email - oidc:profile - custom:111 ``` # AWS::Cognito::UserPoolClient AnalyticsConfiguration The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign. Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApplicationArn](#cfn-cognito-userpoolclient-analyticsconfiguration-applicationarn)" : String, "[ApplicationId](#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid)" : String, "[ExternalId](#cfn-cognito-userpoolclient-analyticsconfiguration-externalid)" : String, "[RoleArn](#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn)" : String, "[UserDataShared](#cfn-cognito-userpoolclient-analyticsconfiguration-userdatashared)" : Boolean } ``` ### YAML ``` [ApplicationArn](#cfn-cognito-userpoolclient-analyticsconfiguration-applicationarn): String [ApplicationId](#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid): String [ExternalId](#cfn-cognito-userpoolclient-analyticsconfiguration-externalid): String [RoleArn](#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn): String [UserDataShared](#cfn-cognito-userpoolclient-analyticsconfiguration-userdatashared): Boolean ``` ## Properties `ApplicationArn` The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares. You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications *Required*: No *Type*: String *Pattern*: `arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApplicationId` Your Amazon Pinpoint project ID. *Required*: No *Type*: String *Pattern*: `^[0-9a-fA-F]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExternalId` The [external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `131072` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics. *Required*: No *Type*: String *Pattern*: `arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserDataShared` If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Cognito::UserPoolClient RefreshTokenRotation The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Feature](#cfn-cognito-userpoolclient-refreshtokenrotation-feature)" : String, "[RetryGracePeriodSeconds](#cfn-cognito-userpoolclient-refreshtokenrotation-retrygraceperiodseconds)" : Integer } ``` ### YAML ``` [Feature](#cfn-cognito-userpoolclient-refreshtokenrotation-feature): String [RetryGracePeriodSeconds](#cfn-cognito-userpoolclient-refreshtokenrotation-retrygraceperiodseconds): Integer ``` ## Properties `Feature` The state of refresh token rotation for the current app client. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RetryGracePeriodSeconds` When you request a token refresh with `GetTokensFromRefreshToken`, the original refresh token that you're rotating out can remain valid for a period of time of up to 60 seconds. This allows for client-side retries. When `RetryGracePeriodSeconds` is `0`, the grace period is disabled and a successful request immediately invalidates the submitted refresh token. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `60` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Cognito::UserPoolClient TokenValidityUnits The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-cognito-userpoolclient-tokenvalidityunits-accesstoken)" : String, "[IdToken](#cfn-cognito-userpoolclient-tokenvalidityunits-idtoken)" : String, "[RefreshToken](#cfn-cognito-userpoolclient-tokenvalidityunits-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-cognito-userpoolclient-tokenvalidityunits-accesstoken): String [IdToken](#cfn-cognito-userpoolclient-tokenvalidityunits-idtoken): String [RefreshToken](#cfn-cognito-userpoolclient-tokenvalidityunits-refreshtoken): String ``` ## Properties `AccessToken` A time unit for the value that you set in the `AccessTokenValidity` parameter. The default `AccessTokenValidity` time unit is `hours`. `AccessTokenValidity` duration can range from five minutes to one day. *Required*: No *Type*: String *Allowed values*: `seconds | minutes | hours | days` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdToken` A time unit for the value that you set in the `IdTokenValidity` parameter. The default `IdTokenValidity` time unit is `hours`. `IdTokenValidity` duration can range from five minutes to one day. *Required*: No *Type*: String *Allowed values*: `seconds | minutes | hours | days` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` A time unit for the value that you set in the `RefreshTokenValidity` parameter. The default `RefreshTokenValidity` time unit is `days`. `RefreshTokenValidity` duration can range from 60 minutes to 10 years. *Required*: No *Type*: String *Allowed values*: `seconds | minutes | hours | days` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)