aws-cdk-lib 2.176.0__py3-none-any.whl → 2.178.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.
- aws_cdk/__init__.py +106 -62
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.176.0.jsii.tgz → aws-cdk-lib@2.178.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplifyuibuilder/__init__.py +8 -8
- aws_cdk/aws_apigateway/__init__.py +97 -97
- aws_cdk/aws_apigatewayv2/__init__.py +35 -10
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +2 -2
- aws_cdk/aws_appconfig/__init__.py +10 -10
- aws_cdk/aws_appflow/__init__.py +20 -20
- aws_cdk/aws_applicationsignals/__init__.py +8 -8
- aws_cdk/aws_appmesh/__init__.py +8 -8
- aws_cdk/aws_appsync/__init__.py +10387 -7038
- aws_cdk/aws_apptest/__init__.py +4 -4
- aws_cdk/aws_aps/__init__.py +135 -0
- aws_cdk/aws_athena/__init__.py +10 -10
- aws_cdk/aws_backup/__init__.py +14 -14
- aws_cdk/aws_batch/__init__.py +189 -24
- aws_cdk/aws_bcmdataexports/__init__.py +4 -4
- aws_cdk/aws_bedrock/__init__.py +5494 -2518
- aws_cdk/aws_certificatemanager/__init__.py +15 -14
- aws_cdk/aws_chatbot/__init__.py +4 -4
- aws_cdk/aws_cloudformation/__init__.py +22 -18
- aws_cdk/aws_cloudfront/__init__.py +686 -9
- aws_cdk/aws_cloudfront_origins/__init__.py +73 -2
- aws_cdk/aws_cloudtrail/__init__.py +4 -4
- aws_cdk/aws_cloudwatch/__init__.py +53 -53
- aws_cdk/aws_codedeploy/__init__.py +2 -2
- aws_cdk/aws_codepipeline/__init__.py +59 -6
- aws_cdk/aws_codepipeline_actions/__init__.py +2 -2
- aws_cdk/aws_cognito/__init__.py +204 -159
- aws_cdk/aws_connect/__init__.py +4 -4
- aws_cdk/aws_customerprofiles/__init__.py +6 -4
- aws_cdk/aws_databrew/__init__.py +16 -16
- aws_cdk/aws_datasync/__init__.py +14 -11
- aws_cdk/aws_datazone/__init__.py +199 -129
- aws_cdk/aws_dms/__init__.py +4 -4
- aws_cdk/aws_dynamodb/__init__.py +267 -25
- aws_cdk/aws_ec2/__init__.py +1142 -184
- aws_cdk/aws_ecs/__init__.py +767 -124
- aws_cdk/aws_ecs_patterns/__init__.py +49 -0
- aws_cdk/aws_efs/__init__.py +8 -8
- aws_cdk/aws_eks/__init__.py +55 -35
- aws_cdk/aws_elasticache/__init__.py +10 -10
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +47 -18
- aws_cdk/aws_elasticsearch/__init__.py +10 -10
- aws_cdk/aws_emr/__init__.py +16 -16
- aws_cdk/aws_emrserverless/__init__.py +93 -4
- aws_cdk/aws_entityresolution/__init__.py +31 -17
- aws_cdk/aws_events/__init__.py +12 -12
- aws_cdk/aws_fis/__init__.py +16 -16
- aws_cdk/aws_fms/__init__.py +46 -0
- aws_cdk/aws_gamelift/__init__.py +8 -10
- aws_cdk/aws_glue/__init__.py +1326 -7
- aws_cdk/aws_greengrassv2/__init__.py +8 -8
- aws_cdk/aws_guardduty/__init__.py +521 -0
- aws_cdk/aws_healthlake/__init__.py +10 -2
- aws_cdk/aws_iam/__init__.py +8 -0
- aws_cdk/aws_imagebuilder/__init__.py +88 -74
- aws_cdk/aws_iot/__init__.py +40 -40
- aws_cdk/aws_iotanalytics/__init__.py +4 -4
- aws_cdk/aws_iotfleetwise/__init__.py +424 -10
- aws_cdk/aws_iotsitewise/__init__.py +84 -13
- aws_cdk/aws_iottwinmaker/__init__.py +18 -18
- aws_cdk/aws_iotwireless/__init__.py +4 -4
- aws_cdk/aws_kafkaconnect/__init__.py +10 -10
- aws_cdk/aws_kendra/__init__.py +0 -10
- aws_cdk/aws_kinesisanalytics/__init__.py +4 -4
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +4 -4
- aws_cdk/aws_kinesisfirehose/__init__.py +4544 -183
- aws_cdk/aws_kms/__init__.py +11 -10
- aws_cdk/aws_lambda/__init__.py +47 -4
- aws_cdk/aws_lambda_nodejs/__init__.py +24 -5
- aws_cdk/aws_launchwizard/__init__.py +10 -10
- aws_cdk/aws_logs/__init__.py +78 -74
- aws_cdk/aws_mediaconnect/__init__.py +509 -12
- aws_cdk/aws_medialive/__init__.py +16 -16
- aws_cdk/aws_mediatailor/__init__.py +10 -10
- aws_cdk/aws_networkfirewall/__init__.py +12 -12
- aws_cdk/aws_notifications/__init__.py +1927 -0
- aws_cdk/aws_notificationscontacts/__init__.py +593 -0
- aws_cdk/aws_omics/__init__.py +4 -4
- aws_cdk/aws_opensearchservice/__init__.py +10 -10
- aws_cdk/aws_opsworks/__init__.py +58 -58
- aws_cdk/aws_personalize/__init__.py +8 -8
- aws_cdk/aws_pipes/__init__.py +20 -20
- aws_cdk/aws_qbusiness/__init__.py +119 -0
- aws_cdk/aws_quicksight/__init__.py +247 -92
- aws_cdk/aws_rds/__init__.py +37 -37
- aws_cdk/aws_redshift/__init__.py +19 -15
- aws_cdk/aws_resiliencehub/__init__.py +0 -41
- aws_cdk/aws_route53/__init__.py +10 -4
- aws_cdk/aws_route53_targets/__init__.py +15 -15
- aws_cdk/aws_rum/__init__.py +4 -4
- aws_cdk/aws_s3/__init__.py +801 -2
- aws_cdk/aws_s3_notifications/__init__.py +5 -5
- aws_cdk/aws_s3tables/__init__.py +2 -2
- aws_cdk/aws_sagemaker/__init__.py +84 -60
- aws_cdk/aws_sam/__init__.py +48 -48
- aws_cdk/aws_secretsmanager/__init__.py +30 -14
- aws_cdk/aws_securityhub/__init__.py +12 -12
- aws_cdk/aws_sns/__init__.py +137 -12
- aws_cdk/aws_ssm/__init__.py +5 -5
- aws_cdk/aws_ssmquicksetup/__init__.py +10 -10
- aws_cdk/aws_stepfunctions/__init__.py +13207 -4740
- aws_cdk/aws_stepfunctions_tasks/__init__.py +77615 -22817
- aws_cdk/aws_synthetics/__init__.py +109 -36
- aws_cdk/aws_timestream/__init__.py +41 -0
- aws_cdk/aws_transfer/__init__.py +9 -10
- aws_cdk/aws_wafv2/__init__.py +24 -22
- aws_cdk/aws_wisdom/__init__.py +8 -8
- aws_cdk/aws_workspacesweb/__init__.py +60 -60
- aws_cdk/aws_xray/__init__.py +8 -8
- aws_cdk/cloud_assembly_schema/__init__.py +63 -4
- aws_cdk/cx_api/__init__.py +62 -4
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/METADATA +3 -3
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/RECORD +120 -118
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -326,7 +326,7 @@ configure an MFA token and use it for sign in. It also allows for the users to u
|
|
|
326
326
|
[time-based one time password
|
|
327
327
|
(TOTP)](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html).
|
|
328
328
|
|
|
329
|
-
If you want to enable email-based MFA, set `email`
|
|
329
|
+
If you want to enable email-based MFA, set `email` property to the Amazon SES email-sending configuration and set `featurePlan` to `FeaturePlan.ESSENTIALS` or `FeaturePlan.PLUS`.
|
|
330
330
|
For more information, see [SMS and email message MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-sms-email-message.html).
|
|
331
331
|
|
|
332
332
|
```python
|
|
@@ -348,6 +348,10 @@ Further to this, it can also be configured with the validity of the auto-generat
|
|
|
348
348
|
password is generated by the user pool either when an admin signs up a user or when a password reset is requested.
|
|
349
349
|
The validity of this password dictates how long to give the user to use this password before expiring it.
|
|
350
350
|
|
|
351
|
+
You can also set a policy for password reuse by setting the `passwordHistorySize` property.
|
|
352
|
+
You can prevent a user from resetting their password to a new password that matches their current password or any of up to 23 additional previous passwords, for a maximum total of 24.
|
|
353
|
+
The `passwordHistorySize` property can not be set when `featurePlan` is `FeaturePlan.LITE`.
|
|
354
|
+
|
|
351
355
|
The following code snippet configures these properties -
|
|
352
356
|
|
|
353
357
|
```python
|
|
@@ -847,7 +851,7 @@ configured for a client.
|
|
|
847
851
|
```python
|
|
848
852
|
pool = cognito.UserPool(self, "Pool")
|
|
849
853
|
|
|
850
|
-
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("
|
|
854
|
+
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("favoritePizza", "favoriteBeverage")
|
|
851
855
|
|
|
852
856
|
client_read_attributes = client_write_attributes.with_standard_attributes(email_verified=True).with_custom_attributes("pointsEarned")
|
|
853
857
|
|
|
@@ -977,6 +981,28 @@ Read more about [Using the Amazon Cognito
|
|
|
977
981
|
Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html) and [Using Your Own
|
|
978
982
|
Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
|
|
979
983
|
|
|
984
|
+
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.
|
|
985
|
+
|
|
986
|
+
```python
|
|
987
|
+
pool = cognito.UserPool(self, "Pool")
|
|
988
|
+
|
|
989
|
+
# Use the new managed login page
|
|
990
|
+
pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
|
|
991
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
992
|
+
domain_prefix="blanding-design-ui"
|
|
993
|
+
),
|
|
994
|
+
managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
|
|
995
|
+
)
|
|
996
|
+
|
|
997
|
+
# Use the classic hosted UI
|
|
998
|
+
pool.add_domain("DomainWithClassicHostedUi",
|
|
999
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
1000
|
+
domain_prefix="classic-hosted-ui"
|
|
1001
|
+
),
|
|
1002
|
+
managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
1003
|
+
)
|
|
1004
|
+
```
|
|
1005
|
+
|
|
980
1006
|
The `signInUrl()` methods returns the fully qualified URL to the login page for the user pool. This page comes from the
|
|
981
1007
|
hosted UI configured with Cognito. Learn more at [Hosted UI with the Amazon Cognito
|
|
982
1008
|
Console](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html#cognito-user-pools-create-an-app-integration).
|
|
@@ -3758,9 +3784,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3758
3784
|
) -> None:
|
|
3759
3785
|
'''The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
|
|
3760
3786
|
|
|
3761
|
-
|
|
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 threat protection. This data type is a request parameter of ``API_SetLogDeliveryConfiguration`` and a response parameter of ``API_GetLogDeliveryConfiguration`` .
|
|
3787
|
+
: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
3788
|
: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
3789
|
:param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
|
|
3766
3790
|
: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`` .
|
|
@@ -3812,9 +3836,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3812
3836
|
def cloud_watch_logs_configuration(
|
|
3813
3837
|
self,
|
|
3814
3838
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.CloudWatchLogsConfigurationProperty"]]:
|
|
3815
|
-
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with
|
|
3816
|
-
|
|
3817
|
-
This data type is a request parameter of ``API_SetLogDeliveryConfiguration`` and a response parameter of ``API_GetLogDeliveryConfiguration`` .
|
|
3839
|
+
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3818
3840
|
|
|
3819
3841
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration
|
|
3820
3842
|
'''
|
|
@@ -4266,8 +4288,6 @@ class CfnManagedLoginBranding(
|
|
|
4266
4288
|
) -> None:
|
|
4267
4289
|
'''An image file from a managed login branding style in a user pool.
|
|
4268
4290
|
|
|
4269
|
-
This data type is a request parameter of ``API_CreateManagedLoginBranding`` and ``API_UpdateManagedLoginBranding`` , and a response parameter of ``API_DescribeManagedLoginBranding`` .
|
|
4270
|
-
|
|
4271
4291
|
: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
4292
|
: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
4293
|
:param extension: The file type of the image file.
|
|
@@ -4729,7 +4749,7 @@ class CfnUserPool(
|
|
|
4729
4749
|
:param scope: Scope in which this resource is defined.
|
|
4730
4750
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4731
4751
|
: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.
|
|
4752
|
+
: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.
|
|
4733
4753
|
: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>`_ .
|
|
4734
4754
|
: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
4755
|
: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.
|
|
@@ -4742,7 +4762,7 @@ class CfnUserPool(
|
|
|
4742
4762
|
: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
4763
|
: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
4764
|
: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.
|
|
4745
|
-
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
4765
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
4746
4766
|
: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
4767
|
:param sms_authentication_message: The contents of the SMS authentication message.
|
|
4748
4768
|
: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>`_ .
|
|
@@ -5095,10 +5115,7 @@ class CfnUserPool(
|
|
|
5095
5115
|
def policies(
|
|
5096
5116
|
self,
|
|
5097
5117
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]]:
|
|
5098
|
-
'''A list of user pool policies.
|
|
5099
|
-
|
|
5100
|
-
Contains the policy that sets password-complexity requirements.
|
|
5101
|
-
'''
|
|
5118
|
+
'''A list of user pool policies.'''
|
|
5102
5119
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]], jsii.get(self, "policies"))
|
|
5103
5120
|
|
|
5104
5121
|
@policies.setter
|
|
@@ -5411,11 +5428,9 @@ class CfnUserPool(
|
|
|
5411
5428
|
|
|
5412
5429
|
Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
5413
5430
|
|
|
5414
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
5415
|
-
|
|
5416
5431
|
: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.
|
|
5417
5432
|
: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>`_ .
|
|
5418
|
-
:param unused_account_validity_days: This parameter is no longer in use.
|
|
5433
|
+
: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.
|
|
5419
5434
|
|
|
5420
5435
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
|
|
5421
5436
|
:exampleMetadata: fixture=_generated
|
|
@@ -5481,8 +5496,6 @@ class CfnUserPool(
|
|
|
5481
5496
|
def unused_account_validity_days(self) -> typing.Optional[jsii.Number]:
|
|
5482
5497
|
'''This parameter is no longer in use.
|
|
5483
5498
|
|
|
5484
|
-
Configure the duration of temporary passwords with the ``TemporaryPasswordValidityDays`` parameter of ``API_PasswordPolicyType`` . For older user pools that have a ``UnusedAccountValidityDays`` configuration, that value is effective until you set a value for ``TemporaryPasswordValidityDays`` .
|
|
5485
|
-
|
|
5486
5499
|
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.
|
|
5487
5500
|
|
|
5488
5501
|
The default value for this parameter is 7.
|
|
@@ -5727,15 +5740,6 @@ class CfnUserPool(
|
|
|
5727
5740
|
) -> None:
|
|
5728
5741
|
'''The device-remembering configuration for a user pool.
|
|
5729
5742
|
|
|
5730
|
-
A ``API_DescribeUserPool`` 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 ``API_ConfirmDevice`` API request. Additionally. when the property ``DeviceOnlyRememberedOnUserPrompt`` is ``true`` , you must follow ``ConfirmDevice`` with an ``API_UpdateDeviceStatus`` API request that sets the user's device to ``remembered`` or ``not_remembered`` .
|
|
5731
|
-
|
|
5732
|
-
To sign in with a remembered device, include ``DEVICE_KEY`` in the authentication parameters in your user's ``API_InitiateAuth`` request. If your app doesn't include a ``DEVICE_KEY`` parameter, the ``API_InitiateAuth`` 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.
|
|
5733
|
-
.. epigraph::
|
|
5734
|
-
|
|
5735
|
-
When you provide a value for any property of ``DeviceConfiguration`` , you activate the device remembering for the user pool.
|
|
5736
|
-
|
|
5737
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
5738
|
-
|
|
5739
5743
|
: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.
|
|
5740
5744
|
: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.
|
|
5741
5745
|
|
|
@@ -6095,8 +6099,6 @@ class CfnUserPool(
|
|
|
6095
6099
|
|
|
6096
6100
|
Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
|
|
6097
6101
|
|
|
6098
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6099
|
-
|
|
6100
6102
|
: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>`_ .
|
|
6101
6103
|
: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.
|
|
6102
6104
|
: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.
|
|
@@ -6358,8 +6360,6 @@ class CfnUserPool(
|
|
|
6358
6360
|
) -> None:
|
|
6359
6361
|
'''The minimum and maximum values of an attribute that is of the number type, for example ``custom:age`` .
|
|
6360
6362
|
|
|
6361
|
-
This data type is part of ``API_SchemaAttributeType`` . It defines the length constraints on number-type attributes that you configure in ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and displays the length constraints of all number-type attributes in the response to ``API_DescribeUserPool``
|
|
6362
|
-
|
|
6363
6363
|
: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.
|
|
6364
6364
|
:param min_value: The minimum value of an attribute that is of the number data type.
|
|
6365
6365
|
|
|
@@ -6445,10 +6445,8 @@ class CfnUserPool(
|
|
|
6445
6445
|
) -> None:
|
|
6446
6446
|
'''The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
6447
6447
|
|
|
6448
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6449
|
-
|
|
6450
6448
|
:param minimum_length: The minimum length of the password in the policy that you have set. This value can't be less than 6.
|
|
6451
|
-
: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`` .
|
|
6449
|
+
: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`` .
|
|
6452
6450
|
:param require_lowercase: The requirement in a password policy that users must include at least one lowercase letter in their password.
|
|
6453
6451
|
:param require_numbers: The requirement in a password policy that users must include at least one number in their password.
|
|
6454
6452
|
:param require_symbols: The requirement in a password policy that users must include at least one symbol in their password.
|
|
@@ -6516,8 +6514,6 @@ class CfnUserPool(
|
|
|
6516
6514
|
|
|
6517
6515
|
Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` .
|
|
6518
6516
|
|
|
6519
|
-
Password history isn't enforced and isn't displayed in ``API_DescribeUserPool`` 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.
|
|
6520
|
-
|
|
6521
6517
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-passwordhistorysize
|
|
6522
6518
|
'''
|
|
6523
6519
|
result = self._values.get("password_history_size")
|
|
@@ -6607,12 +6603,12 @@ class CfnUserPool(
|
|
|
6607
6603
|
password_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.PasswordPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6608
6604
|
sign_in_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.SignInPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6609
6605
|
) -> None:
|
|
6610
|
-
'''A list of user pool policies.
|
|
6606
|
+
'''A list of user pool policies.
|
|
6611
6607
|
|
|
6612
|
-
|
|
6608
|
+
Contains the policy that sets password-complexity requirements.
|
|
6613
6609
|
|
|
6614
6610
|
:param password_policy: The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
6615
|
-
: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.
|
|
6611
|
+
: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.
|
|
6616
6612
|
|
|
6617
6613
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html
|
|
6618
6614
|
:exampleMetadata: fixture=_generated
|
|
@@ -6667,8 +6663,6 @@ class CfnUserPool(
|
|
|
6667
6663
|
|
|
6668
6664
|
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.
|
|
6669
6665
|
|
|
6670
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6671
|
-
|
|
6672
6666
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-signinpolicy
|
|
6673
6667
|
'''
|
|
6674
6668
|
result = self._values.get("sign_in_policy")
|
|
@@ -6699,8 +6693,6 @@ class CfnUserPool(
|
|
|
6699
6693
|
) -> None:
|
|
6700
6694
|
'''The properties of a pre token generation Lambda trigger.
|
|
6701
6695
|
|
|
6702
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6703
|
-
|
|
6704
6696
|
: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`` .
|
|
6705
6697
|
: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.
|
|
6706
6698
|
|
|
@@ -6779,8 +6771,6 @@ class CfnUserPool(
|
|
|
6779
6771
|
|
|
6780
6772
|
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.
|
|
6781
6773
|
|
|
6782
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6783
|
-
|
|
6784
6774
|
:param name: The recovery method that this object sets a recovery option for.
|
|
6785
6775
|
:param priority: Your priority preference for using the specified attribute in account recovery. The highest priority is ``1`` .
|
|
6786
6776
|
|
|
@@ -6870,8 +6860,6 @@ class CfnUserPool(
|
|
|
6870
6860
|
|
|
6871
6861
|
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.
|
|
6872
6862
|
|
|
6873
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
6874
|
-
|
|
6875
6863
|
: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"`` .
|
|
6876
6864
|
: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.
|
|
6877
6865
|
: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>`_ .
|
|
@@ -7041,8 +7029,6 @@ class CfnUserPool(
|
|
|
7041
7029
|
|
|
7042
7030
|
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.
|
|
7043
7031
|
|
|
7044
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
7045
|
-
|
|
7046
7032
|
: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`` ,
|
|
7047
7033
|
|
|
7048
7034
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-signinpolicy.html
|
|
@@ -7112,8 +7098,6 @@ class CfnUserPool(
|
|
|
7112
7098
|
|
|
7113
7099
|
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 .
|
|
7114
7100
|
|
|
7115
|
-
This data type is a request parameter of ``API_CreateUserPool`` , ``API_UpdateUserPool`` , and ``API_SetUserPoolMfaConfig`` , and a response parameter of ``API_CreateUserPool`` , ``API_UpdateUserPool`` , and ``API_GetUserPoolMfaConfig`` .
|
|
7116
|
-
|
|
7117
7101
|
: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>`_ .
|
|
7118
7102
|
: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>`_ .
|
|
7119
7103
|
: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>`_ .
|
|
@@ -7208,8 +7192,6 @@ class CfnUserPool(
|
|
|
7208
7192
|
) -> None:
|
|
7209
7193
|
'''The minimum and maximum length values of an attribute that is of the string type, for example ``custom:department`` .
|
|
7210
7194
|
|
|
7211
|
-
This data type is part of ``API_SchemaAttributeType`` . It defines the length constraints on string-type attributes that you configure in ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and displays the length constraints of all string-type attributes in the response to ``API_DescribeUserPool``
|
|
7212
|
-
|
|
7213
7195
|
: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.
|
|
7214
7196
|
:param min_length: The minimum length of a string attribute value.
|
|
7215
7197
|
|
|
@@ -7287,7 +7269,7 @@ class CfnUserPool(
|
|
|
7287
7269
|
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
|
|
7288
7270
|
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>`_ .
|
|
7289
7271
|
|
|
7290
|
-
: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.
|
|
7272
|
+
: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.
|
|
7291
7273
|
|
|
7292
7274
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html
|
|
7293
7275
|
:exampleMetadata: fixture=_generated
|
|
@@ -7317,8 +7299,6 @@ class CfnUserPool(
|
|
|
7317
7299
|
|
|
7318
7300
|
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.
|
|
7319
7301
|
|
|
7320
|
-
You can verify an updated email address or phone number with a ``API_VerifyUserAttribute`` API request. You can also call the ``API_AdminUpdateUserAttributes`` API and set ``email_verified`` or ``phone_number_verified`` to true.
|
|
7321
|
-
|
|
7322
7302
|
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.
|
|
7323
7303
|
|
|
7324
7304
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html#cfn-cognito-userpool-userattributeupdatesettings-attributesrequireverificationbeforeupdate
|
|
@@ -7353,14 +7333,12 @@ class CfnUserPool(
|
|
|
7353
7333
|
advanced_security_additional_flows: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.AdvancedSecurityAdditionalFlowsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7354
7334
|
advanced_security_mode: typing.Optional[builtins.str] = None,
|
|
7355
7335
|
) -> None:
|
|
7356
|
-
'''
|
|
7336
|
+
'''User pool add-ons.
|
|
7357
7337
|
|
|
7358
|
-
To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to
|
|
7338
|
+
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`` .
|
|
7359
7339
|
|
|
7360
7340
|
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>`_ .
|
|
7361
7341
|
|
|
7362
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
7363
|
-
|
|
7364
7342
|
:param advanced_security_additional_flows: Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
|
|
7365
7343
|
: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.
|
|
7366
7344
|
|
|
@@ -7436,8 +7414,6 @@ class CfnUserPool(
|
|
|
7436
7414
|
|
|
7437
7415
|
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.
|
|
7438
7416
|
|
|
7439
|
-
This configuration is immutable after you set it. For more information, see ``API_UsernameConfigurationType`` .
|
|
7440
|
-
|
|
7441
7417
|
: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.
|
|
7442
7418
|
|
|
7443
7419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html
|
|
@@ -7514,8 +7490,6 @@ class CfnUserPool(
|
|
|
7514
7490
|
) -> None:
|
|
7515
7491
|
'''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
|
|
7516
7492
|
|
|
7517
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
7518
|
-
|
|
7519
7493
|
: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 ``{####}`` .
|
|
7520
7494
|
: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.
|
|
7521
7495
|
: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.
|
|
@@ -7758,17 +7732,17 @@ class CfnUserPoolClient(
|
|
|
7758
7732
|
:param client_name: A friendly name for the app client that you want to create.
|
|
7759
7733
|
: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.
|
|
7760
7734
|
: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.
|
|
7761
|
-
:param enable_token_revocation: Activates or deactivates
|
|
7735
|
+
: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.
|
|
7762
7736
|
: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`` .
|
|
7763
7737
|
: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>`_ .
|
|
7764
7738
|
: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.
|
|
7765
7739
|
: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>`_ .
|
|
7766
7740
|
: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.
|
|
7767
|
-
: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.
|
|
7741
|
+
: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.
|
|
7768
7742
|
: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.
|
|
7769
7743
|
: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>`_ .
|
|
7770
7744
|
: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.
|
|
7771
|
-
: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.
|
|
7745
|
+
: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>`_ .
|
|
7772
7746
|
'''
|
|
7773
7747
|
if __debug__:
|
|
7774
7748
|
type_hints = typing.get_type_hints(_typecheckingstub__87712ca9ae8faf9f73a6c5d11987fcf280543ea093bcc4253c800c0151725828)
|
|
@@ -8030,7 +8004,7 @@ class CfnUserPoolClient(
|
|
|
8030
8004
|
def enable_token_revocation(
|
|
8031
8005
|
self,
|
|
8032
8006
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
8033
|
-
'''Activates or deactivates
|
|
8007
|
+
'''Activates or deactivates token revocation.'''
|
|
8034
8008
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enableTokenRevocation"))
|
|
8035
8009
|
|
|
8036
8010
|
@enable_token_revocation.setter
|
|
@@ -8227,8 +8201,6 @@ class CfnUserPoolClient(
|
|
|
8227
8201
|
|
|
8228
8202
|
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>`_ .
|
|
8229
8203
|
|
|
8230
|
-
This data type is a request parameter of ``API_CreateUserPoolClient`` and ``API_UpdateUserPoolClient`` , and a response parameter of ``API_DescribeUserPoolClient`` .
|
|
8231
|
-
|
|
8232
8204
|
: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
|
|
8233
8205
|
:param application_id: Your Amazon Pinpoint project ID.
|
|
8234
8206
|
: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.
|
|
@@ -8497,17 +8469,17 @@ class CfnUserPoolClientProps:
|
|
|
8497
8469
|
:param client_name: A friendly name for the app client that you want to create.
|
|
8498
8470
|
: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.
|
|
8499
8471
|
: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.
|
|
8500
|
-
:param enable_token_revocation: Activates or deactivates
|
|
8472
|
+
: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.
|
|
8501
8473
|
: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`` .
|
|
8502
8474
|
: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>`_ .
|
|
8503
8475
|
: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.
|
|
8504
8476
|
: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>`_ .
|
|
8505
8477
|
: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.
|
|
8506
|
-
: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.
|
|
8478
|
+
: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.
|
|
8507
8479
|
: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.
|
|
8508
8480
|
: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>`_ .
|
|
8509
8481
|
: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.
|
|
8510
|
-
: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.
|
|
8482
|
+
: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>`_ .
|
|
8511
8483
|
|
|
8512
8484
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html
|
|
8513
8485
|
:exampleMetadata: fixture=_generated
|
|
@@ -8784,9 +8756,7 @@ class CfnUserPoolClientProps:
|
|
|
8784
8756
|
def enable_token_revocation(
|
|
8785
8757
|
self,
|
|
8786
8758
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
8787
|
-
'''Activates or deactivates
|
|
8788
|
-
|
|
8789
|
-
Revoke tokens with ``API_RevokeToken`` .
|
|
8759
|
+
'''Activates or deactivates token revocation.
|
|
8790
8760
|
|
|
8791
8761
|
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
8792
8762
|
|
|
@@ -8887,11 +8857,9 @@ class CfnUserPoolClientProps:
|
|
|
8887
8857
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8888
8858
|
'''The list of user attributes that you want your app client to have read access to.
|
|
8889
8859
|
|
|
8890
|
-
After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list.
|
|
8891
|
-
|
|
8892
|
-
An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a ``API_GetUser`` API request to retrieve and display your user's profile data.
|
|
8860
|
+
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.
|
|
8893
8861
|
|
|
8894
|
-
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
|
|
8862
|
+
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.
|
|
8895
8863
|
|
|
8896
8864
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes
|
|
8897
8865
|
'''
|
|
@@ -8951,8 +8919,6 @@ class CfnUserPoolClientProps:
|
|
|
8951
8919
|
|
|
8952
8920
|
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.
|
|
8953
8921
|
|
|
8954
|
-
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 ``API_UpdateUserAttributes`` API request and sets ``family_name`` to the new value.
|
|
8955
|
-
|
|
8956
8922
|
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.
|
|
8957
8923
|
|
|
8958
8924
|
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>`_ .
|
|
@@ -9019,7 +8985,7 @@ class CfnUserPoolDomain(
|
|
|
9019
8985
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
9020
8986
|
: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`` .
|
|
9021
8987
|
:param user_pool_id: The ID of the user pool that is associated with the domain you're updating.
|
|
9022
|
-
:param custom_domain_config: The configuration for a custom domain that hosts
|
|
8988
|
+
: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.
|
|
9023
8989
|
: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>`_ .
|
|
9024
8990
|
'''
|
|
9025
8991
|
if __debug__:
|
|
@@ -9119,7 +9085,7 @@ class CfnUserPoolDomain(
|
|
|
9119
9085
|
def custom_domain_config(
|
|
9120
9086
|
self,
|
|
9121
9087
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolDomain.CustomDomainConfigTypeProperty"]]:
|
|
9122
|
-
'''The configuration for a custom domain that hosts
|
|
9088
|
+
'''The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.'''
|
|
9123
9089
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolDomain.CustomDomainConfigTypeProperty"]], jsii.get(self, "customDomainConfig"))
|
|
9124
9090
|
|
|
9125
9091
|
@custom_domain_config.setter
|
|
@@ -9158,8 +9124,6 @@ class CfnUserPoolDomain(
|
|
|
9158
9124
|
) -> None:
|
|
9159
9125
|
'''The configuration for a hosted UI custom domain.
|
|
9160
9126
|
|
|
9161
|
-
This data type is a request parameter of ``API_CreateUserPoolDomain`` and ``API_UpdateUserPoolDomain`` .
|
|
9162
|
-
|
|
9163
9127
|
: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.
|
|
9164
9128
|
|
|
9165
9129
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html
|
|
@@ -9228,7 +9192,7 @@ class CfnUserPoolDomainProps:
|
|
|
9228
9192
|
|
|
9229
9193
|
: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`` .
|
|
9230
9194
|
:param user_pool_id: The ID of the user pool that is associated with the domain you're updating.
|
|
9231
|
-
:param custom_domain_config: The configuration for a custom domain that hosts
|
|
9195
|
+
: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.
|
|
9232
9196
|
: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>`_ .
|
|
9233
9197
|
|
|
9234
9198
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html
|
|
@@ -9292,14 +9256,12 @@ class CfnUserPoolDomainProps:
|
|
|
9292
9256
|
def custom_domain_config(
|
|
9293
9257
|
self,
|
|
9294
9258
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolDomain.CustomDomainConfigTypeProperty]]:
|
|
9295
|
-
'''The configuration for a custom domain that hosts
|
|
9259
|
+
'''The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
|
|
9296
9260
|
|
|
9297
|
-
|
|
9261
|
+
Use this object to specify an SSL certificate that is managed by ACM.
|
|
9298
9262
|
|
|
9299
9263
|
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.
|
|
9300
9264
|
|
|
9301
|
-
Update the RP ID in a ``API_SetUserPoolMfaConfig`` request.
|
|
9302
|
-
|
|
9303
9265
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig
|
|
9304
9266
|
'''
|
|
9305
9267
|
result = self._values.get("custom_domain_config")
|
|
@@ -9338,8 +9300,6 @@ class CfnUserPoolGroup(
|
|
|
9338
9300
|
|
|
9339
9301
|
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.
|
|
9340
9302
|
|
|
9341
|
-
This data type is a response parameter of ``API_AdminListGroupsForUser`` , ``API_CreateGroup`` , ``API_GetGroup`` , ``API_ListGroups`` , and ``API_UpdateGroup`` .
|
|
9342
|
-
|
|
9343
9303
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html
|
|
9344
9304
|
:cloudformationResource: AWS::Cognito::UserPoolGroup
|
|
9345
9305
|
:exampleMetadata: fixture=_generated
|
|
@@ -10077,7 +10037,7 @@ class CfnUserPoolProps:
|
|
|
10077
10037
|
'''Properties for defining a ``CfnUserPool``.
|
|
10078
10038
|
|
|
10079
10039
|
: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.
|
|
10080
|
-
: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.
|
|
10040
|
+
: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.
|
|
10081
10041
|
: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>`_ .
|
|
10082
10042
|
: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>`_ .
|
|
10083
10043
|
: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.
|
|
@@ -10090,7 +10050,7 @@ class CfnUserPoolProps:
|
|
|
10090
10050
|
: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``
|
|
10091
10051
|
: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.
|
|
10092
10052
|
: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.
|
|
10093
|
-
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
10053
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
10094
10054
|
: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>`_ .
|
|
10095
10055
|
:param sms_authentication_message: The contents of the SMS authentication message.
|
|
10096
10056
|
: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>`_ .
|
|
@@ -10354,8 +10314,6 @@ class CfnUserPoolProps:
|
|
|
10354
10314
|
|
|
10355
10315
|
Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
10356
10316
|
|
|
10357
|
-
This data type is a request and response parameter of ``API_CreateUserPool`` and ``API_UpdateUserPool`` , and a response parameter of ``API_DescribeUserPool`` .
|
|
10358
|
-
|
|
10359
10317
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
|
|
10360
10318
|
'''
|
|
10361
10319
|
result = self._values.get("admin_create_user_config")
|
|
@@ -10511,9 +10469,9 @@ class CfnUserPoolProps:
|
|
|
10511
10469
|
def policies(
|
|
10512
10470
|
self,
|
|
10513
10471
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.PoliciesProperty]]:
|
|
10514
|
-
'''A list of user pool policies.
|
|
10472
|
+
'''A list of user pool policies.
|
|
10515
10473
|
|
|
10516
|
-
|
|
10474
|
+
Contains the policy that sets password-complexity requirements.
|
|
10517
10475
|
|
|
10518
10476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
|
|
10519
10477
|
'''
|
|
@@ -10874,8 +10832,6 @@ class CfnUserPoolResourceServer(
|
|
|
10874
10832
|
|
|
10875
10833
|
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>`_ .
|
|
10876
10834
|
|
|
10877
|
-
This data type is a request parameter of ``API_CreateResourceServer`` and a response parameter of ``API_DescribeResourceServer`` .
|
|
10878
|
-
|
|
10879
10835
|
:param scope_description: A friendly description of a custom scope.
|
|
10880
10836
|
: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`` .
|
|
10881
10837
|
|
|
@@ -11305,9 +11261,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11305
11261
|
) -> None:
|
|
11306
11262
|
'''The automated response to a risk level for adaptive authentication in full-function, or ``ENFORCED`` , mode.
|
|
11307
11263
|
|
|
11308
|
-
You can assign an action to each risk level that
|
|
11309
|
-
|
|
11310
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11264
|
+
You can assign an action to each risk level that advanced security features evaluates.
|
|
11311
11265
|
|
|
11312
11266
|
: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.
|
|
11313
11267
|
: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.
|
|
@@ -11390,9 +11344,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11390
11344
|
low_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11391
11345
|
medium_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11392
11346
|
) -> None:
|
|
11393
|
-
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with
|
|
11394
|
-
|
|
11395
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11347
|
+
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
11396
11348
|
|
|
11397
11349
|
:param high_action: The action that you assign to a high-risk assessment by threat protection.
|
|
11398
11350
|
:param low_action: The action that you assign to a low-risk assessment by threat protection.
|
|
@@ -11494,9 +11446,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11494
11446
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
11495
11447
|
notify_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11496
11448
|
) -> None:
|
|
11497
|
-
'''The settings for automated responses and notification templates for adaptive authentication with
|
|
11498
|
-
|
|
11499
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11449
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
11500
11450
|
|
|
11501
11451
|
:param actions: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection.
|
|
11502
11452
|
: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.
|
|
@@ -11610,9 +11560,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11610
11560
|
)
|
|
11611
11561
|
class CompromisedCredentialsActionsTypeProperty:
|
|
11612
11562
|
def __init__(self, *, event_action: builtins.str) -> None:
|
|
11613
|
-
'''Settings for user pool actions when Amazon Cognito detects compromised credentials with
|
|
11614
|
-
|
|
11615
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11563
|
+
'''Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ``ENFORCED`` mode.
|
|
11616
11564
|
|
|
11617
11565
|
:param event_action: The action that Amazon Cognito takes when it detects compromised credentials.
|
|
11618
11566
|
|
|
@@ -11669,9 +11617,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11669
11617
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
11670
11618
|
event_filter: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
11671
11619
|
) -> None:
|
|
11672
|
-
'''Settings for compromised-credentials actions and authentication-event sources with
|
|
11673
|
-
|
|
11674
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11620
|
+
'''Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function ``ENFORCED`` mode.
|
|
11675
11621
|
|
|
11676
11622
|
:param actions: Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
|
|
11677
11623
|
:param event_filter: Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.
|
|
@@ -11761,9 +11707,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11761
11707
|
no_action_email: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11762
11708
|
reply_to: typing.Optional[builtins.str] = None,
|
|
11763
11709
|
) -> None:
|
|
11764
|
-
'''The configuration for Amazon SES email messages that
|
|
11765
|
-
|
|
11766
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11710
|
+
'''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.
|
|
11767
11711
|
|
|
11768
11712
|
: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.
|
|
11769
11713
|
:param block_email: The template for the email message that your user pool sends when a detected risk event is blocked.
|
|
@@ -11925,9 +11869,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11925
11869
|
html_body: typing.Optional[builtins.str] = None,
|
|
11926
11870
|
text_body: typing.Optional[builtins.str] = None,
|
|
11927
11871
|
) -> None:
|
|
11928
|
-
'''The template for email messages that
|
|
11929
|
-
|
|
11930
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
11872
|
+
'''The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
|
|
11931
11873
|
|
|
11932
11874
|
:param subject: The subject of the threat protection email notification.
|
|
11933
11875
|
: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.
|
|
@@ -12023,8 +11965,6 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
12023
11965
|
) -> None:
|
|
12024
11966
|
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
12025
11967
|
|
|
12026
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
12027
|
-
|
|
12028
11968
|
: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.
|
|
12029
11969
|
: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.
|
|
12030
11970
|
|
|
@@ -12282,8 +12222,6 @@ class CfnUserPoolUICustomizationAttachment(
|
|
|
12282
12222
|
):
|
|
12283
12223
|
'''A container for the UI customization information for the hosted UI in a user pool.
|
|
12284
12224
|
|
|
12285
|
-
This data type is a response parameter of ``API_DescribeUserPoolClient`` .
|
|
12286
|
-
|
|
12287
12225
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html
|
|
12288
12226
|
:cloudformationResource: AWS::Cognito::UserPoolUICustomizationAttachment
|
|
12289
12227
|
:exampleMetadata: fixture=_generated
|
|
@@ -12543,7 +12481,7 @@ class CfnUserPoolUser(
|
|
|
12543
12481
|
id: builtins.str,
|
|
12544
12482
|
*,
|
|
12545
12483
|
user_pool_id: builtins.str,
|
|
12546
|
-
client_metadata: typing.Optional[typing.Union[
|
|
12484
|
+
client_metadata: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
12547
12485
|
desired_delivery_mediums: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
12548
12486
|
force_alias_creation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
12549
12487
|
message_action: typing.Optional[builtins.str] = None,
|
|
@@ -12559,7 +12497,7 @@ class CfnUserPoolUser(
|
|
|
12559
12497
|
: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.
|
|
12560
12498
|
: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`` .
|
|
12561
12499
|
: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.
|
|
12562
|
-
: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 ``AdminCreateUser``
|
|
12500
|
+
: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.
|
|
12563
12501
|
: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>`_ .
|
|
12564
12502
|
: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>`_ .
|
|
12565
12503
|
'''
|
|
@@ -12632,14 +12570,14 @@ class CfnUserPoolUser(
|
|
|
12632
12570
|
@jsii.member(jsii_name="clientMetadata")
|
|
12633
12571
|
def client_metadata(
|
|
12634
12572
|
self,
|
|
12635
|
-
) -> typing.Optional[typing.Union[
|
|
12573
|
+
) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
|
|
12636
12574
|
'''A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.'''
|
|
12637
|
-
return typing.cast(typing.Optional[typing.Union[
|
|
12575
|
+
return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], jsii.get(self, "clientMetadata"))
|
|
12638
12576
|
|
|
12639
12577
|
@client_metadata.setter
|
|
12640
12578
|
def client_metadata(
|
|
12641
12579
|
self,
|
|
12642
|
-
value: typing.Optional[typing.Union[
|
|
12580
|
+
value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
|
|
12643
12581
|
) -> None:
|
|
12644
12582
|
if __debug__:
|
|
12645
12583
|
type_hints = typing.get_type_hints(_typecheckingstub__674b44537db9d65119536a886fe3b7990cd0df2f1aa1c3c2880711f8b302ae40)
|
|
@@ -12756,8 +12694,6 @@ class CfnUserPoolUser(
|
|
|
12756
12694
|
) -> None:
|
|
12757
12695
|
'''The name and value of a user attribute.
|
|
12758
12696
|
|
|
12759
|
-
This data type is a request parameter of ``API_AdminUpdateUserAttributes`` and ``API_UpdateUserAttributes`` .
|
|
12760
|
-
|
|
12761
12697
|
:param name: The name of the attribute.
|
|
12762
12698
|
:param value: The value of the attribute.
|
|
12763
12699
|
|
|
@@ -12834,7 +12770,7 @@ class CfnUserPoolUserProps:
|
|
|
12834
12770
|
self,
|
|
12835
12771
|
*,
|
|
12836
12772
|
user_pool_id: builtins.str,
|
|
12837
|
-
client_metadata: typing.Optional[typing.Union[
|
|
12773
|
+
client_metadata: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
12838
12774
|
desired_delivery_mediums: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
12839
12775
|
force_alias_creation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
12840
12776
|
message_action: typing.Optional[builtins.str] = None,
|
|
@@ -12849,7 +12785,7 @@ class CfnUserPoolUserProps:
|
|
|
12849
12785
|
: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.
|
|
12850
12786
|
: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`` .
|
|
12851
12787
|
: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.
|
|
12852
|
-
: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 ``AdminCreateUser``
|
|
12788
|
+
: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.
|
|
12853
12789
|
: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>`_ .
|
|
12854
12790
|
: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>`_ .
|
|
12855
12791
|
|
|
@@ -12924,7 +12860,7 @@ class CfnUserPoolUserProps:
|
|
|
12924
12860
|
@builtins.property
|
|
12925
12861
|
def client_metadata(
|
|
12926
12862
|
self,
|
|
12927
|
-
) -> typing.Optional[typing.Union[
|
|
12863
|
+
) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
|
|
12928
12864
|
'''A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
|
|
12929
12865
|
|
|
12930
12866
|
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ``ClientMetadata`` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the ``clientMetadata`` value to enhance your workflow for your specific needs.
|
|
@@ -12941,7 +12877,7 @@ class CfnUserPoolUserProps:
|
|
|
12941
12877
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata
|
|
12942
12878
|
'''
|
|
12943
12879
|
result = self._values.get("client_metadata")
|
|
12944
|
-
return typing.cast(typing.Optional[typing.Union[
|
|
12880
|
+
return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], result)
|
|
12945
12881
|
|
|
12946
12882
|
@builtins.property
|
|
12947
12883
|
def desired_delivery_mediums(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
@@ -12996,12 +12932,10 @@ class CfnUserPoolUserProps:
|
|
|
12996
12932
|
|
|
12997
12933
|
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`` .
|
|
12998
12934
|
|
|
12999
|
-
In your ``AdminCreateUser``
|
|
13000
|
-
|
|
13001
|
-
- **email** - The email address where you want the user to receive their confirmation code and username. You must provide a value for the ``email`` when you want to set ``email_verified`` to ``true`` , or if you set ``EMAIL`` in the ``DesiredDeliveryMediums`` parameter.
|
|
13002
|
-
- **phone_number** - The phone number where you want the user to receive their confirmation code and username. You must provide a value for the ``email`` when you want to set ``phone_number`` to ``true`` , or if you set ``SMS`` in the ``DesiredDeliveryMediums`` parameter.
|
|
12935
|
+
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`` .
|
|
13003
12936
|
|
|
13004
|
-
|
|
12937
|
+
- *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.
|
|
12938
|
+
- *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.
|
|
13005
12939
|
|
|
13006
12940
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes
|
|
13007
12941
|
'''
|
|
@@ -13290,7 +13224,7 @@ class ClientAttributes(
|
|
|
13290
13224
|
|
|
13291
13225
|
pool = cognito.UserPool(self, "Pool")
|
|
13292
13226
|
|
|
13293
|
-
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("
|
|
13227
|
+
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("favoritePizza", "favoriteBeverage")
|
|
13294
13228
|
|
|
13295
13229
|
client_read_attributes = client_write_attributes.with_standard_attributes(email_verified=True).with_custom_attributes("pointsEarned")
|
|
13296
13230
|
|
|
@@ -13364,7 +13298,7 @@ class ClientAttributes(
|
|
|
13364
13298
|
:param nickname: The user's nickname or casual name. Default: false
|
|
13365
13299
|
:param phone_number: The user's telephone number. Default: false
|
|
13366
13300
|
:param phone_number_verified: Whether the phone number has been verified. Default: false
|
|
13367
|
-
:param preferred_username: The user's
|
|
13301
|
+
:param preferred_username: The user's preferred username, different from the immutable user name. Default: false
|
|
13368
13302
|
:param profile_page: The URL to the user's profile page. Default: false
|
|
13369
13303
|
:param profile_picture: The URL to the user's profile picture. Default: false
|
|
13370
13304
|
:param timezone: The user's time zone. Default: false
|
|
@@ -13998,12 +13932,14 @@ class IUserPool(_IResource_c80c4260, typing_extensions.Protocol):
|
|
|
13998
13932
|
*,
|
|
13999
13933
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14000
13934
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
13935
|
+
managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
|
|
14001
13936
|
) -> "UserPoolDomain":
|
|
14002
13937
|
'''Associate a domain to this user pool.
|
|
14003
13938
|
|
|
14004
13939
|
:param id: -
|
|
14005
13940
|
: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.
|
|
14006
13941
|
: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.
|
|
13942
|
+
: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
|
|
14007
13943
|
|
|
14008
13944
|
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
|
|
14009
13945
|
'''
|
|
@@ -14185,12 +14121,14 @@ class _IUserPoolProxy(
|
|
|
14185
14121
|
*,
|
|
14186
14122
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14187
14123
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14124
|
+
managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
|
|
14188
14125
|
) -> "UserPoolDomain":
|
|
14189
14126
|
'''Associate a domain to this user pool.
|
|
14190
14127
|
|
|
14191
14128
|
:param id: -
|
|
14192
14129
|
: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.
|
|
14193
14130
|
: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.
|
|
14131
|
+
: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
|
|
14194
14132
|
|
|
14195
14133
|
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
|
|
14196
14134
|
'''
|
|
@@ -14198,7 +14136,9 @@ class _IUserPoolProxy(
|
|
|
14198
14136
|
type_hints = typing.get_type_hints(_typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e7b1a458)
|
|
14199
14137
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
14200
14138
|
options = UserPoolDomainOptions(
|
|
14201
|
-
cognito_domain=cognito_domain,
|
|
14139
|
+
cognito_domain=cognito_domain,
|
|
14140
|
+
custom_domain=custom_domain,
|
|
14141
|
+
managed_login_version=managed_login_version,
|
|
14202
14142
|
)
|
|
14203
14143
|
|
|
14204
14144
|
return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
|
|
@@ -14589,6 +14529,39 @@ class LambdaVersion(enum.Enum):
|
|
|
14589
14529
|
'''
|
|
14590
14530
|
|
|
14591
14531
|
|
|
14532
|
+
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.ManagedLoginVersion")
|
|
14533
|
+
class ManagedLoginVersion(enum.Enum):
|
|
14534
|
+
'''The branding version of managed login for the domain.
|
|
14535
|
+
|
|
14536
|
+
:exampleMetadata: infused
|
|
14537
|
+
|
|
14538
|
+
Example::
|
|
14539
|
+
|
|
14540
|
+
pool = cognito.UserPool(self, "Pool")
|
|
14541
|
+
|
|
14542
|
+
# Use the new managed login page
|
|
14543
|
+
pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
|
|
14544
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
14545
|
+
domain_prefix="blanding-design-ui"
|
|
14546
|
+
),
|
|
14547
|
+
managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
|
|
14548
|
+
)
|
|
14549
|
+
|
|
14550
|
+
# Use the classic hosted UI
|
|
14551
|
+
pool.add_domain("DomainWithClassicHostedUi",
|
|
14552
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
14553
|
+
domain_prefix="classic-hosted-ui"
|
|
14554
|
+
),
|
|
14555
|
+
managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
14556
|
+
)
|
|
14557
|
+
'''
|
|
14558
|
+
|
|
14559
|
+
CLASSIC_HOSTED_UI = "CLASSIC_HOSTED_UI"
|
|
14560
|
+
'''The classic hosted UI.'''
|
|
14561
|
+
NEWER_MANAGED_LOGIN = "NEWER_MANAGED_LOGIN"
|
|
14562
|
+
'''The newer managed login with the branding designer.'''
|
|
14563
|
+
|
|
14564
|
+
|
|
14592
14565
|
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.Mfa")
|
|
14593
14566
|
class Mfa(enum.Enum):
|
|
14594
14567
|
'''The different ways in which a user pool's MFA enforcement can be configured.
|
|
@@ -15414,6 +15387,7 @@ class OidcEndpoints:
|
|
|
15414
15387
|
jsii_struct_bases=[],
|
|
15415
15388
|
name_mapping={
|
|
15416
15389
|
"min_length": "minLength",
|
|
15390
|
+
"password_history_size": "passwordHistorySize",
|
|
15417
15391
|
"require_digits": "requireDigits",
|
|
15418
15392
|
"require_lowercase": "requireLowercase",
|
|
15419
15393
|
"require_symbols": "requireSymbols",
|
|
@@ -15426,6 +15400,7 @@ class PasswordPolicy:
|
|
|
15426
15400
|
self,
|
|
15427
15401
|
*,
|
|
15428
15402
|
min_length: typing.Optional[jsii.Number] = None,
|
|
15403
|
+
password_history_size: typing.Optional[jsii.Number] = None,
|
|
15429
15404
|
require_digits: typing.Optional[builtins.bool] = None,
|
|
15430
15405
|
require_lowercase: typing.Optional[builtins.bool] = None,
|
|
15431
15406
|
require_symbols: typing.Optional[builtins.bool] = None,
|
|
@@ -15435,6 +15410,7 @@ class PasswordPolicy:
|
|
|
15435
15410
|
'''Password policy for User Pools.
|
|
15436
15411
|
|
|
15437
15412
|
:param min_length: Minimum length required for a user's password. Default: 8
|
|
15413
|
+
:param password_history_size: The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. ``passwordHistorySize`` can not be set when ``featurePlan`` is ``FeaturePlan.LITE``. Default: undefined - Cognito default setting is no restriction
|
|
15438
15414
|
:param require_digits: Whether the user is required to have digits in their password. Default: true
|
|
15439
15415
|
:param require_lowercase: Whether the user is required to have lowercase characters in their password. Default: true
|
|
15440
15416
|
:param require_symbols: Whether the user is required to have symbols in their password. Default: true
|
|
@@ -15460,6 +15436,7 @@ class PasswordPolicy:
|
|
|
15460
15436
|
if __debug__:
|
|
15461
15437
|
type_hints = typing.get_type_hints(_typecheckingstub__e884ae0f43a6b00e4ef287afca45bf6a9a7abbd94b7979efb6efa2a9cc11012b)
|
|
15462
15438
|
check_type(argname="argument min_length", value=min_length, expected_type=type_hints["min_length"])
|
|
15439
|
+
check_type(argname="argument password_history_size", value=password_history_size, expected_type=type_hints["password_history_size"])
|
|
15463
15440
|
check_type(argname="argument require_digits", value=require_digits, expected_type=type_hints["require_digits"])
|
|
15464
15441
|
check_type(argname="argument require_lowercase", value=require_lowercase, expected_type=type_hints["require_lowercase"])
|
|
15465
15442
|
check_type(argname="argument require_symbols", value=require_symbols, expected_type=type_hints["require_symbols"])
|
|
@@ -15468,6 +15445,8 @@ class PasswordPolicy:
|
|
|
15468
15445
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
15469
15446
|
if min_length is not None:
|
|
15470
15447
|
self._values["min_length"] = min_length
|
|
15448
|
+
if password_history_size is not None:
|
|
15449
|
+
self._values["password_history_size"] = password_history_size
|
|
15471
15450
|
if require_digits is not None:
|
|
15472
15451
|
self._values["require_digits"] = require_digits
|
|
15473
15452
|
if require_lowercase is not None:
|
|
@@ -15488,6 +15467,17 @@ class PasswordPolicy:
|
|
|
15488
15467
|
result = self._values.get("min_length")
|
|
15489
15468
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
15490
15469
|
|
|
15470
|
+
@builtins.property
|
|
15471
|
+
def password_history_size(self) -> typing.Optional[jsii.Number]:
|
|
15472
|
+
'''The number of previous passwords that you want Amazon Cognito to restrict each user from reusing.
|
|
15473
|
+
|
|
15474
|
+
``passwordHistorySize`` can not be set when ``featurePlan`` is ``FeaturePlan.LITE``.
|
|
15475
|
+
|
|
15476
|
+
:default: undefined - Cognito default setting is no restriction
|
|
15477
|
+
'''
|
|
15478
|
+
result = self._values.get("password_history_size")
|
|
15479
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
|
15480
|
+
|
|
15491
15481
|
@builtins.property
|
|
15492
15482
|
def require_digits(self) -> typing.Optional[builtins.bool]:
|
|
15493
15483
|
'''Whether the user is required to have digits in their password.
|
|
@@ -15620,7 +15610,7 @@ class ProviderAttribute(
|
|
|
15620
15610
|
@jsii.python.classproperty
|
|
15621
15611
|
@jsii.member(jsii_name="APPLE_EMAIL_VERIFIED")
|
|
15622
15612
|
def APPLE_EMAIL_VERIFIED(cls) -> "ProviderAttribute":
|
|
15623
|
-
'''The email verified
|
|
15613
|
+
'''The email verified attribute provided by Apple.'''
|
|
15624
15614
|
return typing.cast("ProviderAttribute", jsii.sget(cls, "APPLE_EMAIL_VERIFIED"))
|
|
15625
15615
|
|
|
15626
15616
|
@jsii.python.classproperty
|
|
@@ -16286,7 +16276,7 @@ class StandardAttributes:
|
|
|
16286
16276
|
:param middle_name: The user's middle name. Default: - see the defaults under ``StandardAttribute``
|
|
16287
16277
|
:param nickname: The user's nickname or casual name. Default: - see the defaults under ``StandardAttribute``
|
|
16288
16278
|
:param phone_number: The user's telephone number. Default: - see the defaults under ``StandardAttribute``
|
|
16289
|
-
:param preferred_username: The user's
|
|
16279
|
+
:param preferred_username: The user's preferred username, different from the immutable user name. Default: - see the defaults under ``StandardAttribute``
|
|
16290
16280
|
:param profile_page: The URL to the user's profile page. Default: - see the defaults under ``StandardAttribute``
|
|
16291
16281
|
:param profile_picture: The URL to the user's profile picture. Default: - see the defaults under ``StandardAttribute``
|
|
16292
16282
|
:param timezone: The user's time zone. Default: - see the defaults under ``StandardAttribute``
|
|
@@ -16516,7 +16506,7 @@ class StandardAttributes:
|
|
|
16516
16506
|
|
|
16517
16507
|
@builtins.property
|
|
16518
16508
|
def preferred_username(self) -> typing.Optional[StandardAttribute]:
|
|
16519
|
-
'''The user's
|
|
16509
|
+
'''The user's preferred username, different from the immutable user name.
|
|
16520
16510
|
|
|
16521
16511
|
:default: - see the defaults under ``StandardAttribute``
|
|
16522
16512
|
'''
|
|
@@ -16636,7 +16626,7 @@ class StandardAttributesMask:
|
|
|
16636
16626
|
:param nickname: The user's nickname or casual name. Default: false
|
|
16637
16627
|
:param phone_number: The user's telephone number. Default: false
|
|
16638
16628
|
:param phone_number_verified: Whether the phone number has been verified. Default: false
|
|
16639
|
-
:param preferred_username: The user's
|
|
16629
|
+
:param preferred_username: The user's preferred username, different from the immutable user name. Default: false
|
|
16640
16630
|
:param profile_page: The URL to the user's profile page. Default: false
|
|
16641
16631
|
:param profile_picture: The URL to the user's profile picture. Default: false
|
|
16642
16632
|
:param timezone: The user's time zone. Default: false
|
|
@@ -16648,7 +16638,7 @@ class StandardAttributesMask:
|
|
|
16648
16638
|
|
|
16649
16639
|
pool = cognito.UserPool(self, "Pool")
|
|
16650
16640
|
|
|
16651
|
-
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("
|
|
16641
|
+
client_write_attributes = (cognito.ClientAttributes()).with_standard_attributes(fullname=True, email=True).with_custom_attributes("favoritePizza", "favoriteBeverage")
|
|
16652
16642
|
|
|
16653
16643
|
client_read_attributes = client_write_attributes.with_standard_attributes(email_verified=True).with_custom_attributes("pointsEarned")
|
|
16654
16644
|
|
|
@@ -16847,7 +16837,7 @@ class StandardAttributesMask:
|
|
|
16847
16837
|
|
|
16848
16838
|
@builtins.property
|
|
16849
16839
|
def preferred_username(self) -> typing.Optional[builtins.bool]:
|
|
16850
|
-
'''The user's
|
|
16840
|
+
'''The user's preferred username, different from the immutable user name.
|
|
16851
16841
|
|
|
16852
16842
|
:default: false
|
|
16853
16843
|
'''
|
|
@@ -17450,18 +17440,22 @@ class UserPool(
|
|
|
17450
17440
|
*,
|
|
17451
17441
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17452
17442
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17443
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
17453
17444
|
) -> "UserPoolDomain":
|
|
17454
17445
|
'''Associate a domain to this user pool.
|
|
17455
17446
|
|
|
17456
17447
|
:param id: -
|
|
17457
17448
|
: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.
|
|
17458
17449
|
: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.
|
|
17450
|
+
: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
|
|
17459
17451
|
'''
|
|
17460
17452
|
if __debug__:
|
|
17461
17453
|
type_hints = typing.get_type_hints(_typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2d48a103)
|
|
17462
17454
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
17463
17455
|
options = UserPoolDomainOptions(
|
|
17464
|
-
cognito_domain=cognito_domain,
|
|
17456
|
+
cognito_domain=cognito_domain,
|
|
17457
|
+
custom_domain=custom_domain,
|
|
17458
|
+
managed_login_version=managed_login_version,
|
|
17465
17459
|
)
|
|
17466
17460
|
|
|
17467
17461
|
return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
|
|
@@ -18514,6 +18508,7 @@ class UserPoolDomain(
|
|
|
18514
18508
|
user_pool: IUserPool,
|
|
18515
18509
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18516
18510
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18511
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18517
18512
|
) -> None:
|
|
18518
18513
|
'''
|
|
18519
18514
|
:param scope: -
|
|
@@ -18521,6 +18516,7 @@ class UserPoolDomain(
|
|
|
18521
18516
|
:param user_pool: The user pool to which this domain should be associated.
|
|
18522
18517
|
: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.
|
|
18523
18518
|
: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.
|
|
18519
|
+
: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
|
|
18524
18520
|
'''
|
|
18525
18521
|
if __debug__:
|
|
18526
18522
|
type_hints = typing.get_type_hints(_typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94152b471)
|
|
@@ -18530,6 +18526,7 @@ class UserPoolDomain(
|
|
|
18530
18526
|
user_pool=user_pool,
|
|
18531
18527
|
cognito_domain=cognito_domain,
|
|
18532
18528
|
custom_domain=custom_domain,
|
|
18529
|
+
managed_login_version=managed_login_version,
|
|
18533
18530
|
)
|
|
18534
18531
|
|
|
18535
18532
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -18623,7 +18620,11 @@ class UserPoolDomain(
|
|
|
18623
18620
|
@jsii.data_type(
|
|
18624
18621
|
jsii_type="aws-cdk-lib.aws_cognito.UserPoolDomainOptions",
|
|
18625
18622
|
jsii_struct_bases=[],
|
|
18626
|
-
name_mapping={
|
|
18623
|
+
name_mapping={
|
|
18624
|
+
"cognito_domain": "cognitoDomain",
|
|
18625
|
+
"custom_domain": "customDomain",
|
|
18626
|
+
"managed_login_version": "managedLoginVersion",
|
|
18627
|
+
},
|
|
18627
18628
|
)
|
|
18628
18629
|
class UserPoolDomainOptions:
|
|
18629
18630
|
def __init__(
|
|
@@ -18631,11 +18632,13 @@ class UserPoolDomainOptions:
|
|
|
18631
18632
|
*,
|
|
18632
18633
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18633
18634
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18635
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18634
18636
|
) -> None:
|
|
18635
18637
|
'''Options to create a UserPoolDomain.
|
|
18636
18638
|
|
|
18637
18639
|
: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.
|
|
18638
18640
|
: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.
|
|
18641
|
+
: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
|
|
18639
18642
|
|
|
18640
18643
|
:exampleMetadata: infused
|
|
18641
18644
|
|
|
@@ -18667,11 +18670,14 @@ class UserPoolDomainOptions:
|
|
|
18667
18670
|
type_hints = typing.get_type_hints(_typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af679070c0)
|
|
18668
18671
|
check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
|
|
18669
18672
|
check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
|
|
18673
|
+
check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
|
|
18670
18674
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
18671
18675
|
if cognito_domain is not None:
|
|
18672
18676
|
self._values["cognito_domain"] = cognito_domain
|
|
18673
18677
|
if custom_domain is not None:
|
|
18674
18678
|
self._values["custom_domain"] = custom_domain
|
|
18679
|
+
if managed_login_version is not None:
|
|
18680
|
+
self._values["managed_login_version"] = managed_login_version
|
|
18675
18681
|
|
|
18676
18682
|
@builtins.property
|
|
18677
18683
|
def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
|
|
@@ -18695,6 +18701,19 @@ class UserPoolDomainOptions:
|
|
|
18695
18701
|
result = self._values.get("custom_domain")
|
|
18696
18702
|
return typing.cast(typing.Optional[CustomDomainOptions], result)
|
|
18697
18703
|
|
|
18704
|
+
@builtins.property
|
|
18705
|
+
def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
|
|
18706
|
+
'''A version that indicates the state of managed login.
|
|
18707
|
+
|
|
18708
|
+
This choice applies to all app clients that host services at the domain.
|
|
18709
|
+
|
|
18710
|
+
:default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18711
|
+
|
|
18712
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
|
|
18713
|
+
'''
|
|
18714
|
+
result = self._values.get("managed_login_version")
|
|
18715
|
+
return typing.cast(typing.Optional[ManagedLoginVersion], result)
|
|
18716
|
+
|
|
18698
18717
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
18699
18718
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
18700
18719
|
|
|
@@ -18713,6 +18732,7 @@ class UserPoolDomainOptions:
|
|
|
18713
18732
|
name_mapping={
|
|
18714
18733
|
"cognito_domain": "cognitoDomain",
|
|
18715
18734
|
"custom_domain": "customDomain",
|
|
18735
|
+
"managed_login_version": "managedLoginVersion",
|
|
18716
18736
|
"user_pool": "userPool",
|
|
18717
18737
|
},
|
|
18718
18738
|
)
|
|
@@ -18722,12 +18742,14 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18722
18742
|
*,
|
|
18723
18743
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18724
18744
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18745
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18725
18746
|
user_pool: IUserPool,
|
|
18726
18747
|
) -> None:
|
|
18727
18748
|
'''Props for UserPoolDomain construct.
|
|
18728
18749
|
|
|
18729
18750
|
: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.
|
|
18730
18751
|
: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.
|
|
18752
|
+
: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
|
|
18731
18753
|
:param user_pool: The user pool to which this domain should be associated.
|
|
18732
18754
|
|
|
18733
18755
|
:exampleMetadata: infused
|
|
@@ -18800,6 +18822,7 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18800
18822
|
type_hints = typing.get_type_hints(_typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c34f7baa)
|
|
18801
18823
|
check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
|
|
18802
18824
|
check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
|
|
18825
|
+
check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
|
|
18803
18826
|
check_type(argname="argument user_pool", value=user_pool, expected_type=type_hints["user_pool"])
|
|
18804
18827
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
18805
18828
|
"user_pool": user_pool,
|
|
@@ -18808,6 +18831,8 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18808
18831
|
self._values["cognito_domain"] = cognito_domain
|
|
18809
18832
|
if custom_domain is not None:
|
|
18810
18833
|
self._values["custom_domain"] = custom_domain
|
|
18834
|
+
if managed_login_version is not None:
|
|
18835
|
+
self._values["managed_login_version"] = managed_login_version
|
|
18811
18836
|
|
|
18812
18837
|
@builtins.property
|
|
18813
18838
|
def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
|
|
@@ -18831,6 +18856,19 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18831
18856
|
result = self._values.get("custom_domain")
|
|
18832
18857
|
return typing.cast(typing.Optional[CustomDomainOptions], result)
|
|
18833
18858
|
|
|
18859
|
+
@builtins.property
|
|
18860
|
+
def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
|
|
18861
|
+
'''A version that indicates the state of managed login.
|
|
18862
|
+
|
|
18863
|
+
This choice applies to all app clients that host services at the domain.
|
|
18864
|
+
|
|
18865
|
+
:default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18866
|
+
|
|
18867
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
|
|
18868
|
+
'''
|
|
18869
|
+
result = self._values.get("managed_login_version")
|
|
18870
|
+
return typing.cast(typing.Optional[ManagedLoginVersion], result)
|
|
18871
|
+
|
|
18834
18872
|
@builtins.property
|
|
18835
18873
|
def user_pool(self) -> IUserPool:
|
|
18836
18874
|
'''The user pool to which this domain should be associated.'''
|
|
@@ -22933,6 +22971,7 @@ __all__ = [
|
|
|
22933
22971
|
"IUserPoolResourceServer",
|
|
22934
22972
|
"KeepOriginalAttrs",
|
|
22935
22973
|
"LambdaVersion",
|
|
22974
|
+
"ManagedLoginVersion",
|
|
22936
22975
|
"Mfa",
|
|
22937
22976
|
"MfaSecondFactor",
|
|
22938
22977
|
"NumberAttribute",
|
|
@@ -24636,7 +24675,7 @@ def _typecheckingstub__392de74de1133635a0d4d21dbd0cb3290007171e021625ff9a1259834
|
|
|
24636
24675
|
id: builtins.str,
|
|
24637
24676
|
*,
|
|
24638
24677
|
user_pool_id: builtins.str,
|
|
24639
|
-
client_metadata: typing.Optional[typing.Union[
|
|
24678
|
+
client_metadata: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
24640
24679
|
desired_delivery_mediums: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
24641
24680
|
force_alias_creation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
24642
24681
|
message_action: typing.Optional[builtins.str] = None,
|
|
@@ -24666,7 +24705,7 @@ def _typecheckingstub__feefc710cb336bda2be62c58dcbdfc764a535ab2e52aa19e44511aca0
|
|
|
24666
24705
|
pass
|
|
24667
24706
|
|
|
24668
24707
|
def _typecheckingstub__674b44537db9d65119536a886fe3b7990cd0df2f1aa1c3c2880711f8b302ae40(
|
|
24669
|
-
value: typing.Optional[typing.Union[
|
|
24708
|
+
value: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]],
|
|
24670
24709
|
) -> None:
|
|
24671
24710
|
"""Type checking stubs"""
|
|
24672
24711
|
pass
|
|
@@ -24718,7 +24757,7 @@ def _typecheckingstub__480fd17b16e7156f8c801d35ad2f0806c252a5a32182194061ca2a956
|
|
|
24718
24757
|
def _typecheckingstub__382fb58e358860ff3016c5f0203cf6f5b59ab27ba70ef920ce589784afe54f17(
|
|
24719
24758
|
*,
|
|
24720
24759
|
user_pool_id: builtins.str,
|
|
24721
|
-
client_metadata: typing.Optional[typing.Union[
|
|
24760
|
+
client_metadata: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
24722
24761
|
desired_delivery_mediums: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
24723
24762
|
force_alias_creation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
24724
24763
|
message_action: typing.Optional[builtins.str] = None,
|
|
@@ -24860,6 +24899,7 @@ def _typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e
|
|
|
24860
24899
|
*,
|
|
24861
24900
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24862
24901
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24902
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
24863
24903
|
) -> None:
|
|
24864
24904
|
"""Type checking stubs"""
|
|
24865
24905
|
pass
|
|
@@ -24978,6 +25018,7 @@ def _typecheckingstub__4661d75bb2c69171e02ca544be91ebb3d950a95f070c8471007dc24e8
|
|
|
24978
25018
|
def _typecheckingstub__e884ae0f43a6b00e4ef287afca45bf6a9a7abbd94b7979efb6efa2a9cc11012b(
|
|
24979
25019
|
*,
|
|
24980
25020
|
min_length: typing.Optional[jsii.Number] = None,
|
|
25021
|
+
password_history_size: typing.Optional[jsii.Number] = None,
|
|
24981
25022
|
require_digits: typing.Optional[builtins.bool] = None,
|
|
24982
25023
|
require_lowercase: typing.Optional[builtins.bool] = None,
|
|
24983
25024
|
require_symbols: typing.Optional[builtins.bool] = None,
|
|
@@ -25180,6 +25221,7 @@ def _typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2
|
|
|
25180
25221
|
*,
|
|
25181
25222
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25182
25223
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25224
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25183
25225
|
) -> None:
|
|
25184
25226
|
"""Type checking stubs"""
|
|
25185
25227
|
pass
|
|
@@ -25314,6 +25356,7 @@ def _typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94
|
|
|
25314
25356
|
user_pool: IUserPool,
|
|
25315
25357
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25316
25358
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25359
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25317
25360
|
) -> None:
|
|
25318
25361
|
"""Type checking stubs"""
|
|
25319
25362
|
pass
|
|
@@ -25340,6 +25383,7 @@ def _typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af6
|
|
|
25340
25383
|
*,
|
|
25341
25384
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25342
25385
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25386
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25343
25387
|
) -> None:
|
|
25344
25388
|
"""Type checking stubs"""
|
|
25345
25389
|
pass
|
|
@@ -25348,6 +25392,7 @@ def _typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c
|
|
|
25348
25392
|
*,
|
|
25349
25393
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25350
25394
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25395
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25351
25396
|
user_pool: IUserPool,
|
|
25352
25397
|
) -> None:
|
|
25353
25398
|
"""Type checking stubs"""
|