aws-cdk-lib 2.175.1__py3-none-any.whl → 2.177.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of aws-cdk-lib might be problematic. Click here for more details.

Files changed (64) hide show
  1. aws_cdk/__init__.py +26 -7
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.175.1.jsii.tgz → aws-cdk-lib@2.177.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_apigatewayv2_integrations/__init__.py +161 -9
  5. aws_cdk/aws_appconfig/__init__.py +106 -24
  6. aws_cdk/aws_appsync/__init__.py +4 -3
  7. aws_cdk/aws_backup/__init__.py +18 -84
  8. aws_cdk/aws_batch/__init__.py +4 -2
  9. aws_cdk/aws_bedrock/__init__.py +5395 -2508
  10. aws_cdk/aws_cleanrooms/__init__.py +77 -34
  11. aws_cdk/aws_cloudformation/__init__.py +4 -2
  12. aws_cdk/aws_cloudfront/__init__.py +12 -2
  13. aws_cdk/aws_cloudfront/experimental/__init__.py +1 -1
  14. aws_cdk/aws_cloudfront_origins/__init__.py +33 -2
  15. aws_cdk/aws_cloudwatch/__init__.py +53 -49
  16. aws_cdk/aws_codebuild/__init__.py +36 -0
  17. aws_cdk/aws_codepipeline/__init__.py +35 -0
  18. aws_cdk/aws_cognito/__init__.py +285 -253
  19. aws_cdk/aws_customerprofiles/__init__.py +1060 -0
  20. aws_cdk/aws_datazone/__init__.py +195 -125
  21. aws_cdk/aws_docdb/__init__.py +29 -9
  22. aws_cdk/aws_dynamodb/__init__.py +77 -58
  23. aws_cdk/aws_ec2/__init__.py +16 -11
  24. aws_cdk/aws_ecs/__init__.py +127 -43
  25. aws_cdk/aws_efs/__init__.py +5 -5
  26. aws_cdk/aws_eks/__init__.py +24 -3
  27. aws_cdk/aws_elasticloadbalancingv2/__init__.py +41 -5
  28. aws_cdk/aws_emrserverless/__init__.py +86 -0
  29. aws_cdk/aws_fms/__init__.py +42 -0
  30. aws_cdk/aws_gamelift/__init__.py +8 -10
  31. aws_cdk/aws_healthlake/__init__.py +36 -40
  32. aws_cdk/aws_iam/__init__.py +8 -0
  33. aws_cdk/aws_imagebuilder/__init__.py +62 -48
  34. aws_cdk/aws_lambda/__init__.py +21 -8
  35. aws_cdk/aws_lambda_event_sources/__init__.py +9 -9
  36. aws_cdk/aws_lex/__init__.py +105 -0
  37. aws_cdk/aws_logs/__init__.py +59 -59
  38. aws_cdk/aws_mediaconvert/__init__.py +7 -3
  39. aws_cdk/aws_notifications/__init__.py +1390 -0
  40. aws_cdk/aws_notificationscontacts/__init__.py +593 -0
  41. aws_cdk/aws_organizations/__init__.py +5 -9
  42. aws_cdk/aws_rds/__init__.py +99 -30
  43. aws_cdk/aws_redshift/__init__.py +9 -5
  44. aws_cdk/aws_resiliencehub/__init__.py +41 -0
  45. aws_cdk/aws_route53/__init__.py +4 -4
  46. aws_cdk/aws_route53_targets/__init__.py +15 -15
  47. aws_cdk/aws_s3/__init__.py +794 -5
  48. aws_cdk/aws_s3_notifications/__init__.py +5 -5
  49. aws_cdk/aws_s3tables/__init__.py +2 -2
  50. aws_cdk/aws_ses/__init__.py +25 -4
  51. aws_cdk/aws_sns/__init__.py +39 -0
  52. aws_cdk/aws_ssm/__init__.py +14 -7
  53. aws_cdk/aws_ssmquicksetup/__init__.py +84 -84
  54. aws_cdk/aws_sso/__init__.py +9 -5
  55. aws_cdk/aws_synthetics/__init__.py +105 -32
  56. aws_cdk/cloud_assembly_schema/__init__.py +63 -4
  57. aws_cdk/cx_api/__init__.py +69 -8
  58. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/METADATA +3 -3
  59. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/RECORD +63 -62
  60. aws_cdk/aws_iot1click/__init__.py +0 -1193
  61. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/LICENSE +0 -0
  62. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/NOTICE +0 -0
  63. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/WHEEL +0 -0
  64. {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/top_level.txt +0 -0
@@ -977,6 +977,28 @@ Read more about [Using the Amazon Cognito
977
977
  Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html) and [Using Your Own
978
978
  Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
979
979
 
980
+ You can use the [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) page provided by Amazon Cognito to sign in users. The managed login page has two versions: a classic version and a new version. You can switch between the two versions by using the `managedLoginVersion` property.
981
+
982
+ ```python
983
+ pool = cognito.UserPool(self, "Pool")
984
+
985
+ # Use the new managed login page
986
+ pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
987
+ cognito_domain=cognito.CognitoDomainOptions(
988
+ domain_prefix="blanding-design-ui"
989
+ ),
990
+ managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
991
+ )
992
+
993
+ # Use the classic hosted UI
994
+ pool.add_domain("DomainWithClassicHostedUi",
995
+ cognito_domain=cognito.CognitoDomainOptions(
996
+ domain_prefix="classic-hosted-ui"
997
+ ),
998
+ managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
999
+ )
1000
+ ```
1001
+
980
1002
  The `signInUrl()` methods returns the fully qualified URL to the login page for the user pool. This page comes from the
981
1003
  hosted UI configured with Cognito. Learn more at [Hosted UI with the Amazon Cognito
982
1004
  Console](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html#cognito-user-pools-create-an-app-integration).
@@ -3494,7 +3516,7 @@ class CfnLogDeliveryConfiguration(
3494
3516
  ):
3495
3517
  '''Sets up or modifies the logging configuration of a user pool.
3496
3518
 
3497
- User pools can export user notification logs and advanced security features user activity logs.
3519
+ User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see `Exporting user pool logs <https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html>`_ .
3498
3520
 
3499
3521
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html
3500
3522
  :cloudformationResource: AWS::Cognito::LogDeliveryConfiguration
@@ -3691,9 +3713,9 @@ class CfnLogDeliveryConfiguration(
3691
3713
  )
3692
3714
  class FirehoseConfigurationProperty:
3693
3715
  def __init__(self, *, stream_arn: typing.Optional[builtins.str] = None) -> None:
3694
- '''Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.
3716
+ '''Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
3695
3717
 
3696
- :param stream_arn: The ARN of an Amazon Data Firehose stream that's the destination for advanced security features log export.
3718
+ :param stream_arn: The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export.
3697
3719
 
3698
3720
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html
3699
3721
  :exampleMetadata: fixture=_generated
@@ -3717,7 +3739,7 @@ class CfnLogDeliveryConfiguration(
3717
3739
 
3718
3740
  @builtins.property
3719
3741
  def stream_arn(self) -> typing.Optional[builtins.str]:
3720
- '''The ARN of an Amazon Data Firehose stream that's the destination for advanced security features log export.
3742
+ '''The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export.
3721
3743
 
3722
3744
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html#cfn-cognito-logdeliveryconfiguration-firehoseconfiguration-streamarn
3723
3745
  '''
@@ -3758,13 +3780,11 @@ class CfnLogDeliveryConfiguration(
3758
3780
  ) -> None:
3759
3781
  '''The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
3760
3782
 
3761
- This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
3762
-
3763
- :param cloud_watch_logs_configuration: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features. This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
3783
+ :param cloud_watch_logs_configuration: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
3764
3784
  :param event_source: The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to ``userNotification`` . To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to ``userAuthEvents`` .
3765
- :param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.
3785
+ :param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
3766
3786
  :param log_level: The ``errorlevel`` selection of logs that a user pool sends for detailed activity logging. To send ``userNotification`` activity with `information about message delivery <https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html>`_ , choose ``ERROR`` with ``CloudWatchLogsConfiguration`` . To send ``userAuthEvents`` activity with user logs from threat protection with the Plus feature plan, choose ``INFO`` with one of ``CloudWatchLogsConfiguration`` , ``FirehoseConfiguration`` , or ``S3Configuration`` .
3767
- :param s3_configuration: Configuration for the Amazon S3 bucket destination of user activity log export with advanced security features.
3787
+ :param s3_configuration: Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.
3768
3788
 
3769
3789
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html
3770
3790
  :exampleMetadata: fixture=_generated
@@ -3814,8 +3834,6 @@ class CfnLogDeliveryConfiguration(
3814
3834
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.CloudWatchLogsConfigurationProperty"]]:
3815
3835
  '''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
3816
3836
 
3817
- This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
3818
-
3819
3837
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration
3820
3838
  '''
3821
3839
  result = self._values.get("cloud_watch_logs_configuration")
@@ -3836,7 +3854,7 @@ class CfnLogDeliveryConfiguration(
3836
3854
  def firehose_configuration(
3837
3855
  self,
3838
3856
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.FirehoseConfigurationProperty"]]:
3839
- '''Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.
3857
+ '''Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
3840
3858
 
3841
3859
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-firehoseconfiguration
3842
3860
  '''
@@ -3858,7 +3876,7 @@ class CfnLogDeliveryConfiguration(
3858
3876
  def s3_configuration(
3859
3877
  self,
3860
3878
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.S3ConfigurationProperty"]]:
3861
- '''Configuration for the Amazon S3 bucket destination of user activity log export with advanced security features.
3879
+ '''Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.
3862
3880
 
3863
3881
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-s3configuration
3864
3882
  '''
@@ -3883,9 +3901,9 @@ class CfnLogDeliveryConfiguration(
3883
3901
  )
3884
3902
  class S3ConfigurationProperty:
3885
3903
  def __init__(self, *, bucket_arn: typing.Optional[builtins.str] = None) -> None:
3886
- '''Configuration for the Amazon S3 bucket destination of user activity log export with advanced security features.
3904
+ '''Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.
3887
3905
 
3888
- :param bucket_arn: The ARN of an Amazon S3 bucket that's the destination for advanced security features log export.
3906
+ :param bucket_arn: The ARN of an Amazon S3 bucket that's the destination for threat protection log export.
3889
3907
 
3890
3908
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html
3891
3909
  :exampleMetadata: fixture=_generated
@@ -3909,7 +3927,7 @@ class CfnLogDeliveryConfiguration(
3909
3927
 
3910
3928
  @builtins.property
3911
3929
  def bucket_arn(self) -> typing.Optional[builtins.str]:
3912
- '''The ARN of an Amazon S3 bucket that's the destination for advanced security features log export.
3930
+ '''The ARN of an Amazon S3 bucket that's the destination for threat protection log export.
3913
3931
 
3914
3932
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html#cfn-cognito-logdeliveryconfiguration-s3configuration-bucketarn
3915
3933
  '''
@@ -4266,8 +4284,6 @@ class CfnManagedLoginBranding(
4266
4284
  ) -> None:
4267
4285
  '''An image file from a managed login branding style in a user pool.
4268
4286
 
4269
- This data type is a request parameter of `CreateManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html>`_ and `UpdateManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html>`_ , and a response parameter of `DescribeManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html>`_ .
4270
-
4271
4287
  :param category: The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.
4272
4288
  :param color_mode: The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.
4273
4289
  :param extension: The file type of the image file.
@@ -4729,9 +4745,9 @@ class CfnUserPool(
4729
4745
  :param scope: Scope in which this resource is defined.
4730
4746
  :param id: Construct identifier for this resource (unique in its scope).
4731
4747
  :param account_recovery_setting: The available verified method a user can use to recover their password when they call ``ForgotPassword`` . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
4732
- :param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
4733
- :param alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
4734
- :param auto_verified_attributes: The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
4748
+ :param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
4749
+ :param alias_attributes: Attributes supported as an alias for this user pool. For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
4750
+ :param auto_verified_attributes: The attributes that you want your user pool to automatically verify. For more information, see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
4735
4751
  :param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
4736
4752
  :param device_configuration: The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see `Working with user devices in your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html>`_ . A null value indicates that you have deactivated device remembering in your user pool. .. epigraph:: When you provide a value for any ``DeviceConfiguration`` field, you activate the Amazon Cognito device-remembering feature. For more infor
4737
4753
  :param email_authentication_message:
@@ -4741,17 +4757,17 @@ class CfnUserPool(
4741
4757
  :param email_verification_subject: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html>`_ .
4742
4758
  :param enabled_mfas: Set enabled MFA options on a specified user pool. To disable all MFAs after it has been enabled, set ``MfaConfiguration`` to ``OFF`` and remove EnabledMfas. MFAs can only be all disabled if ``MfaConfiguration`` is ``OFF`` . After you enable ``SMS_MFA`` , you can only disable it by setting ``MfaConfiguration`` to ``OFF`` . Can be one of the following values: - ``SMS_MFA`` - Enables MFA with SMS for the user pool. To select this option, you must also provide values for ``SmsConfiguration`` . - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. - ``EMAIL_OTP`` - Enables MFA with email for the user pool. To select this option, you must provide values for ``EmailConfiguration`` and within those, set ``EmailSendingAccount`` to ``DEVELOPER`` . Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA`` | ``EMAIL_OTP``
4743
4759
  :param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
4744
- :param mfa_configuration: The multi-factor authentication (MFA) configuration. Valid values include:. - ``OFF`` MFA won't be used for any users. - ``ON`` MFA is required for all users to sign in. - ``OPTIONAL`` MFA will be required only for individual users who have an MFA factor activated.
4745
- :param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
4760
+ :param mfa_configuration: Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ``ON`` , all users must set up MFA before they can sign in. When ``OPTIONAL`` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose ``OPTIONAL`` . When ``MfaConfiguration`` is ``OPTIONAL`` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
4761
+ :param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
4746
4762
  :param schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see `Working with user attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html>`_ .
4747
4763
  :param sms_authentication_message: The contents of the SMS authentication message.
4748
- :param sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
4764
+ :param sms_configuration: The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
4749
4765
  :param sms_verification_message: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html>`_ .
4750
4766
  :param user_attribute_update_settings: The settings for updates to user attributes. These settings include the property ``AttributesRequireVerificationBeforeUpdate`` , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see `Verifying updates to email addresses and phone numbers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates>`_ .
4751
4767
  :param username_attributes: Specifies whether a user can use an email address or phone number as a username when they sign up.
4752
4768
  :param username_configuration: Sets the case sensitivity option for sign-in usernames. When ``CaseSensitive`` is ``false`` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, ``username`` , ``USERNAME`` , or ``UserName`` , or for email, ``email@example.com`` or ``EMaiL@eXamplE.Com`` . For most use cases, set case sensitivity to ``false`` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. When ``CaseSensitive`` is ``true`` (case sensitive), Amazon Cognito interprets ``USERNAME`` and ``UserName`` as distinct users. This configuration is immutable after you set it.
4753
- :param user_pool_add_ons: User pool add-ons. Contains settings for activation of threat protection. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to risky traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
4754
- :param user_pool_name: A friendlhy name for your user pool.
4769
+ :param user_pool_add_ons: Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
4770
+ :param user_pool_name: A friendly name for your user pool.
4755
4771
  :param user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
4756
4772
  :param user_pool_tier: The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .
4757
4773
  :param verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your ``DefaultEmailOption`` selection. For ``CONFIRM_WITH_LINK`` , specify an ``EmailMessageByLink`` and leave ``EmailMessage`` blank. For ``CONFIRM_WITH_CODE`` , specify an ``EmailMessage`` and leave ``EmailMessageByLink`` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
@@ -5080,10 +5096,7 @@ class CfnUserPool(
5080
5096
  @builtins.property
5081
5097
  @jsii.member(jsii_name="mfaConfiguration")
5082
5098
  def mfa_configuration(self) -> typing.Optional[builtins.str]:
5083
- '''The multi-factor authentication (MFA) configuration.
5084
-
5085
- Valid values include:.
5086
- '''
5099
+ '''Displays the state of multi-factor authentication (MFA) as on, off, or optional.'''
5087
5100
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "mfaConfiguration"))
5088
5101
 
5089
5102
  @mfa_configuration.setter
@@ -5098,10 +5111,7 @@ class CfnUserPool(
5098
5111
  def policies(
5099
5112
  self,
5100
5113
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]]:
5101
- '''A list of user pool policies.
5102
-
5103
- Contains the policy that sets password-complexity requirements.
5104
- '''
5114
+ '''A list of user pool policies.'''
5105
5115
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]], jsii.get(self, "policies"))
5106
5116
 
5107
5117
  @policies.setter
@@ -5150,7 +5160,7 @@ class CfnUserPool(
5150
5160
  def sms_configuration(
5151
5161
  self,
5152
5162
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.SmsConfigurationProperty"]]:
5153
- '''The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.'''
5163
+ '''The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.'''
5154
5164
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.SmsConfigurationProperty"]], jsii.get(self, "smsConfiguration"))
5155
5165
 
5156
5166
  @sms_configuration.setter
@@ -5233,7 +5243,7 @@ class CfnUserPool(
5233
5243
  def user_pool_add_ons(
5234
5244
  self,
5235
5245
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.UserPoolAddOnsProperty"]]:
5236
- '''User pool add-ons.'''
5246
+ '''Contains settings for activation of threat protection, including the operating mode and additional authentication types.'''
5237
5247
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.UserPoolAddOnsProperty"]], jsii.get(self, "userPoolAddOns"))
5238
5248
 
5239
5249
  @user_pool_add_ons.setter
@@ -5249,7 +5259,7 @@ class CfnUserPool(
5249
5259
  @builtins.property
5250
5260
  @jsii.member(jsii_name="userPoolName")
5251
5261
  def user_pool_name(self) -> typing.Optional[builtins.str]:
5252
- '''A friendlhy name for your user pool.'''
5262
+ '''A friendly name for your user pool.'''
5253
5263
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "userPoolName"))
5254
5264
 
5255
5265
  @user_pool_name.setter
@@ -5414,11 +5424,9 @@ class CfnUserPool(
5414
5424
 
5415
5425
  Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
5416
5426
 
5417
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
5418
-
5419
- :param allow_admin_create_user_only: The setting for allowing self-service sign-up. When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the `SignUp <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html>`_ operation.
5427
+ :param allow_admin_create_user_only: The setting for allowing self-service sign-up. When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the ``SignUp`` operation.
5420
5428
  :param invite_message_template: The template for the welcome message to new users. This template must include the ``{####}`` temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder. See also `Customizing User Invitation Messages <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization>`_ .
5421
- :param unused_account_validity_days: This parameter is no longer in use. Configure the duration of temporary passwords with the ``TemporaryPasswordValidityDays`` parameter of `PasswordPolicyType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_PasswordPolicyType.html>`_ . For older user pools that have a ``UnusedAccountValidityDays`` configuration, that value is effective until you set a value for ``TemporaryPasswordValidityDays`` . The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter. The default value for this parameter is 7.
5429
+ :param unused_account_validity_days: This parameter is no longer in use. The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter. The default value for this parameter is 7.
5422
5430
 
5423
5431
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
5424
5432
  :exampleMetadata: fixture=_generated
@@ -5458,7 +5466,7 @@ class CfnUserPool(
5458
5466
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
5459
5467
  '''The setting for allowing self-service sign-up.
5460
5468
 
5461
- When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the `SignUp <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html>`_ operation.
5469
+ When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the ``SignUp`` operation.
5462
5470
 
5463
5471
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly
5464
5472
  '''
@@ -5484,8 +5492,6 @@ class CfnUserPool(
5484
5492
  def unused_account_validity_days(self) -> typing.Optional[jsii.Number]:
5485
5493
  '''This parameter is no longer in use.
5486
5494
 
5487
- Configure the duration of temporary passwords with the ``TemporaryPasswordValidityDays`` parameter of `PasswordPolicyType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_PasswordPolicyType.html>`_ . For older user pools that have a ``UnusedAccountValidityDays`` configuration, that value is effective until you set a value for ``TemporaryPasswordValidityDays`` .
5488
-
5489
5495
  The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter.
5490
5496
 
5491
5497
  The default value for this parameter is 7.
@@ -5517,9 +5523,9 @@ class CfnUserPool(
5517
5523
  *,
5518
5524
  custom_auth_mode: typing.Optional[builtins.str] = None,
5519
5525
  ) -> None:
5520
- '''Advanced security configuration options for additional authentication types in your user pool, including custom authentication.
5526
+ '''Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
5521
5527
 
5522
- :param custom_auth_mode: The operating mode of advanced security features in custom authentication with `Custom authentication challenge Lambda triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
5528
+ :param custom_auth_mode: The operating mode of threat protection in custom authentication with `Custom authentication challenge Lambda triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
5523
5529
 
5524
5530
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-advancedsecurityadditionalflows.html
5525
5531
  :exampleMetadata: fixture=_generated
@@ -5543,7 +5549,7 @@ class CfnUserPool(
5543
5549
 
5544
5550
  @builtins.property
5545
5551
  def custom_auth_mode(self) -> typing.Optional[builtins.str]:
5546
- '''The operating mode of advanced security features in custom authentication with `Custom authentication challenge Lambda triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
5552
+ '''The operating mode of threat protection in custom authentication with `Custom authentication challenge Lambda triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
5547
5553
 
5548
5554
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-advancedsecurityadditionalflows.html#cfn-cognito-userpool-advancedsecurityadditionalflows-customauthmode
5549
5555
  '''
@@ -5730,17 +5736,8 @@ class CfnUserPool(
5730
5736
  ) -> None:
5731
5737
  '''The device-remembering configuration for a user pool.
5732
5738
 
5733
- A `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a `ConfirmDevice <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html>`_ API request. Additionally. when the property ``DeviceOnlyRememberedOnUserPrompt`` is ``true`` , you must follow ``ConfirmDevice`` with an `UpdateDeviceStatus <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html>`_ API request that sets the user's device to ``remembered`` or ``not_remembered`` .
5734
-
5735
- To sign in with a remembered device, include ``DEVICE_KEY`` in the authentication parameters in your user's `InitiateAuth <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html>`_ request. If your app doesn't include a ``DEVICE_KEY`` parameter, the `response <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax>`_ from Amazon Cognito includes newly-generated ``DEVICE_KEY`` and ``DEVICE_GROUP_KEY`` values under ``NewDeviceMetadata`` . Store these values to use in future device-authentication requests.
5736
- .. epigraph::
5737
-
5738
- When you provide a value for any property of ``DeviceConfiguration`` , you activate the device remembering for the user pool.
5739
-
5740
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
5741
-
5742
5739
  :param challenge_required_on_new_device: When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA). .. epigraph:: Whether or not ``ChallengeRequiredOnNewDevice`` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
5743
- :param device_only_remembered_on_user_prompt: When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a `ConfirmDevice <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html>`_ API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an `UpdateDeviceStatus <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html>`_ API request. When ``DeviceOnlyRememberedOnUserPrompt`` is ``false`` , Amazon Cognito immediately remembers devices that you register in a ``ConfirmDevice`` API request.
5740
+ :param device_only_remembered_on_user_prompt: When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ``ConfirmDevice`` API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an ``UpdateDeviceStatus`` API request. When ``DeviceOnlyRememberedOnUserPrompt`` is ``false`` , Amazon Cognito immediately remembers devices that you register in a ``ConfirmDevice`` API request.
5744
5741
 
5745
5742
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html
5746
5743
  :exampleMetadata: fixture=_generated
@@ -5785,7 +5782,9 @@ class CfnUserPool(
5785
5782
  def device_only_remembered_on_user_prompt(
5786
5783
  self,
5787
5784
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
5788
- '''When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a `ConfirmDevice <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html>`_ API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an `UpdateDeviceStatus <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html>`_ API request.
5785
+ '''When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ``ConfirmDevice`` API request.
5786
+
5787
+ In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an ``UpdateDeviceStatus`` API request.
5789
5788
 
5790
5789
  When ``DeviceOnlyRememberedOnUserPrompt`` is ``false`` , Amazon Cognito immediately remembers devices that you register in a ``ConfirmDevice`` API request.
5791
5790
 
@@ -6096,8 +6095,6 @@ class CfnUserPool(
6096
6095
 
6097
6096
  Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
6098
6097
 
6099
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6100
-
6101
6098
  :param create_auth_challenge: The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
6102
6099
  :param custom_email_sender: The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.
6103
6100
  :param custom_message: A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.
@@ -6359,8 +6356,6 @@ class CfnUserPool(
6359
6356
  ) -> None:
6360
6357
  '''The minimum and maximum values of an attribute that is of the number type, for example ``custom:age`` .
6361
6358
 
6362
- This data type is part of `SchemaAttributeType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html>`_ . It defines the length constraints on number-type attributes that you configure in `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and displays the length constraints of all number-type attributes in the response to `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_
6363
-
6364
6359
  :param max_value: The maximum length of a number attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
6365
6360
  :param min_value: The minimum value of an attribute that is of the number data type.
6366
6361
 
@@ -6446,10 +6441,8 @@ class CfnUserPool(
6446
6441
  ) -> None:
6447
6442
  '''The password policy settings for a user pool, including complexity, history, and length requirements.
6448
6443
 
6449
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6450
-
6451
6444
  :param minimum_length: The minimum length of the password in the policy that you have set. This value can't be less than 6.
6452
- :param password_history_size: The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` . Password history isn't enforced and isn't displayed in `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ responses when you set this value to ``0`` or don't provide it. 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.
6445
+ :param password_history_size: The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` .
6453
6446
  :param require_lowercase: The requirement in a password policy that users must include at least one lowercase letter in their password.
6454
6447
  :param require_numbers: The requirement in a password policy that users must include at least one number in their password.
6455
6448
  :param require_symbols: The requirement in a password policy that users must include at least one symbol in their password.
@@ -6517,8 +6510,6 @@ class CfnUserPool(
6517
6510
 
6518
6511
  Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` .
6519
6512
 
6520
- Password history isn't enforced and isn't displayed in `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ responses when you set this value to ``0`` or don't provide it. 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.
6521
-
6522
6513
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-passwordhistorysize
6523
6514
  '''
6524
6515
  result = self._values.get("password_history_size")
@@ -6608,12 +6599,12 @@ class CfnUserPool(
6608
6599
  password_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.PasswordPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
6609
6600
  sign_in_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.SignInPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
6610
6601
  ) -> None:
6611
- '''A list of user pool policies. Contains the policy that sets password-complexity requirements.
6602
+ '''A list of user pool policies.
6612
6603
 
6613
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6604
+ Contains the policy that sets password-complexity requirements.
6614
6605
 
6615
6606
  :param password_policy: The password policy settings for a user pool, including complexity, history, and length requirements.
6616
- :param sign_in_policy: The policy for allowed types of authentication in a user pool. 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. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6607
+ :param sign_in_policy: The policy for allowed types of authentication in a user pool. 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.
6617
6608
 
6618
6609
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html
6619
6610
  :exampleMetadata: fixture=_generated
@@ -6668,8 +6659,6 @@ class CfnUserPool(
6668
6659
 
6669
6660
  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.
6670
6661
 
6671
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6672
-
6673
6662
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-signinpolicy
6674
6663
  '''
6675
6664
  result = self._values.get("sign_in_policy")
@@ -6700,8 +6689,6 @@ class CfnUserPool(
6700
6689
  ) -> None:
6701
6690
  '''The properties of a pre token generation Lambda trigger.
6702
6691
 
6703
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6704
-
6705
6692
  :param lambda_arn: The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger. This parameter and the ``PreTokenGeneration`` property of ``LambdaConfig`` have the same value. For new instances of pre token generation triggers, set ``LambdaArn`` .
6706
6693
  :param lambda_version: The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
6707
6694
 
@@ -6780,8 +6767,6 @@ class CfnUserPool(
6780
6767
 
6781
6768
  For example, if ``verified_email`` has a priority of ``1`` and ``verified_phone_number`` has a priority of ``2`` , your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The ``admin_only`` option prevents self-service account recovery.
6782
6769
 
6783
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6784
-
6785
6770
  :param name: The recovery method that this object sets a recovery option for.
6786
6771
  :param priority: Your priority preference for using the specified attribute in account recovery. The highest priority is ``1`` .
6787
6772
 
@@ -6871,8 +6856,6 @@ class CfnUserPool(
6871
6856
 
6872
6857
  Developer-only ``dev:`` attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
6873
6858
 
6874
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
6875
-
6876
6859
  :param attribute_data_type: The data format of the values for your attribute. When you choose an ``AttributeDataType`` , Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example ``"custom:isMember" : "true"`` or ``"custom:YearsAsMember" : "12"`` .
6877
6860
  :param developer_only_attribute: .. epigraph:: You should use `WriteAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes>`_ in the user pool client to control how attributes can be mutated for new use cases instead of using ``DeveloperOnlyAttribute`` . Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, ``DeveloperOnlyAttribute`` can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
6878
6861
  :param mutable: Specifies whether the value of the attribute can be changed. Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of ``true`` . Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see `Specifying Identity Provider Attribute Mappings for Your User Pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
@@ -7042,8 +7025,6 @@ class CfnUserPool(
7042
7025
 
7043
7026
  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.
7044
7027
 
7045
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
7046
-
7047
7028
  :param allowed_first_auth_factors: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. Supports values of ``EMAIL_OTP`` , ``SMS_OTP`` , ``WEB_AUTHN`` and ``PASSWORD`` ,
7048
7029
 
7049
7030
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-signinpolicy.html
@@ -7113,8 +7094,6 @@ class CfnUserPool(
7113
7094
 
7114
7095
  To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .
7115
7096
 
7116
- This data type is a request parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ , `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ , and a response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ , `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and `GetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html>`_ .
7117
-
7118
7097
  :param external_id: The external ID provides additional security for your IAM role. You can use an ``ExternalId`` with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ``ExternalId`` , your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ``ExternalID`` . If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ``ExternalId`` . For more information about the ``ExternalId`` of a role, see `How to use an external ID when granting access to your AWS resources to a third party <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_ .
7119
7098
  :param sns_caller_arn: The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a `spending limit <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html>`_ .
7120
7099
  :param sns_region: The AWS Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported *Legacy Amazon SNS alternate Region* . Amazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see `SMS message settings for Amazon Cognito user pools <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
@@ -7209,8 +7188,6 @@ class CfnUserPool(
7209
7188
  ) -> None:
7210
7189
  '''The minimum and maximum length values of an attribute that is of the string type, for example ``custom:department`` .
7211
7190
 
7212
- This data type is part of `SchemaAttributeType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html>`_ . It defines the length constraints on string-type attributes that you configure in `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and displays the length constraints of all string-type attributes in the response to `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_
7213
-
7214
7191
  :param max_length: The maximum length of a string attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
7215
7192
  :param min_length: The minimum length of a string attribute value.
7216
7193
 
@@ -7288,7 +7265,7 @@ class CfnUserPool(
7288
7265
  a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
7289
7266
  more information, see `Verifying updates to email addresses and phone numbers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates>`_ .
7290
7267
 
7291
- :param attributes_require_verification_before_update: Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value. You can verify an updated email address or phone number with a `VerifyUserAttribute <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html>`_ API request. You can also call the `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ API and set ``email_verified`` or ``phone_number_verified`` to true. When ``AttributesRequireVerificationBeforeUpdate`` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ``AttributesRequireVerificationBeforeUpdate`` is false, API operations that change attribute values can immediately update a user’s ``email`` or ``phone_number`` attribute.
7268
+ :param attributes_require_verification_before_update: Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value. When ``AttributesRequireVerificationBeforeUpdate`` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ``AttributesRequireVerificationBeforeUpdate`` is false, API operations that change attribute values can immediately update a user’s ``email`` or ``phone_number`` attribute.
7292
7269
 
7293
7270
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html
7294
7271
  :exampleMetadata: fixture=_generated
@@ -7318,8 +7295,6 @@ class CfnUserPool(
7318
7295
 
7319
7296
  When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
7320
7297
 
7321
- You can verify an updated email address or phone number with a `VerifyUserAttribute <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html>`_ API request. You can also call the `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ API and set ``email_verified`` or ``phone_number_verified`` to true.
7322
-
7323
7298
  When ``AttributesRequireVerificationBeforeUpdate`` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ``AttributesRequireVerificationBeforeUpdate`` is false, API operations that change attribute values can immediately update a user’s ``email`` or ``phone_number`` attribute.
7324
7299
 
7325
7300
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html#cfn-cognito-userpool-userattributeupdatesettings-attributesrequireverificationbeforeupdate
@@ -7360,10 +7335,8 @@ class CfnUserPool(
7360
7335
 
7361
7336
  For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
7362
7337
 
7363
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
7364
-
7365
- :param advanced_security_additional_flows: Advanced security configuration options for additional authentication types in your user pool, including custom authentication.
7366
- :param advanced_security_mode: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
7338
+ :param advanced_security_additional_flows: Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
7339
+ :param advanced_security_mode: The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
7367
7340
 
7368
7341
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html
7369
7342
  :exampleMetadata: fixture=_generated
@@ -7395,7 +7368,7 @@ class CfnUserPool(
7395
7368
  def advanced_security_additional_flows(
7396
7369
  self,
7397
7370
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.AdvancedSecurityAdditionalFlowsProperty"]]:
7398
- '''Advanced security configuration options for additional authentication types in your user pool, including custom authentication.
7371
+ '''Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
7399
7372
 
7400
7373
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecurityadditionalflows
7401
7374
  '''
@@ -7404,7 +7377,7 @@ class CfnUserPool(
7404
7377
 
7405
7378
  @builtins.property
7406
7379
  def advanced_security_mode(self) -> typing.Optional[builtins.str]:
7407
- '''The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
7380
+ '''The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
7408
7381
 
7409
7382
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode
7410
7383
  '''
@@ -7437,8 +7410,6 @@ class CfnUserPool(
7437
7410
 
7438
7411
  When case sensitivity is set to ``False`` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, ``username`` , ``USERNAME`` , or ``UserName`` , or for email, ``email@example.com`` or ``EMaiL@eXamplE.Com`` . For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
7439
7412
 
7440
- This configuration is immutable after you set it. For more information, see `UsernameConfigurationType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html>`_ .
7441
-
7442
7413
  :param case_sensitive: Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name. Valid values include: - **true** - Enables case sensitivity for all username input. When this option is set to ``true`` , users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - **false** - Enables case insensitivity for all username input. For example, when this option is set to ``false`` , users can sign in using ``username`` , ``USERNAME`` , or ``UserName`` . This option also enables both ``preferred_username`` and ``email`` alias to be case insensitive, in addition to the ``username`` attribute.
7443
7414
 
7444
7415
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html
@@ -7515,8 +7486,6 @@ class CfnUserPool(
7515
7486
  ) -> None:
7516
7487
  '''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
7517
7488
 
7518
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
7519
-
7520
7489
  :param default_email_option: The configuration of verification emails to contain a clickable link or a verification code. For link, your template body must contain link text in the format ``{##Click here##}`` . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format ``{####}`` .
7521
7490
  :param email_message: The template for email messages that Amazon Cognito sends to your users. You can set an ``EmailMessage`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
7522
7491
  :param email_message_by_link: The email message template for sending a confirmation link to the user. You can set an ``EmailMessageByLink`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
@@ -7750,26 +7719,26 @@ class CfnUserPoolClient(
7750
7719
  :param id: Construct identifier for this resource (unique in its scope).
7751
7720
  :param user_pool_id: The ID of the user pool where you want to create an app client.
7752
7721
  :param access_token_validity: 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.
7753
- :param allowed_o_auth_flows: The OAuth grant types that you want your app client to generate. 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, optionally, ID token, based on scopes) directly to your user. - **client_credentials** - Issue the access token from the ``/oauth2/token`` endpoint directly to a non-person user using a combination of the client ID and client secret.
7754
- :param allowed_o_auth_flows_user_pool_client: Set to ``true`` to use OAuth 2.0 features in your user pool app client. ``AllowedOAuthFlowsUserPoolClient`` must be ``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 OAuth 2.0 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`` .
7755
- :param allowed_o_auth_scopes: The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the ``userInfo`` endpoint, and third-party APIs. Possible values provided by OAuth are ``phone`` , ``email`` , ``openid`` , and ``profile`` . Possible values provided by AWS are ``aws.cognito.signin.user.admin`` . Custom scopes created in Resource Servers are also supported.
7722
+ :param allowed_o_auth_flows: 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_credentials** - 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.
7723
+ :param allowed_o_auth_flows_user_pool_client: 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.
7724
+ :param allowed_o_auth_scopes: 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.
7756
7725
  :param analytics_configuration: 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>`_ .
7757
7726
  :param auth_session_validity: 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.
7758
- :param callback_ur_ls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - 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://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
7727
+ :param callback_ur_ls: 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://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
7759
7728
  :param client_name: A friendly name for the app client that you want to create.
7760
7729
  :param default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces ``redirect_uri`` in authentication requests. Must be in the ``CallbackURLs`` list.
7761
- :param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
7762
- :param enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ . If you don't include this parameter, token revocation is automatically activated for the new user pool client.
7763
- :param explicit_auth_flows: The authentication flows 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. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``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`` .
7764
- :param generate_secret: When ``true`` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. 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>`_ .
7730
+ :param enable_propagate_additional_user_context_data: 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.
7731
+ :param enable_token_revocation: Activates or deactivates token revocation. If you don't include this parameter, token revocation is automatically activated for the new user pool client.
7732
+ :param explicit_auth_flows: 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. .. epigraph:: 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`` .
7733
+ :param generate_secret: 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>`_ .
7765
7734
  :param id_token_validity: 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.
7766
- :param logout_ur_ls: A list of allowed logout URLs for managed login authentication. For more information, see `Logout endpoint <https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html>`_ .
7735
+ :param logout_ur_ls: 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>`_ .
7767
7736
  :param prevent_user_existence_errors: 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.
7768
- :param read_attributes: 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. Your app makes a `GetUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html>`_ API request to retrieve and display your user's profile data. 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.
7737
+ :param read_attributes: 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.
7769
7738
  :param refresh_token_validity: 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.
7770
- :param supported_identity_providers: 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 setting applies to providers that you can access with `managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ . 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 API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
7739
+ :param supported_identity_providers: 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>`_ .
7771
7740
  :param token_validity_units: 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.
7772
- :param write_attributes: 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. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ API request and sets ``family_name`` to the new value. 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>`_ .
7741
+ :param write_attributes: 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>`_ .
7773
7742
  '''
7774
7743
  if __debug__:
7775
7744
  type_hints = typing.get_type_hints(_typecheckingstub__87712ca9ae8faf9f73a6c5d11987fcf280543ea093bcc4253c800c0151725828)
@@ -7891,7 +7860,7 @@ class CfnUserPoolClient(
7891
7860
  @builtins.property
7892
7861
  @jsii.member(jsii_name="allowedOAuthFlows")
7893
7862
  def allowed_o_auth_flows(self) -> typing.Optional[typing.List[builtins.str]]:
7894
- '''The OAuth grant types that you want your app client to generate.'''
7863
+ '''The OAuth grant types that you want your app client to generate for clients in managed login authentication.'''
7895
7864
  return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "allowedOAuthFlows"))
7896
7865
 
7897
7866
  @allowed_o_auth_flows.setter
@@ -7909,7 +7878,7 @@ class CfnUserPoolClient(
7909
7878
  def allowed_o_auth_flows_user_pool_client(
7910
7879
  self,
7911
7880
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
7912
- '''Set to ``true`` to use OAuth 2.0 features in your user pool app client.'''
7881
+ '''Set to ``true`` to use OAuth 2.0 authorization server features in your app client.'''
7913
7882
  return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "allowedOAuthFlowsUserPoolClient"))
7914
7883
 
7915
7884
  @allowed_o_auth_flows_user_pool_client.setter
@@ -7925,7 +7894,7 @@ class CfnUserPoolClient(
7925
7894
  @builtins.property
7926
7895
  @jsii.member(jsii_name="allowedOAuthScopes")
7927
7896
  def allowed_o_auth_scopes(self) -> typing.Optional[typing.List[builtins.str]]:
7928
- '''The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the ``userInfo`` endpoint, and third-party APIs. Possible values provided by OAuth are ``phone`` , ``email`` , ``openid`` , and ``profile`` . Possible values provided by AWS are ``aws.cognito.signin.user.admin`` . Custom scopes created in Resource Servers are also supported.'''
7897
+ '''The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.'''
7929
7898
  return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "allowedOAuthScopes"))
7930
7899
 
7931
7900
  @allowed_o_auth_scopes.setter
@@ -7972,7 +7941,7 @@ class CfnUserPoolClient(
7972
7941
  @builtins.property
7973
7942
  @jsii.member(jsii_name="callbackUrLs")
7974
7943
  def callback_ur_ls(self) -> typing.Optional[typing.List[builtins.str]]:
7975
- '''A list of allowed redirect (callback) URLs for the IdPs.'''
7944
+ '''A list of allowed redirect, or callback, URLs for managed login authentication.'''
7976
7945
  return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "callbackUrLs"))
7977
7946
 
7978
7947
  @callback_ur_ls.setter
@@ -8013,7 +7982,7 @@ class CfnUserPoolClient(
8013
7982
  def enable_propagate_additional_user_context_data(
8014
7983
  self,
8015
7984
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8016
- '''Activates the propagation of additional user context data.'''
7985
+ '''When ``true`` , your application can include additional ``UserContextData`` in authentication requests.'''
8017
7986
  return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enablePropagateAdditionalUserContextData"))
8018
7987
 
8019
7988
  @enable_propagate_additional_user_context_data.setter
@@ -8031,10 +8000,7 @@ class CfnUserPoolClient(
8031
8000
  def enable_token_revocation(
8032
8001
  self,
8033
8002
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8034
- '''Activates or deactivates token revocation.
8035
-
8036
- For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ .
8037
- '''
8003
+ '''Activates or deactivates token revocation.'''
8038
8004
  return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enableTokenRevocation"))
8039
8005
 
8040
8006
  @enable_token_revocation.setter
@@ -8050,7 +8016,7 @@ class CfnUserPoolClient(
8050
8016
  @builtins.property
8051
8017
  @jsii.member(jsii_name="explicitAuthFlows")
8052
8018
  def explicit_auth_flows(self) -> typing.Optional[typing.List[builtins.str]]:
8053
- '''The authentication flows that you want your user pool client to support.'''
8019
+ '''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.'''
8054
8020
  return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "explicitAuthFlows"))
8055
8021
 
8056
8022
  @explicit_auth_flows.setter
@@ -8231,8 +8197,6 @@ class CfnUserPoolClient(
8231
8197
 
8232
8198
  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>`_ .
8233
8199
 
8234
- This data type is a request parameter of `CreateUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html>`_ and `UpdateUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html>`_ , and a response parameter of `DescribeUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html>`_ .
8235
-
8236
8200
  :param application_arn: 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
8237
8201
  :param application_id: Your Amazon Pinpoint project ID.
8238
8202
  :param external_id: 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.
@@ -8352,9 +8316,9 @@ class CfnUserPoolClient(
8352
8316
  id_token: typing.Optional[builtins.str] = None,
8353
8317
  refresh_token: typing.Optional[builtins.str] = None,
8354
8318
  ) -> None:
8355
- '''The time units you use when you set the duration of ID, access, and refresh tokens.
8319
+ '''The units that validity times are represented in.
8356
8320
 
8357
- The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
8321
+ The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
8358
8322
 
8359
8323
  :param access_token: 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.
8360
8324
  :param id_token: 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.
@@ -8492,26 +8456,26 @@ class CfnUserPoolClientProps:
8492
8456
 
8493
8457
  :param user_pool_id: The ID of the user pool where you want to create an app client.
8494
8458
  :param access_token_validity: 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.
8495
- :param allowed_o_auth_flows: The OAuth grant types that you want your app client to generate. 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, optionally, ID token, based on scopes) directly to your user. - **client_credentials** - Issue the access token from the ``/oauth2/token`` endpoint directly to a non-person user using a combination of the client ID and client secret.
8496
- :param allowed_o_auth_flows_user_pool_client: Set to ``true`` to use OAuth 2.0 features in your user pool app client. ``AllowedOAuthFlowsUserPoolClient`` must be ``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 OAuth 2.0 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`` .
8497
- :param allowed_o_auth_scopes: The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the ``userInfo`` endpoint, and third-party APIs. Possible values provided by OAuth are ``phone`` , ``email`` , ``openid`` , and ``profile`` . Possible values provided by AWS are ``aws.cognito.signin.user.admin`` . Custom scopes created in Resource Servers are also supported.
8459
+ :param allowed_o_auth_flows: 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_credentials** - 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.
8460
+ :param allowed_o_auth_flows_user_pool_client: 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.
8461
+ :param allowed_o_auth_scopes: 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.
8498
8462
  :param analytics_configuration: 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>`_ .
8499
8463
  :param auth_session_validity: 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.
8500
- :param callback_ur_ls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - 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://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
8464
+ :param callback_ur_ls: 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://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
8501
8465
  :param client_name: A friendly name for the app client that you want to create.
8502
8466
  :param default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces ``redirect_uri`` in authentication requests. Must be in the ``CallbackURLs`` list.
8503
- :param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
8504
- :param enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ . If you don't include this parameter, token revocation is automatically activated for the new user pool client.
8505
- :param explicit_auth_flows: The authentication flows 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. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``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`` .
8506
- :param generate_secret: When ``true`` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. 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>`_ .
8467
+ :param enable_propagate_additional_user_context_data: 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.
8468
+ :param enable_token_revocation: Activates or deactivates token revocation. If you don't include this parameter, token revocation is automatically activated for the new user pool client.
8469
+ :param explicit_auth_flows: 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. .. epigraph:: 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`` .
8470
+ :param generate_secret: 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>`_ .
8507
8471
  :param id_token_validity: 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.
8508
- :param logout_ur_ls: A list of allowed logout URLs for managed login authentication. For more information, see `Logout endpoint <https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html>`_ .
8472
+ :param logout_ur_ls: 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>`_ .
8509
8473
  :param prevent_user_existence_errors: 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.
8510
- :param read_attributes: 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. Your app makes a `GetUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html>`_ API request to retrieve and display your user's profile data. 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.
8474
+ :param read_attributes: 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.
8511
8475
  :param refresh_token_validity: 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.
8512
- :param supported_identity_providers: 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 setting applies to providers that you can access with `managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ . 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 API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
8476
+ :param supported_identity_providers: 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>`_ .
8513
8477
  :param token_validity_units: 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.
8514
- :param write_attributes: 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. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ API request and sets ``family_name`` to the new value. 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>`_ .
8478
+ :param write_attributes: 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>`_ .
8515
8479
 
8516
8480
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html
8517
8481
  :exampleMetadata: fixture=_generated
@@ -8660,13 +8624,13 @@ class CfnUserPoolClientProps:
8660
8624
 
8661
8625
  @builtins.property
8662
8626
  def allowed_o_auth_flows(self) -> typing.Optional[typing.List[builtins.str]]:
8663
- '''The OAuth grant types that you want your app client to generate.
8627
+ '''The OAuth grant types that you want your app client to generate for clients in managed login authentication.
8664
8628
 
8665
8629
  To create an app client that generates client credentials grants, you must add ``client_credentials`` as the only allowed OAuth flow.
8666
8630
 
8667
8631
  - **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.
8668
- - **implicit** - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
8669
- - **client_credentials** - Issue the access token from the ``/oauth2/token`` endpoint directly to a non-person user using a combination of the client ID and client secret.
8632
+ - **implicit** - Issue the access token, and the ID token when scopes like ``openid`` and ``profile`` are requested, directly to your user.
8633
+ - **client_credentials** - 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.
8670
8634
 
8671
8635
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows
8672
8636
  '''
@@ -8677,16 +8641,16 @@ class CfnUserPoolClientProps:
8677
8641
  def allowed_o_auth_flows_user_pool_client(
8678
8642
  self,
8679
8643
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8680
- '''Set to ``true`` to use OAuth 2.0 features in your user pool app client.
8644
+ '''Set to ``true`` to use OAuth 2.0 authorization server features in your app client.
8681
8645
 
8682
- ``AllowedOAuthFlowsUserPoolClient`` must be ``true`` before you can configure the following features in your app client.
8646
+ This parameter must have a value of ``true`` before you can configure the following features in your app client.
8683
8647
 
8684
8648
  - ``CallBackURLs`` : Callback URLs.
8685
8649
  - ``LogoutURLs`` : Sign-out redirect URLs.
8686
8650
  - ``AllowedOAuthScopes`` : OAuth 2.0 scopes.
8687
8651
  - ``AllowedOAuthFlows`` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
8688
8652
 
8689
- To use OAuth 2.0 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`` .
8653
+ 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.
8690
8654
 
8691
8655
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient
8692
8656
  '''
@@ -8695,7 +8659,9 @@ class CfnUserPoolClientProps:
8695
8659
 
8696
8660
  @builtins.property
8697
8661
  def allowed_o_auth_scopes(self) -> typing.Optional[typing.List[builtins.str]]:
8698
- '''The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the ``userInfo`` endpoint, and third-party APIs. Possible values provided by OAuth are ``phone`` , ``email`` , ``openid`` , and ``profile`` . Possible values provided by AWS are ``aws.cognito.signin.user.admin`` . Custom scopes created in Resource Servers are also supported.
8662
+ '''The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
8663
+
8664
+ 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.
8699
8665
 
8700
8666
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes
8701
8667
  '''
@@ -8728,9 +8694,11 @@ class CfnUserPoolClientProps:
8728
8694
 
8729
8695
  @builtins.property
8730
8696
  def callback_ur_ls(self) -> typing.Optional[typing.List[builtins.str]]:
8731
- '''A list of allowed redirect (callback) URLs for the IdPs.
8697
+ '''A list of allowed redirect, or callback, URLs for managed login authentication.
8732
8698
 
8733
- A redirect URI must:
8699
+ 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.
8700
+
8701
+ A redirect URI must meet the following requirements:
8734
8702
 
8735
8703
  - Be an absolute URI.
8736
8704
  - 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.
@@ -8771,9 +8739,9 @@ class CfnUserPoolClientProps:
8771
8739
  def enable_propagate_additional_user_context_data(
8772
8740
  self,
8773
8741
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8774
- '''Activates the propagation of additional user context data.
8742
+ '''When ``true`` , your application can include additional ``UserContextData`` in authentication requests.
8775
8743
 
8776
- For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
8744
+ 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.
8777
8745
 
8778
8746
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-enablepropagateadditionalusercontextdata
8779
8747
  '''
@@ -8784,7 +8752,7 @@ class CfnUserPoolClientProps:
8784
8752
  def enable_token_revocation(
8785
8753
  self,
8786
8754
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8787
- '''Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ .
8755
+ '''Activates or deactivates token revocation.
8788
8756
 
8789
8757
  If you don't include this parameter, token revocation is automatically activated for the new user pool client.
8790
8758
 
@@ -8795,14 +8763,13 @@ class CfnUserPoolClientProps:
8795
8763
 
8796
8764
  @builtins.property
8797
8765
  def explicit_auth_flows(self) -> typing.Optional[typing.List[builtins.str]]:
8798
- '''The authentication flows that you want your user pool client to support.
8766
+ '''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.
8799
8767
 
8800
- 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.
8801
8768
  .. epigraph::
8802
8769
 
8803
- If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` .
8770
+ 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`` .
8804
8771
 
8805
- Valid values include:
8772
+ The values for authentication flow options include the following.
8806
8773
 
8807
8774
  - ``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`` .
8808
8775
 
@@ -8828,7 +8795,7 @@ class CfnUserPoolClientProps:
8828
8795
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
8829
8796
  '''When ``true`` , generates a client secret for the app client.
8830
8797
 
8831
- Client secrets are used with server-side and machine-to-machine applications. 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>`_ .
8798
+ 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>`_ .
8832
8799
 
8833
8800
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret
8834
8801
  '''
@@ -8857,7 +8824,7 @@ class CfnUserPoolClientProps:
8857
8824
  def logout_ur_ls(self) -> typing.Optional[typing.List[builtins.str]]:
8858
8825
  '''A list of allowed logout URLs for managed login authentication.
8859
8826
 
8860
- For more information, see `Logout endpoint <https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html>`_ .
8827
+ 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>`_ .
8861
8828
 
8862
8829
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls
8863
8830
  '''
@@ -8886,7 +8853,7 @@ class CfnUserPoolClientProps:
8886
8853
  def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
8887
8854
  '''The list of user attributes that you want your app client to have read access to.
8888
8855
 
8889
- 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. Your app makes a `GetUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html>`_ API request to retrieve and display your user's profile data.
8856
+ 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.
8890
8857
 
8891
8858
  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.
8892
8859
 
@@ -8922,7 +8889,7 @@ class CfnUserPoolClientProps:
8922
8889
 
8923
8890
  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`` .
8924
8891
 
8925
- This setting applies to providers that you can access with `managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ . 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 API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
8892
+ 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>`_ .
8926
8893
 
8927
8894
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders
8928
8895
  '''
@@ -8946,7 +8913,7 @@ class CfnUserPoolClientProps:
8946
8913
  def write_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
8947
8914
  '''The list of user attributes that you want your app client to have write access to.
8948
8915
 
8949
- 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. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ API request and sets ``family_name`` to the new value.
8916
+ 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.
8950
8917
 
8951
8918
  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.
8952
8919
 
@@ -9012,9 +8979,9 @@ class CfnUserPoolDomain(
9012
8979
  '''
9013
8980
  :param scope: Scope in which this resource is defined.
9014
8981
  :param id: Construct identifier for this resource (unique in its scope).
9015
- :param domain: The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be ``auth.example.com`` . This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
9016
- :param user_pool_id: The ID of the user pool that is associated with the custom domain whose certificate you're updating.
9017
- :param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
8982
+ :param domain: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example ``auth.example.com`` . For prefix domains, this is the prefix alone, such as ``myprefix`` .
8983
+ :param user_pool_id: The ID of the user pool that is associated with the domain you're updating.
8984
+ :param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
9018
8985
  :param managed_login_version: A version number that indicates the state of managed login for your domain. Version ``1`` is hosted UI (classic). Version ``2`` is the newer managed login with the branding designer. For more information, see `Managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ .
9019
8986
  '''
9020
8987
  if __debug__:
@@ -9086,7 +9053,7 @@ class CfnUserPoolDomain(
9086
9053
  @builtins.property
9087
9054
  @jsii.member(jsii_name="domain")
9088
9055
  def domain(self) -> builtins.str:
9089
- '''The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.'''
9056
+ '''The name of the domain that you want to update.'''
9090
9057
  return typing.cast(builtins.str, jsii.get(self, "domain"))
9091
9058
 
9092
9059
  @domain.setter
@@ -9099,7 +9066,7 @@ class CfnUserPoolDomain(
9099
9066
  @builtins.property
9100
9067
  @jsii.member(jsii_name="userPoolId")
9101
9068
  def user_pool_id(self) -> builtins.str:
9102
- '''The ID of the user pool that is associated with the custom domain whose certificate you're updating.'''
9069
+ '''The ID of the user pool that is associated with the domain you're updating.'''
9103
9070
  return typing.cast(builtins.str, jsii.get(self, "userPoolId"))
9104
9071
 
9105
9072
  @user_pool_id.setter
@@ -9153,8 +9120,6 @@ class CfnUserPoolDomain(
9153
9120
  ) -> None:
9154
9121
  '''The configuration for a hosted UI custom domain.
9155
9122
 
9156
- This data type is a request parameter of `CreateUserPoolDomain <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html>`_ and `UpdateUserPoolDomain <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html>`_ .
9157
-
9158
9123
  :param certificate_arn: The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
9159
9124
 
9160
9125
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html
@@ -9221,9 +9186,9 @@ class CfnUserPoolDomainProps:
9221
9186
  ) -> None:
9222
9187
  '''Properties for defining a ``CfnUserPoolDomain``.
9223
9188
 
9224
- :param domain: The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be ``auth.example.com`` . This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
9225
- :param user_pool_id: The ID of the user pool that is associated with the custom domain whose certificate you're updating.
9226
- :param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
9189
+ :param domain: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example ``auth.example.com`` . For prefix domains, this is the prefix alone, such as ``myprefix`` .
9190
+ :param user_pool_id: The ID of the user pool that is associated with the domain you're updating.
9191
+ :param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
9227
9192
  :param managed_login_version: A version number that indicates the state of managed login for your domain. Version ``1`` is hosted UI (classic). Version ``2`` is the newer managed login with the branding designer. For more information, see `Managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ .
9228
9193
 
9229
9194
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html
@@ -9263,11 +9228,9 @@ class CfnUserPoolDomainProps:
9263
9228
 
9264
9229
  @builtins.property
9265
9230
  def domain(self) -> builtins.str:
9266
- '''The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
9267
-
9268
- One example might be ``auth.example.com`` .
9231
+ '''The name of the domain that you want to update.
9269
9232
 
9270
- This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
9233
+ For custom domains, this is the fully-qualified domain name, for example ``auth.example.com`` . For prefix domains, this is the prefix alone, such as ``myprefix`` .
9271
9234
 
9272
9235
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-domain
9273
9236
  '''
@@ -9277,7 +9240,7 @@ class CfnUserPoolDomainProps:
9277
9240
 
9278
9241
  @builtins.property
9279
9242
  def user_pool_id(self) -> builtins.str:
9280
- '''The ID of the user pool that is associated with the custom domain whose certificate you're updating.
9243
+ '''The ID of the user pool that is associated with the domain you're updating.
9281
9244
 
9282
9245
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-userpoolid
9283
9246
  '''
@@ -9293,7 +9256,7 @@ class CfnUserPoolDomainProps:
9293
9256
 
9294
9257
  Use this object to specify an SSL certificate that is managed by ACM.
9295
9258
 
9296
- When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
9259
+ When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
9297
9260
 
9298
9261
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig
9299
9262
  '''
@@ -9333,8 +9296,6 @@ class CfnUserPoolGroup(
9333
9296
 
9334
9297
  Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.
9335
9298
 
9336
- This data type is a response parameter of `AdminListGroupsForUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListGroupsForUser.html>`_ , `CreateGroup <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html>`_ , `GetGroup <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetGroup.html>`_ , `ListGroups <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListGroups.html>`_ , and `UpdateGroup <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateGroup.html>`_ .
9337
-
9338
9299
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html
9339
9300
  :cloudformationResource: AWS::Cognito::UserPoolGroup
9340
9301
  :exampleMetadata: fixture=_generated
@@ -10072,9 +10033,9 @@ class CfnUserPoolProps:
10072
10033
  '''Properties for defining a ``CfnUserPool``.
10073
10034
 
10074
10035
  :param account_recovery_setting: The available verified method a user can use to recover their password when they call ``ForgotPassword`` . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
10075
- :param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
10076
- :param alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
10077
- :param auto_verified_attributes: The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
10036
+ :param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
10037
+ :param alias_attributes: Attributes supported as an alias for this user pool. For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
10038
+ :param auto_verified_attributes: The attributes that you want your user pool to automatically verify. For more information, see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
10078
10039
  :param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
10079
10040
  :param device_configuration: The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see `Working with user devices in your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html>`_ . A null value indicates that you have deactivated device remembering in your user pool. .. epigraph:: When you provide a value for any ``DeviceConfiguration`` field, you activate the Amazon Cognito device-remembering feature. For more infor
10080
10041
  :param email_authentication_message:
@@ -10084,17 +10045,17 @@ class CfnUserPoolProps:
10084
10045
  :param email_verification_subject: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html>`_ .
10085
10046
  :param enabled_mfas: Set enabled MFA options on a specified user pool. To disable all MFAs after it has been enabled, set ``MfaConfiguration`` to ``OFF`` and remove EnabledMfas. MFAs can only be all disabled if ``MfaConfiguration`` is ``OFF`` . After you enable ``SMS_MFA`` , you can only disable it by setting ``MfaConfiguration`` to ``OFF`` . Can be one of the following values: - ``SMS_MFA`` - Enables MFA with SMS for the user pool. To select this option, you must also provide values for ``SmsConfiguration`` . - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. - ``EMAIL_OTP`` - Enables MFA with email for the user pool. To select this option, you must provide values for ``EmailConfiguration`` and within those, set ``EmailSendingAccount`` to ``DEVELOPER`` . Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA`` | ``EMAIL_OTP``
10086
10047
  :param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
10087
- :param mfa_configuration: The multi-factor authentication (MFA) configuration. Valid values include:. - ``OFF`` MFA won't be used for any users. - ``ON`` MFA is required for all users to sign in. - ``OPTIONAL`` MFA will be required only for individual users who have an MFA factor activated.
10088
- :param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
10048
+ :param mfa_configuration: Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ``ON`` , all users must set up MFA before they can sign in. When ``OPTIONAL`` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose ``OPTIONAL`` . When ``MfaConfiguration`` is ``OPTIONAL`` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
10049
+ :param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
10089
10050
  :param schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see `Working with user attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html>`_ .
10090
10051
  :param sms_authentication_message: The contents of the SMS authentication message.
10091
- :param sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
10052
+ :param sms_configuration: The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
10092
10053
  :param sms_verification_message: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html>`_ .
10093
10054
  :param user_attribute_update_settings: The settings for updates to user attributes. These settings include the property ``AttributesRequireVerificationBeforeUpdate`` , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see `Verifying updates to email addresses and phone numbers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates>`_ .
10094
10055
  :param username_attributes: Specifies whether a user can use an email address or phone number as a username when they sign up.
10095
10056
  :param username_configuration: Sets the case sensitivity option for sign-in usernames. When ``CaseSensitive`` is ``false`` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, ``username`` , ``USERNAME`` , or ``UserName`` , or for email, ``email@example.com`` or ``EMaiL@eXamplE.Com`` . For most use cases, set case sensitivity to ``false`` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. When ``CaseSensitive`` is ``true`` (case sensitive), Amazon Cognito interprets ``USERNAME`` and ``UserName`` as distinct users. This configuration is immutable after you set it.
10096
- :param user_pool_add_ons: User pool add-ons. Contains settings for activation of threat protection. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to risky traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
10097
- :param user_pool_name: A friendlhy name for your user pool.
10057
+ :param user_pool_add_ons: Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
10058
+ :param user_pool_name: A friendly name for your user pool.
10098
10059
  :param user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
10099
10060
  :param user_pool_tier: The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .
10100
10061
  :param verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your ``DefaultEmailOption`` selection. For ``CONFIRM_WITH_LINK`` , specify an ``EmailMessageByLink`` and leave ``EmailMessage`` blank. For ``CONFIRM_WITH_CODE`` , specify an ``EmailMessage`` and leave ``EmailMessageByLink`` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
@@ -10349,8 +10310,6 @@ class CfnUserPoolProps:
10349
10310
 
10350
10311
  Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
10351
10312
 
10352
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
10353
-
10354
10313
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
10355
10314
  '''
10356
10315
  result = self._values.get("admin_create_user_config")
@@ -10360,7 +10319,7 @@ class CfnUserPoolProps:
10360
10319
  def alias_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
10361
10320
  '''Attributes supported as an alias for this user pool.
10362
10321
 
10363
- Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
10322
+ For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
10364
10323
 
10365
10324
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes
10366
10325
  '''
@@ -10371,7 +10330,7 @@ class CfnUserPoolProps:
10371
10330
  def auto_verified_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
10372
10331
  '''The attributes that you want your user pool to automatically verify.
10373
10332
 
10374
- Possible values: *email* , *phone_number* . For more information see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
10333
+ For more information, see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
10375
10334
 
10376
10335
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes
10377
10336
  '''
@@ -10491,11 +10450,11 @@ class CfnUserPoolProps:
10491
10450
 
10492
10451
  @builtins.property
10493
10452
  def mfa_configuration(self) -> typing.Optional[builtins.str]:
10494
- '''The multi-factor authentication (MFA) configuration. Valid values include:.
10453
+ '''Displays the state of multi-factor authentication (MFA) as on, off, or optional.
10495
10454
 
10496
- - ``OFF`` MFA won't be used for any users.
10497
- - ``ON`` MFA is required for all users to sign in.
10498
- - ``OPTIONAL`` MFA will be required only for individual users who have an MFA factor activated.
10455
+ When ``ON`` , all users must set up MFA before they can sign in. When ``OPTIONAL`` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose ``OPTIONAL`` .
10456
+
10457
+ When ``MfaConfiguration`` is ``OPTIONAL`` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
10499
10458
 
10500
10459
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration
10501
10460
  '''
@@ -10506,9 +10465,9 @@ class CfnUserPoolProps:
10506
10465
  def policies(
10507
10466
  self,
10508
10467
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.PoliciesProperty]]:
10509
- '''A list of user pool policies. Contains the policy that sets password-complexity requirements.
10468
+ '''A list of user pool policies.
10510
10469
 
10511
- This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
10470
+ Contains the policy that sets password-complexity requirements.
10512
10471
 
10513
10472
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
10514
10473
  '''
@@ -10541,7 +10500,7 @@ class CfnUserPoolProps:
10541
10500
  def sms_configuration(
10542
10501
  self,
10543
10502
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.SmsConfigurationProperty]]:
10544
- '''The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
10503
+ '''The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
10545
10504
 
10546
10505
  To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
10547
10506
 
@@ -10606,9 +10565,9 @@ class CfnUserPoolProps:
10606
10565
  def user_pool_add_ons(
10607
10566
  self,
10608
10567
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.UserPoolAddOnsProperty]]:
10609
- '''User pool add-ons.
10568
+ '''Contains settings for activation of threat protection, including the operating mode and additional authentication types.
10610
10569
 
10611
- Contains settings for activation of threat protection. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to risky traffic to your user pool, set to ``ENFORCED`` .
10570
+ To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ``ENFORCED`` .
10612
10571
 
10613
10572
  For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
10614
10573
 
@@ -10619,7 +10578,7 @@ class CfnUserPoolProps:
10619
10578
 
10620
10579
  @builtins.property
10621
10580
  def user_pool_name(self) -> typing.Optional[builtins.str]:
10622
- '''A friendlhy name for your user pool.
10581
+ '''A friendly name for your user pool.
10623
10582
 
10624
10583
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname
10625
10584
  '''
@@ -10869,8 +10828,6 @@ class CfnUserPoolResourceServer(
10869
10828
 
10870
10829
  This data type is a member of ``ResourceServerScopeType`` . For more information, see `Scopes, M2M, and API authorization with resource servers <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html>`_ .
10871
10830
 
10872
- This data type is a request parameter of `CreateResourceServer <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html>`_ and a response parameter of `DescribeResourceServer <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html>`_ .
10873
-
10874
10831
  :param scope_description: A friendly description of a custom scope.
10875
10832
  :param scope_name: The name of the scope. Amazon Cognito renders custom scopes in the format ``resourceServerIdentifier/ScopeName`` . For example, if this parameter is ``exampleScope`` in the resource server with the identifier ``exampleResourceServer`` , you request and receive the scope ``exampleResourceServer/exampleScope`` .
10876
10833
 
@@ -11153,8 +11110,8 @@ class CfnUserPoolRiskConfigurationAttachment(
11153
11110
  :param id: Construct identifier for this resource (unique in its scope).
11154
11111
  :param client_id: The app client where this configuration is applied. When this parameter isn't present, the risk configuration applies to all user pool app clients that don't have client-level settings.
11155
11112
  :param user_pool_id: The ID of the user pool that has the risk configuration applied.
11156
- :param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
11157
- :param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
11113
+ :param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with threat protection.
11114
+ :param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with threat protection in full-function ``ENFORCED`` mode.
11158
11115
  :param risk_exception_configuration: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
11159
11116
  '''
11160
11117
  if __debug__:
@@ -11237,7 +11194,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11237
11194
  def account_takeover_risk_configuration(
11238
11195
  self,
11239
11196
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]]:
11240
- '''The settings for automated responses and notification templates for adaptive authentication with advanced security features.'''
11197
+ '''The settings for automated responses and notification templates for adaptive authentication with threat protection.'''
11241
11198
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]], jsii.get(self, "accountTakeoverRiskConfiguration"))
11242
11199
 
11243
11200
  @account_takeover_risk_configuration.setter
@@ -11255,7 +11212,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11255
11212
  def compromised_credentials_risk_configuration(
11256
11213
  self,
11257
11214
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]]:
11258
- '''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.'''
11215
+ '''Settings for compromised-credentials actions and authentication types with threat protection in full-function ``ENFORCED`` mode.'''
11259
11216
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]], jsii.get(self, "compromisedCredentialsRiskConfiguration"))
11260
11217
 
11261
11218
  @compromised_credentials_risk_configuration.setter
@@ -11302,8 +11259,6 @@ class CfnUserPoolRiskConfigurationAttachment(
11302
11259
 
11303
11260
  You can assign an action to each risk level that advanced security features evaluates.
11304
11261
 
11305
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11306
-
11307
11262
  :param event_action: The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows: - ``BLOCK`` : Block the request. - ``MFA_IF_CONFIGURED`` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request. - ``MFA_REQUIRED`` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor. - ``NO_ACTION`` : Take no action. Permit sign-in.
11308
11263
  :param notify: Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
11309
11264
 
@@ -11387,11 +11342,9 @@ class CfnUserPoolRiskConfigurationAttachment(
11387
11342
  ) -> None:
11388
11343
  '''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
11389
11344
 
11390
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11391
-
11392
- :param high_action: The action that you assign to a high-risk assessment by advanced security features.
11393
- :param low_action: The action that you assign to a low-risk assessment by advanced security features.
11394
- :param medium_action: The action that you assign to a medium-risk assessment by advanced security features.
11345
+ :param high_action: The action that you assign to a high-risk assessment by threat protection.
11346
+ :param low_action: The action that you assign to a low-risk assessment by threat protection.
11347
+ :param medium_action: The action that you assign to a medium-risk assessment by threat protection.
11395
11348
 
11396
11349
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html
11397
11350
  :exampleMetadata: fixture=_generated
@@ -11434,7 +11387,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11434
11387
  def high_action(
11435
11388
  self,
11436
11389
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
11437
- '''The action that you assign to a high-risk assessment by advanced security features.
11390
+ '''The action that you assign to a high-risk assessment by threat protection.
11438
11391
 
11439
11392
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction
11440
11393
  '''
@@ -11445,7 +11398,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11445
11398
  def low_action(
11446
11399
  self,
11447
11400
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
11448
- '''The action that you assign to a low-risk assessment by advanced security features.
11401
+ '''The action that you assign to a low-risk assessment by threat protection.
11449
11402
 
11450
11403
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction
11451
11404
  '''
@@ -11456,7 +11409,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11456
11409
  def medium_action(
11457
11410
  self,
11458
11411
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
11459
- '''The action that you assign to a medium-risk assessment by advanced security features.
11412
+ '''The action that you assign to a medium-risk assessment by threat protection.
11460
11413
 
11461
11414
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction
11462
11415
  '''
@@ -11491,10 +11444,8 @@ class CfnUserPoolRiskConfigurationAttachment(
11491
11444
  ) -> None:
11492
11445
  '''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
11493
11446
 
11494
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11495
-
11496
- :param actions: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
11497
- :param notify_configuration: The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication. When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
11447
+ :param actions: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection.
11448
+ :param notify_configuration: The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
11498
11449
 
11499
11450
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html
11500
11451
  :exampleMetadata: fixture=_generated
@@ -11566,7 +11517,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11566
11517
  def actions(
11567
11518
  self,
11568
11519
  ) -> typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty"]:
11569
- '''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
11520
+ '''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection.
11570
11521
 
11571
11522
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions
11572
11523
  '''
@@ -11578,7 +11529,7 @@ class CfnUserPoolRiskConfigurationAttachment(
11578
11529
  def notify_configuration(
11579
11530
  self,
11580
11531
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty"]]:
11581
- '''The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication.
11532
+ '''The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication.
11582
11533
 
11583
11534
  When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
11584
11535
 
@@ -11607,8 +11558,6 @@ class CfnUserPoolRiskConfigurationAttachment(
11607
11558
  def __init__(self, *, event_action: builtins.str) -> None:
11608
11559
  '''Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ``ENFORCED`` mode.
11609
11560
 
11610
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11611
-
11612
11561
  :param event_action: The action that Amazon Cognito takes when it detects compromised credentials.
11613
11562
 
11614
11563
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html
@@ -11666,8 +11615,6 @@ class CfnUserPoolRiskConfigurationAttachment(
11666
11615
  ) -> None:
11667
11616
  '''Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function ``ENFORCED`` mode.
11668
11617
 
11669
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11670
-
11671
11618
  :param actions: Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
11672
11619
  :param event_filter: Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.
11673
11620
 
@@ -11758,8 +11705,6 @@ class CfnUserPoolRiskConfigurationAttachment(
11758
11705
  ) -> None:
11759
11706
  '''The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a *Notify* action.
11760
11707
 
11761
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11762
-
11763
11708
  :param source_arn: The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the ``From`` parameter.
11764
11709
  :param block_email: The template for the email message that your user pool sends when a detected risk event is blocked.
11765
11710
  :param from_: The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
@@ -11922,8 +11867,6 @@ class CfnUserPoolRiskConfigurationAttachment(
11922
11867
  ) -> None:
11923
11868
  '''The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
11924
11869
 
11925
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
11926
-
11927
11870
  :param subject: The subject of the threat protection email notification.
11928
11871
  :param html_body: The body of an email notification formatted in HTML. Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
11929
11872
  :param text_body: The body of an email notification formatted in plaintext. Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
@@ -12018,8 +11961,6 @@ class CfnUserPoolRiskConfigurationAttachment(
12018
11961
  ) -> None:
12019
11962
  '''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
12020
11963
 
12021
- This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
12022
-
12023
11964
  :param blocked_ip_range_list: An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
12024
11965
  :param skipped_ip_range_list: An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
12025
11966
 
@@ -12106,8 +12047,8 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
12106
12047
 
12107
12048
  :param client_id: The app client where this configuration is applied. When this parameter isn't present, the risk configuration applies to all user pool app clients that don't have client-level settings.
12108
12049
  :param user_pool_id: The ID of the user pool that has the risk configuration applied.
12109
- :param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
12110
- :param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
12050
+ :param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with threat protection.
12051
+ :param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with threat protection in full-function ``ENFORCED`` mode.
12111
12052
  :param risk_exception_configuration: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
12112
12053
 
12113
12054
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html
@@ -12228,7 +12169,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
12228
12169
  def account_takeover_risk_configuration(
12229
12170
  self,
12230
12171
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty]]:
12231
- '''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
12172
+ '''The settings for automated responses and notification templates for adaptive authentication with threat protection.
12232
12173
 
12233
12174
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration
12234
12175
  '''
@@ -12239,7 +12180,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
12239
12180
  def compromised_credentials_risk_configuration(
12240
12181
  self,
12241
12182
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty]]:
12242
- '''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
12183
+ '''Settings for compromised-credentials actions and authentication types with threat protection in full-function ``ENFORCED`` mode.
12243
12184
 
12244
12185
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration
12245
12186
  '''
@@ -12277,8 +12218,6 @@ class CfnUserPoolUICustomizationAttachment(
12277
12218
  ):
12278
12219
  '''A container for the UI customization information for the hosted UI in a user pool.
12279
12220
 
12280
- This data type is a response parameter of `GetUICustomization <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html>`_ .
12281
-
12282
12221
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html
12283
12222
  :cloudformationResource: AWS::Cognito::UserPoolUICustomizationAttachment
12284
12223
  :exampleMetadata: fixture=_generated
@@ -12311,8 +12250,8 @@ class CfnUserPoolUICustomizationAttachment(
12311
12250
  :param scope: Scope in which this resource is defined.
12312
12251
  :param id: Construct identifier for this resource (unique in its scope).
12313
12252
  :param client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings..
12314
- :param user_pool_id: The ID of the user pool.
12315
- :param css: The CSS values in the UI customization.
12253
+ :param user_pool_id: The ID of the user pool where you want to apply branding to the classic hosted UI.
12254
+ :param css: A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool *App clients* tab, select *Login pages* , edit *Hosted UI (classic) style* , and select the link to ``CSS template.css`` .
12316
12255
  '''
12317
12256
  if __debug__:
12318
12257
  type_hints = typing.get_type_hints(_typecheckingstub__bf3306ea8a9b6f4ebe73eb42059e52138281652a9e2e36e507fd8658eb5da33a)
@@ -12375,7 +12314,7 @@ class CfnUserPoolUICustomizationAttachment(
12375
12314
  @builtins.property
12376
12315
  @jsii.member(jsii_name="userPoolId")
12377
12316
  def user_pool_id(self) -> builtins.str:
12378
- '''The ID of the user pool.'''
12317
+ '''The ID of the user pool where you want to apply branding to the classic hosted UI.'''
12379
12318
  return typing.cast(builtins.str, jsii.get(self, "userPoolId"))
12380
12319
 
12381
12320
  @user_pool_id.setter
@@ -12388,7 +12327,7 @@ class CfnUserPoolUICustomizationAttachment(
12388
12327
  @builtins.property
12389
12328
  @jsii.member(jsii_name="css")
12390
12329
  def css(self) -> typing.Optional[builtins.str]:
12391
- '''The CSS values in the UI customization.'''
12330
+ '''A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.'''
12392
12331
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "css"))
12393
12332
 
12394
12333
  @css.setter
@@ -12415,8 +12354,8 @@ class CfnUserPoolUICustomizationAttachmentProps:
12415
12354
  '''Properties for defining a ``CfnUserPoolUICustomizationAttachment``.
12416
12355
 
12417
12356
  :param client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings..
12418
- :param user_pool_id: The ID of the user pool.
12419
- :param css: The CSS values in the UI customization.
12357
+ :param user_pool_id: The ID of the user pool where you want to apply branding to the classic hosted UI.
12358
+ :param css: A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool *App clients* tab, select *Login pages* , edit *Hosted UI (classic) style* , and select the link to ``CSS template.css`` .
12420
12359
 
12421
12360
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html
12422
12361
  :exampleMetadata: fixture=_generated
@@ -12461,7 +12400,7 @@ class CfnUserPoolUICustomizationAttachmentProps:
12461
12400
 
12462
12401
  @builtins.property
12463
12402
  def user_pool_id(self) -> builtins.str:
12464
- '''The ID of the user pool.
12403
+ '''The ID of the user pool where you want to apply branding to the classic hosted UI.
12465
12404
 
12466
12405
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-userpoolid
12467
12406
  '''
@@ -12471,7 +12410,9 @@ class CfnUserPoolUICustomizationAttachmentProps:
12471
12410
 
12472
12411
  @builtins.property
12473
12412
  def css(self) -> typing.Optional[builtins.str]:
12474
- '''The CSS values in the UI customization.
12413
+ '''A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.
12414
+
12415
+ To download a template, go to the Amazon Cognito console. Navigate to your user pool *App clients* tab, select *Login pages* , edit *Hosted UI (classic) style* , and select the link to ``CSS template.css`` .
12475
12416
 
12476
12417
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-css
12477
12418
  '''
@@ -12552,9 +12493,9 @@ class CfnUserPoolUser(
12552
12493
  :param desired_delivery_mediums: Specify ``EMAIL`` if email will be used to send the welcome message. Specify ``SMS`` if the phone number will be used. The default value is ``SMS`` . You can specify more than one value.
12553
12494
  :param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the ``UserAttributes`` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
12554
12495
  :param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
12555
- :param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
12496
+ :param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
12556
12497
  :param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
12557
- :param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
12498
+ :param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
12558
12499
  '''
12559
12500
  if __debug__:
12560
12501
  type_hints = typing.get_type_hints(_typecheckingstub__392de74de1133635a0d4d21dbd0cb3290007171e021625ff9a125983463dd374)
@@ -12749,8 +12690,6 @@ class CfnUserPoolUser(
12749
12690
  ) -> None:
12750
12691
  '''The name and value of a user attribute.
12751
12692
 
12752
- This data type is a request parameter of `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ and `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ .
12753
-
12754
12693
  :param name: The name of the attribute.
12755
12694
  :param value: The value of the attribute.
12756
12695
 
@@ -12842,9 +12781,9 @@ class CfnUserPoolUserProps:
12842
12781
  :param desired_delivery_mediums: Specify ``EMAIL`` if email will be used to send the welcome message. Specify ``SMS`` if the phone number will be used. The default value is ``SMS`` . You can specify more than one value.
12843
12782
  :param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the ``UserAttributes`` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
12844
12783
  :param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
12845
- :param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
12784
+ :param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
12846
12785
  :param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
12847
- :param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
12786
+ :param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
12848
12787
 
12849
12788
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html
12850
12789
  :exampleMetadata: fixture=_generated
@@ -12989,7 +12928,7 @@ class CfnUserPoolUserProps:
12989
12928
 
12990
12929
  You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` .
12991
12930
 
12992
- In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .
12931
+ In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` .
12993
12932
 
12994
12933
  - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter.
12995
12934
  - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
@@ -13022,7 +12961,7 @@ class CfnUserPoolUserProps:
13022
12961
 
13023
12962
  This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
13024
12963
 
13025
- Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
12964
+ Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.
13026
12965
 
13027
12966
  For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
13028
12967
 
@@ -13989,12 +13928,14 @@ class IUserPool(_IResource_c80c4260, typing_extensions.Protocol):
13989
13928
  *,
13990
13929
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13991
13930
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13931
+ managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
13992
13932
  ) -> "UserPoolDomain":
13993
13933
  '''Associate a domain to this user pool.
13994
13934
 
13995
13935
  :param id: -
13996
13936
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
13997
13937
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
13938
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
13998
13939
 
13999
13940
  :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
14000
13941
  '''
@@ -14176,12 +14117,14 @@ class _IUserPoolProxy(
14176
14117
  *,
14177
14118
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
14178
14119
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
14120
+ managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
14179
14121
  ) -> "UserPoolDomain":
14180
14122
  '''Associate a domain to this user pool.
14181
14123
 
14182
14124
  :param id: -
14183
14125
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
14184
14126
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
14127
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
14185
14128
 
14186
14129
  :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
14187
14130
  '''
@@ -14189,7 +14132,9 @@ class _IUserPoolProxy(
14189
14132
  type_hints = typing.get_type_hints(_typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e7b1a458)
14190
14133
  check_type(argname="argument id", value=id, expected_type=type_hints["id"])
14191
14134
  options = UserPoolDomainOptions(
14192
- cognito_domain=cognito_domain, custom_domain=custom_domain
14135
+ cognito_domain=cognito_domain,
14136
+ custom_domain=custom_domain,
14137
+ managed_login_version=managed_login_version,
14193
14138
  )
14194
14139
 
14195
14140
  return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
@@ -14580,6 +14525,39 @@ class LambdaVersion(enum.Enum):
14580
14525
  '''
14581
14526
 
14582
14527
 
14528
+ @jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.ManagedLoginVersion")
14529
+ class ManagedLoginVersion(enum.Enum):
14530
+ '''The branding version of managed login for the domain.
14531
+
14532
+ :exampleMetadata: infused
14533
+
14534
+ Example::
14535
+
14536
+ pool = cognito.UserPool(self, "Pool")
14537
+
14538
+ # Use the new managed login page
14539
+ pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
14540
+ cognito_domain=cognito.CognitoDomainOptions(
14541
+ domain_prefix="blanding-design-ui"
14542
+ ),
14543
+ managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
14544
+ )
14545
+
14546
+ # Use the classic hosted UI
14547
+ pool.add_domain("DomainWithClassicHostedUi",
14548
+ cognito_domain=cognito.CognitoDomainOptions(
14549
+ domain_prefix="classic-hosted-ui"
14550
+ ),
14551
+ managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
14552
+ )
14553
+ '''
14554
+
14555
+ CLASSIC_HOSTED_UI = "CLASSIC_HOSTED_UI"
14556
+ '''The classic hosted UI.'''
14557
+ NEWER_MANAGED_LOGIN = "NEWER_MANAGED_LOGIN"
14558
+ '''The newer managed login with the branding designer.'''
14559
+
14560
+
14583
14561
  @jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.Mfa")
14584
14562
  class Mfa(enum.Enum):
14585
14563
  '''The different ways in which a user pool's MFA enforcement can be configured.
@@ -17441,18 +17419,22 @@ class UserPool(
17441
17419
  *,
17442
17420
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
17443
17421
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
17422
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
17444
17423
  ) -> "UserPoolDomain":
17445
17424
  '''Associate a domain to this user pool.
17446
17425
 
17447
17426
  :param id: -
17448
17427
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
17449
17428
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
17429
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
17450
17430
  '''
17451
17431
  if __debug__:
17452
17432
  type_hints = typing.get_type_hints(_typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2d48a103)
17453
17433
  check_type(argname="argument id", value=id, expected_type=type_hints["id"])
17454
17434
  options = UserPoolDomainOptions(
17455
- cognito_domain=cognito_domain, custom_domain=custom_domain
17435
+ cognito_domain=cognito_domain,
17436
+ custom_domain=custom_domain,
17437
+ managed_login_version=managed_login_version,
17456
17438
  )
17457
17439
 
17458
17440
  return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
@@ -18505,6 +18487,7 @@ class UserPoolDomain(
18505
18487
  user_pool: IUserPool,
18506
18488
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18507
18489
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18490
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
18508
18491
  ) -> None:
18509
18492
  '''
18510
18493
  :param scope: -
@@ -18512,6 +18495,7 @@ class UserPoolDomain(
18512
18495
  :param user_pool: The user pool to which this domain should be associated.
18513
18496
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
18514
18497
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
18498
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
18515
18499
  '''
18516
18500
  if __debug__:
18517
18501
  type_hints = typing.get_type_hints(_typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94152b471)
@@ -18521,6 +18505,7 @@ class UserPoolDomain(
18521
18505
  user_pool=user_pool,
18522
18506
  cognito_domain=cognito_domain,
18523
18507
  custom_domain=custom_domain,
18508
+ managed_login_version=managed_login_version,
18524
18509
  )
18525
18510
 
18526
18511
  jsii.create(self.__class__, self, [scope, id, props])
@@ -18614,7 +18599,11 @@ class UserPoolDomain(
18614
18599
  @jsii.data_type(
18615
18600
  jsii_type="aws-cdk-lib.aws_cognito.UserPoolDomainOptions",
18616
18601
  jsii_struct_bases=[],
18617
- name_mapping={"cognito_domain": "cognitoDomain", "custom_domain": "customDomain"},
18602
+ name_mapping={
18603
+ "cognito_domain": "cognitoDomain",
18604
+ "custom_domain": "customDomain",
18605
+ "managed_login_version": "managedLoginVersion",
18606
+ },
18618
18607
  )
18619
18608
  class UserPoolDomainOptions:
18620
18609
  def __init__(
@@ -18622,11 +18611,13 @@ class UserPoolDomainOptions:
18622
18611
  *,
18623
18612
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18624
18613
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18614
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
18625
18615
  ) -> None:
18626
18616
  '''Options to create a UserPoolDomain.
18627
18617
 
18628
18618
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
18629
18619
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
18620
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
18630
18621
 
18631
18622
  :exampleMetadata: infused
18632
18623
 
@@ -18658,11 +18649,14 @@ class UserPoolDomainOptions:
18658
18649
  type_hints = typing.get_type_hints(_typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af679070c0)
18659
18650
  check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
18660
18651
  check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
18652
+ check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
18661
18653
  self._values: typing.Dict[builtins.str, typing.Any] = {}
18662
18654
  if cognito_domain is not None:
18663
18655
  self._values["cognito_domain"] = cognito_domain
18664
18656
  if custom_domain is not None:
18665
18657
  self._values["custom_domain"] = custom_domain
18658
+ if managed_login_version is not None:
18659
+ self._values["managed_login_version"] = managed_login_version
18666
18660
 
18667
18661
  @builtins.property
18668
18662
  def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
@@ -18686,6 +18680,19 @@ class UserPoolDomainOptions:
18686
18680
  result = self._values.get("custom_domain")
18687
18681
  return typing.cast(typing.Optional[CustomDomainOptions], result)
18688
18682
 
18683
+ @builtins.property
18684
+ def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
18685
+ '''A version that indicates the state of managed login.
18686
+
18687
+ This choice applies to all app clients that host services at the domain.
18688
+
18689
+ :default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
18690
+
18691
+ :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
18692
+ '''
18693
+ result = self._values.get("managed_login_version")
18694
+ return typing.cast(typing.Optional[ManagedLoginVersion], result)
18695
+
18689
18696
  def __eq__(self, rhs: typing.Any) -> builtins.bool:
18690
18697
  return isinstance(rhs, self.__class__) and rhs._values == self._values
18691
18698
 
@@ -18704,6 +18711,7 @@ class UserPoolDomainOptions:
18704
18711
  name_mapping={
18705
18712
  "cognito_domain": "cognitoDomain",
18706
18713
  "custom_domain": "customDomain",
18714
+ "managed_login_version": "managedLoginVersion",
18707
18715
  "user_pool": "userPool",
18708
18716
  },
18709
18717
  )
@@ -18713,12 +18721,14 @@ class UserPoolDomainProps(UserPoolDomainOptions):
18713
18721
  *,
18714
18722
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18715
18723
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
18724
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
18716
18725
  user_pool: IUserPool,
18717
18726
  ) -> None:
18718
18727
  '''Props for UserPoolDomain construct.
18719
18728
 
18720
18729
  :param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
18721
18730
  :param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
18731
+ :param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
18722
18732
  :param user_pool: The user pool to which this domain should be associated.
18723
18733
 
18724
18734
  :exampleMetadata: infused
@@ -18791,6 +18801,7 @@ class UserPoolDomainProps(UserPoolDomainOptions):
18791
18801
  type_hints = typing.get_type_hints(_typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c34f7baa)
18792
18802
  check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
18793
18803
  check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
18804
+ check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
18794
18805
  check_type(argname="argument user_pool", value=user_pool, expected_type=type_hints["user_pool"])
18795
18806
  self._values: typing.Dict[builtins.str, typing.Any] = {
18796
18807
  "user_pool": user_pool,
@@ -18799,6 +18810,8 @@ class UserPoolDomainProps(UserPoolDomainOptions):
18799
18810
  self._values["cognito_domain"] = cognito_domain
18800
18811
  if custom_domain is not None:
18801
18812
  self._values["custom_domain"] = custom_domain
18813
+ if managed_login_version is not None:
18814
+ self._values["managed_login_version"] = managed_login_version
18802
18815
 
18803
18816
  @builtins.property
18804
18817
  def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
@@ -18822,6 +18835,19 @@ class UserPoolDomainProps(UserPoolDomainOptions):
18822
18835
  result = self._values.get("custom_domain")
18823
18836
  return typing.cast(typing.Optional[CustomDomainOptions], result)
18824
18837
 
18838
+ @builtins.property
18839
+ def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
18840
+ '''A version that indicates the state of managed login.
18841
+
18842
+ This choice applies to all app clients that host services at the domain.
18843
+
18844
+ :default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
18845
+
18846
+ :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
18847
+ '''
18848
+ result = self._values.get("managed_login_version")
18849
+ return typing.cast(typing.Optional[ManagedLoginVersion], result)
18850
+
18825
18851
  @builtins.property
18826
18852
  def user_pool(self) -> IUserPool:
18827
18853
  '''The user pool to which this domain should be associated.'''
@@ -22924,6 +22950,7 @@ __all__ = [
22924
22950
  "IUserPoolResourceServer",
22925
22951
  "KeepOriginalAttrs",
22926
22952
  "LambdaVersion",
22953
+ "ManagedLoginVersion",
22927
22954
  "Mfa",
22928
22955
  "MfaSecondFactor",
22929
22956
  "NumberAttribute",
@@ -24851,6 +24878,7 @@ def _typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e
24851
24878
  *,
24852
24879
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
24853
24880
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
24881
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
24854
24882
  ) -> None:
24855
24883
  """Type checking stubs"""
24856
24884
  pass
@@ -25171,6 +25199,7 @@ def _typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2
25171
25199
  *,
25172
25200
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25173
25201
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25202
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
25174
25203
  ) -> None:
25175
25204
  """Type checking stubs"""
25176
25205
  pass
@@ -25305,6 +25334,7 @@ def _typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94
25305
25334
  user_pool: IUserPool,
25306
25335
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25307
25336
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25337
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
25308
25338
  ) -> None:
25309
25339
  """Type checking stubs"""
25310
25340
  pass
@@ -25331,6 +25361,7 @@ def _typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af6
25331
25361
  *,
25332
25362
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25333
25363
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25364
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
25334
25365
  ) -> None:
25335
25366
  """Type checking stubs"""
25336
25367
  pass
@@ -25339,6 +25370,7 @@ def _typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c
25339
25370
  *,
25340
25371
  cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25341
25372
  custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
25373
+ managed_login_version: typing.Optional[ManagedLoginVersion] = None,
25342
25374
  user_pool: IUserPool,
25343
25375
  ) -> None:
25344
25376
  """Type checking stubs"""