aws-cdk-lib 2.176.0__py3-none-any.whl → 2.177.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +11 -1
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.176.0.jsii.tgz → aws-cdk-lib@2.177.0.jsii.tgz} +0 -0
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +2 -2
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_batch/__init__.py +4 -2
- aws_cdk/aws_bedrock/__init__.py +5395 -2508
- aws_cdk/aws_cloudfront/__init__.py +12 -2
- aws_cdk/aws_cloudfront_origins/__init__.py +33 -2
- aws_cdk/aws_codepipeline/__init__.py +35 -0
- aws_cdk/aws_cognito/__init__.py +162 -139
- aws_cdk/aws_customerprofiles/__init__.py +3 -3
- aws_cdk/aws_datazone/__init__.py +195 -125
- aws_cdk/aws_ec2/__init__.py +5 -3
- aws_cdk/aws_ecs/__init__.py +27 -8
- aws_cdk/aws_efs/__init__.py +5 -5
- aws_cdk/aws_eks/__init__.py +24 -3
- aws_cdk/aws_emrserverless/__init__.py +86 -0
- aws_cdk/aws_fms/__init__.py +42 -0
- aws_cdk/aws_gamelift/__init__.py +8 -10
- aws_cdk/aws_iam/__init__.py +8 -0
- aws_cdk/aws_imagebuilder/__init__.py +62 -48
- aws_cdk/aws_lambda/__init__.py +13 -0
- aws_cdk/aws_logs/__init__.py +59 -59
- aws_cdk/aws_notifications/__init__.py +1390 -0
- aws_cdk/aws_notificationscontacts/__init__.py +593 -0
- aws_cdk/aws_rds/__init__.py +16 -22
- aws_cdk/aws_redshift/__init__.py +9 -5
- aws_cdk/aws_route53/__init__.py +4 -4
- aws_cdk/aws_route53_targets/__init__.py +15 -15
- aws_cdk/aws_s3/__init__.py +789 -0
- aws_cdk/aws_s3_notifications/__init__.py +5 -5
- aws_cdk/aws_s3tables/__init__.py +2 -2
- aws_cdk/aws_sns/__init__.py +39 -0
- aws_cdk/aws_ssm/__init__.py +5 -5
- aws_cdk/aws_synthetics/__init__.py +105 -32
- aws_cdk/cloud_assembly_schema/__init__.py +63 -4
- aws_cdk/cx_api/__init__.py +44 -4
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/METADATA +3 -3
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/RECORD +44 -42
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.177.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -977,6 +977,28 @@ Read more about [Using the Amazon Cognito
|
|
|
977
977
|
Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html) and [Using Your Own
|
|
978
978
|
Domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
|
|
979
979
|
|
|
980
|
+
You can use the [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) page provided by Amazon Cognito to sign in users. The managed login page has two versions: a classic version and a new version. You can switch between the two versions by using the `managedLoginVersion` property.
|
|
981
|
+
|
|
982
|
+
```python
|
|
983
|
+
pool = cognito.UserPool(self, "Pool")
|
|
984
|
+
|
|
985
|
+
# Use the new managed login page
|
|
986
|
+
pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
|
|
987
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
988
|
+
domain_prefix="blanding-design-ui"
|
|
989
|
+
),
|
|
990
|
+
managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
|
|
991
|
+
)
|
|
992
|
+
|
|
993
|
+
# Use the classic hosted UI
|
|
994
|
+
pool.add_domain("DomainWithClassicHostedUi",
|
|
995
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
996
|
+
domain_prefix="classic-hosted-ui"
|
|
997
|
+
),
|
|
998
|
+
managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
999
|
+
)
|
|
1000
|
+
```
|
|
1001
|
+
|
|
980
1002
|
The `signInUrl()` methods returns the fully qualified URL to the login page for the user pool. This page comes from the
|
|
981
1003
|
hosted UI configured with Cognito. Learn more at [Hosted UI with the Amazon Cognito
|
|
982
1004
|
Console](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html#cognito-user-pools-create-an-app-integration).
|
|
@@ -3758,9 +3780,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3758
3780
|
) -> None:
|
|
3759
3781
|
'''The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
|
|
3760
3782
|
|
|
3761
|
-
|
|
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`` .
|
|
3783
|
+
:param cloud_watch_logs_configuration: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3764
3784
|
:param event_source: The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to ``userNotification`` . To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to ``userAuthEvents`` .
|
|
3765
3785
|
:param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
|
|
3766
3786
|
:param log_level: The ``errorlevel`` selection of logs that a user pool sends for detailed activity logging. To send ``userNotification`` activity with `information about message delivery <https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html>`_ , choose ``ERROR`` with ``CloudWatchLogsConfiguration`` . To send ``userAuthEvents`` activity with user logs from threat protection with the Plus feature plan, choose ``INFO`` with one of ``CloudWatchLogsConfiguration`` , ``FirehoseConfiguration`` , or ``S3Configuration`` .
|
|
@@ -3812,9 +3832,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3812
3832
|
def cloud_watch_logs_configuration(
|
|
3813
3833
|
self,
|
|
3814
3834
|
) -> 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`` .
|
|
3835
|
+
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3818
3836
|
|
|
3819
3837
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration
|
|
3820
3838
|
'''
|
|
@@ -4266,8 +4284,6 @@ class CfnManagedLoginBranding(
|
|
|
4266
4284
|
) -> None:
|
|
4267
4285
|
'''An image file from a managed login branding style in a user pool.
|
|
4268
4286
|
|
|
4269
|
-
This data type is a request parameter of ``API_CreateManagedLoginBranding`` and ``API_UpdateManagedLoginBranding`` , and a response parameter of ``API_DescribeManagedLoginBranding`` .
|
|
4270
|
-
|
|
4271
4287
|
:param category: The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.
|
|
4272
4288
|
:param color_mode: The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.
|
|
4273
4289
|
:param extension: The file type of the image file.
|
|
@@ -4729,7 +4745,7 @@ class CfnUserPool(
|
|
|
4729
4745
|
:param scope: Scope in which this resource is defined.
|
|
4730
4746
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4731
4747
|
:param account_recovery_setting: The available verified method a user can use to recover their password when they call ``ForgotPassword`` . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
|
|
4732
|
-
:param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
4748
|
+
:param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
4733
4749
|
:param alias_attributes: Attributes supported as an alias for this user pool. For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
4734
4750
|
:param auto_verified_attributes: The attributes that you want your user pool to automatically verify. For more information, see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
|
|
4735
4751
|
:param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
|
|
@@ -4742,7 +4758,7 @@ class CfnUserPool(
|
|
|
4742
4758
|
:param enabled_mfas: Set enabled MFA options on a specified user pool. To disable all MFAs after it has been enabled, set ``MfaConfiguration`` to ``OFF`` and remove EnabledMfas. MFAs can only be all disabled if ``MfaConfiguration`` is ``OFF`` . After you enable ``SMS_MFA`` , you can only disable it by setting ``MfaConfiguration`` to ``OFF`` . Can be one of the following values: - ``SMS_MFA`` - Enables MFA with SMS for the user pool. To select this option, you must also provide values for ``SmsConfiguration`` . - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. - ``EMAIL_OTP`` - Enables MFA with email for the user pool. To select this option, you must provide values for ``EmailConfiguration`` and within those, set ``EmailSendingAccount`` to ``DEVELOPER`` . Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA`` | ``EMAIL_OTP``
|
|
4743
4759
|
:param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
|
|
4744
4760
|
:param mfa_configuration: Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ``ON`` , all users must set up MFA before they can sign in. When ``OPTIONAL`` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose ``OPTIONAL`` . When ``MfaConfiguration`` is ``OPTIONAL`` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
|
|
4745
|
-
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
4761
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
4746
4762
|
:param schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see `Working with user attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html>`_ .
|
|
4747
4763
|
:param sms_authentication_message: The contents of the SMS authentication message.
|
|
4748
4764
|
:param sms_configuration: The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
|
|
@@ -5095,10 +5111,7 @@ class CfnUserPool(
|
|
|
5095
5111
|
def policies(
|
|
5096
5112
|
self,
|
|
5097
5113
|
) -> 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
|
-
'''
|
|
5114
|
+
'''A list of user pool policies.'''
|
|
5102
5115
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]], jsii.get(self, "policies"))
|
|
5103
5116
|
|
|
5104
5117
|
@policies.setter
|
|
@@ -5411,11 +5424,9 @@ class CfnUserPool(
|
|
|
5411
5424
|
|
|
5412
5425
|
Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
5413
5426
|
|
|
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
5427
|
:param allow_admin_create_user_only: The setting for allowing self-service sign-up. When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the ``SignUp`` operation.
|
|
5417
5428
|
:param invite_message_template: The template for the welcome message to new users. This template must include the ``{####}`` temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder. See also `Customizing User Invitation Messages <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization>`_ .
|
|
5418
|
-
:param unused_account_validity_days: This parameter is no longer in use.
|
|
5429
|
+
:param unused_account_validity_days: This parameter is no longer in use. The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter. The default value for this parameter is 7.
|
|
5419
5430
|
|
|
5420
5431
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
|
|
5421
5432
|
:exampleMetadata: fixture=_generated
|
|
@@ -5481,8 +5492,6 @@ class CfnUserPool(
|
|
|
5481
5492
|
def unused_account_validity_days(self) -> typing.Optional[jsii.Number]:
|
|
5482
5493
|
'''This parameter is no longer in use.
|
|
5483
5494
|
|
|
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
5495
|
The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter.
|
|
5487
5496
|
|
|
5488
5497
|
The default value for this parameter is 7.
|
|
@@ -5727,15 +5736,6 @@ class CfnUserPool(
|
|
|
5727
5736
|
) -> None:
|
|
5728
5737
|
'''The device-remembering configuration for a user pool.
|
|
5729
5738
|
|
|
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
5739
|
:param challenge_required_on_new_device: When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA). .. epigraph:: Whether or not ``ChallengeRequiredOnNewDevice`` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
|
|
5740
5740
|
:param device_only_remembered_on_user_prompt: When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ``ConfirmDevice`` API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an ``UpdateDeviceStatus`` API request. When ``DeviceOnlyRememberedOnUserPrompt`` is ``false`` , Amazon Cognito immediately remembers devices that you register in a ``ConfirmDevice`` API request.
|
|
5741
5741
|
|
|
@@ -6095,8 +6095,6 @@ class CfnUserPool(
|
|
|
6095
6095
|
|
|
6096
6096
|
Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
|
|
6097
6097
|
|
|
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
6098
|
:param create_auth_challenge: The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
6101
6099
|
:param custom_email_sender: The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.
|
|
6102
6100
|
:param custom_message: A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.
|
|
@@ -6358,8 +6356,6 @@ class CfnUserPool(
|
|
|
6358
6356
|
) -> None:
|
|
6359
6357
|
'''The minimum and maximum values of an attribute that is of the number type, for example ``custom:age`` .
|
|
6360
6358
|
|
|
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
6359
|
:param max_value: The maximum length of a number attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
|
|
6364
6360
|
:param min_value: The minimum value of an attribute that is of the number data type.
|
|
6365
6361
|
|
|
@@ -6445,10 +6441,8 @@ class CfnUserPool(
|
|
|
6445
6441
|
) -> None:
|
|
6446
6442
|
'''The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
6447
6443
|
|
|
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
6444
|
:param minimum_length: The minimum length of the password in the policy that you have set. This value can't be less than 6.
|
|
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`` .
|
|
6445
|
+
:param password_history_size: The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` .
|
|
6452
6446
|
:param require_lowercase: The requirement in a password policy that users must include at least one lowercase letter in their password.
|
|
6453
6447
|
:param require_numbers: The requirement in a password policy that users must include at least one number in their password.
|
|
6454
6448
|
:param require_symbols: The requirement in a password policy that users must include at least one symbol in their password.
|
|
@@ -6516,8 +6510,6 @@ class CfnUserPool(
|
|
|
6516
6510
|
|
|
6517
6511
|
Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` .
|
|
6518
6512
|
|
|
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
6513
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-passwordhistorysize
|
|
6522
6514
|
'''
|
|
6523
6515
|
result = self._values.get("password_history_size")
|
|
@@ -6607,12 +6599,12 @@ class CfnUserPool(
|
|
|
6607
6599
|
password_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.PasswordPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6608
6600
|
sign_in_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.SignInPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6609
6601
|
) -> None:
|
|
6610
|
-
'''A list of user pool policies.
|
|
6602
|
+
'''A list of user pool policies.
|
|
6611
6603
|
|
|
6612
|
-
|
|
6604
|
+
Contains the policy that sets password-complexity requirements.
|
|
6613
6605
|
|
|
6614
6606
|
: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.
|
|
6607
|
+
:param sign_in_policy: The policy for allowed types of authentication in a user pool. To activate this setting, your user pool must be in the `Essentials tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html>`_ or higher.
|
|
6616
6608
|
|
|
6617
6609
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html
|
|
6618
6610
|
:exampleMetadata: fixture=_generated
|
|
@@ -6667,8 +6659,6 @@ class CfnUserPool(
|
|
|
6667
6659
|
|
|
6668
6660
|
To activate this setting, your user pool must be in the `Essentials tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html>`_ or higher.
|
|
6669
6661
|
|
|
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
6662
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-signinpolicy
|
|
6673
6663
|
'''
|
|
6674
6664
|
result = self._values.get("sign_in_policy")
|
|
@@ -6699,8 +6689,6 @@ class CfnUserPool(
|
|
|
6699
6689
|
) -> None:
|
|
6700
6690
|
'''The properties of a pre token generation Lambda trigger.
|
|
6701
6691
|
|
|
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
6692
|
:param lambda_arn: The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger. This parameter and the ``PreTokenGeneration`` property of ``LambdaConfig`` have the same value. For new instances of pre token generation triggers, set ``LambdaArn`` .
|
|
6705
6693
|
:param lambda_version: The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
|
|
6706
6694
|
|
|
@@ -6779,8 +6767,6 @@ class CfnUserPool(
|
|
|
6779
6767
|
|
|
6780
6768
|
For example, if ``verified_email`` has a priority of ``1`` and ``verified_phone_number`` has a priority of ``2`` , your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The ``admin_only`` option prevents self-service account recovery.
|
|
6781
6769
|
|
|
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
6770
|
:param name: The recovery method that this object sets a recovery option for.
|
|
6785
6771
|
:param priority: Your priority preference for using the specified attribute in account recovery. The highest priority is ``1`` .
|
|
6786
6772
|
|
|
@@ -6870,8 +6856,6 @@ class CfnUserPool(
|
|
|
6870
6856
|
|
|
6871
6857
|
Developer-only ``dev:`` attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
|
|
6872
6858
|
|
|
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
6859
|
:param attribute_data_type: The data format of the values for your attribute. When you choose an ``AttributeDataType`` , Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example ``"custom:isMember" : "true"`` or ``"custom:YearsAsMember" : "12"`` .
|
|
6876
6860
|
:param developer_only_attribute: .. epigraph:: You should use `WriteAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes>`_ in the user pool client to control how attributes can be mutated for new use cases instead of using ``DeveloperOnlyAttribute`` . Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, ``DeveloperOnlyAttribute`` can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
|
|
6877
6861
|
:param mutable: Specifies whether the value of the attribute can be changed. Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of ``true`` . Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see `Specifying Identity Provider Attribute Mappings for Your User Pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
|
|
@@ -7041,8 +7025,6 @@ class CfnUserPool(
|
|
|
7041
7025
|
|
|
7042
7026
|
To activate this setting, your user pool must be in the `Essentials tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html>`_ or higher.
|
|
7043
7027
|
|
|
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
7028
|
:param allowed_first_auth_factors: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. Supports values of ``EMAIL_OTP`` , ``SMS_OTP`` , ``WEB_AUTHN`` and ``PASSWORD`` ,
|
|
7047
7029
|
|
|
7048
7030
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-signinpolicy.html
|
|
@@ -7112,8 +7094,6 @@ class CfnUserPool(
|
|
|
7112
7094
|
|
|
7113
7095
|
To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .
|
|
7114
7096
|
|
|
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
7097
|
:param external_id: The external ID provides additional security for your IAM role. You can use an ``ExternalId`` with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ``ExternalId`` , your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ``ExternalID`` . If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ``ExternalId`` . For more information about the ``ExternalId`` of a role, see `How to use an external ID when granting access to your AWS resources to a third party <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_ .
|
|
7118
7098
|
:param sns_caller_arn: The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a `spending limit <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html>`_ .
|
|
7119
7099
|
:param sns_region: The AWS Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported *Legacy Amazon SNS alternate Region* . Amazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see `SMS message settings for Amazon Cognito user pools <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
|
|
@@ -7208,8 +7188,6 @@ class CfnUserPool(
|
|
|
7208
7188
|
) -> None:
|
|
7209
7189
|
'''The minimum and maximum length values of an attribute that is of the string type, for example ``custom:department`` .
|
|
7210
7190
|
|
|
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
7191
|
:param max_length: The maximum length of a string attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
|
|
7214
7192
|
:param min_length: The minimum length of a string attribute value.
|
|
7215
7193
|
|
|
@@ -7287,7 +7265,7 @@ class CfnUserPool(
|
|
|
7287
7265
|
a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
|
|
7288
7266
|
more information, see `Verifying updates to email addresses and phone numbers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates>`_ .
|
|
7289
7267
|
|
|
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.
|
|
7268
|
+
:param attributes_require_verification_before_update: Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value. When ``AttributesRequireVerificationBeforeUpdate`` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ``AttributesRequireVerificationBeforeUpdate`` is false, API operations that change attribute values can immediately update a user’s ``email`` or ``phone_number`` attribute.
|
|
7291
7269
|
|
|
7292
7270
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html
|
|
7293
7271
|
:exampleMetadata: fixture=_generated
|
|
@@ -7317,8 +7295,6 @@ class CfnUserPool(
|
|
|
7317
7295
|
|
|
7318
7296
|
When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
|
|
7319
7297
|
|
|
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
7298
|
When ``AttributesRequireVerificationBeforeUpdate`` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ``AttributesRequireVerificationBeforeUpdate`` is false, API operations that change attribute values can immediately update a user’s ``email`` or ``phone_number`` attribute.
|
|
7323
7299
|
|
|
7324
7300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html#cfn-cognito-userpool-userattributeupdatesettings-attributesrequireverificationbeforeupdate
|
|
@@ -7353,14 +7329,12 @@ class CfnUserPool(
|
|
|
7353
7329
|
advanced_security_additional_flows: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.AdvancedSecurityAdditionalFlowsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7354
7330
|
advanced_security_mode: typing.Optional[builtins.str] = None,
|
|
7355
7331
|
) -> None:
|
|
7356
|
-
'''
|
|
7332
|
+
'''User pool add-ons.
|
|
7357
7333
|
|
|
7358
|
-
To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to
|
|
7334
|
+
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
7335
|
|
|
7360
7336
|
For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ . To activate this setting, your user pool must be on the `Plus tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html>`_ .
|
|
7361
7337
|
|
|
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
7338
|
:param advanced_security_additional_flows: Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
|
|
7365
7339
|
:param advanced_security_mode: The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
|
|
7366
7340
|
|
|
@@ -7436,8 +7410,6 @@ class CfnUserPool(
|
|
|
7436
7410
|
|
|
7437
7411
|
When case sensitivity is set to ``False`` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, ``username`` , ``USERNAME`` , or ``UserName`` , or for email, ``email@example.com`` or ``EMaiL@eXamplE.Com`` . For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
|
|
7438
7412
|
|
|
7439
|
-
This configuration is immutable after you set it. For more information, see ``API_UsernameConfigurationType`` .
|
|
7440
|
-
|
|
7441
7413
|
:param case_sensitive: Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name. Valid values include: - **true** - Enables case sensitivity for all username input. When this option is set to ``true`` , users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - **false** - Enables case insensitivity for all username input. For example, when this option is set to ``false`` , users can sign in using ``username`` , ``USERNAME`` , or ``UserName`` . This option also enables both ``preferred_username`` and ``email`` alias to be case insensitive, in addition to the ``username`` attribute.
|
|
7442
7414
|
|
|
7443
7415
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html
|
|
@@ -7514,8 +7486,6 @@ class CfnUserPool(
|
|
|
7514
7486
|
) -> None:
|
|
7515
7487
|
'''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
|
|
7516
7488
|
|
|
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
7489
|
:param default_email_option: The configuration of verification emails to contain a clickable link or a verification code. For link, your template body must contain link text in the format ``{##Click here##}`` . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format ``{####}`` .
|
|
7520
7490
|
:param email_message: The template for email messages that Amazon Cognito sends to your users. You can set an ``EmailMessage`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
|
|
7521
7491
|
:param email_message_by_link: The email message template for sending a confirmation link to the user. You can set an ``EmailMessageByLink`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
|
|
@@ -7758,17 +7728,17 @@ class CfnUserPoolClient(
|
|
|
7758
7728
|
:param client_name: A friendly name for the app client that you want to create.
|
|
7759
7729
|
:param default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces ``redirect_uri`` in authentication requests. Must be in the ``CallbackURLs`` list.
|
|
7760
7730
|
:param enable_propagate_additional_user_context_data: When ``true`` , your application can include additional ``UserContextData`` in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see `Adding session data to API requests <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint>`_ . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
|
|
7761
|
-
:param enable_token_revocation: Activates or deactivates
|
|
7731
|
+
:param enable_token_revocation: Activates or deactivates token revocation. If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
7762
7732
|
:param explicit_auth_flows: The `authentication flows <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html>`_ that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your app client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . The values for authentication flow options include the following. - ``ALLOW_USER_AUTH`` : Enable selection-based sign-in with ``USER_AUTH`` . This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ``ExplicitAuthFlows`` permitting them. For example users can complete an SRP challenge through ``USER_AUTH`` without the flow ``USER_SRP_AUTH`` being active for the app client. This flow doesn't include ``CUSTOM_AUTH`` . To activate this setting, your user pool must be in the `Essentials tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html>`_ or higher. - ``ALLOW_ADMIN_USER_PASSWORD_AUTH`` : Enable admin based user password authentication flow ``ADMIN_USER_PASSWORD_AUTH`` . This setting replaces the ``ADMIN_NO_SRP_AUTH`` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. - ``ALLOW_CUSTOM_AUTH`` : Enable Lambda trigger based authentication. - ``ALLOW_USER_PASSWORD_AUTH`` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. - ``ALLOW_USER_SRP_AUTH`` : Enable SRP-based authentication. - ``ALLOW_REFRESH_TOKEN_AUTH`` : Enable authflow to refresh tokens. In some environments, you will see the values ``ADMIN_NO_SRP_AUTH`` , ``CUSTOM_AUTH_FLOW_ONLY`` , or ``USER_PASSWORD_AUTH`` . You can't assign these legacy ``ExplicitAuthFlows`` values to user pool clients at the same time as values that begin with ``ALLOW_`` , like ``ALLOW_USER_SRP_AUTH`` .
|
|
7763
7733
|
:param generate_secret: When ``true`` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see `App client types <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types>`_ .
|
|
7764
7734
|
:param id_token_validity: The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for ``IdTokenValidity`` as ``seconds`` , ``minutes`` , ``hours`` , or ``days`` , set a ``TokenValidityUnits`` value in your API request. For example, when you set ``IdTokenValidity`` as ``10`` and ``TokenValidityUnits`` as ``hours`` , your user can authenticate their session with their ID token for 10 hours. The default time unit for ``IdTokenValidity`` in an API request is hours. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
|
|
7765
7735
|
:param logout_ur_ls: A list of allowed logout URLs for managed login authentication. When you pass ``logout_uri`` and ``client_id`` parameters to ``/logout`` , Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of ``logout_uri`` . A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see `Logout endpoint <https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html>`_ .
|
|
7766
7736
|
:param prevent_user_existence_errors: Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ``ENABLED`` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ``LEGACY`` , those APIs return a ``UserNotFoundException`` exception if the user doesn't exist in the user pool. Valid values include: - ``ENABLED`` - This prevents user existence-related errors. - ``LEGACY`` - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented. Defaults to ``LEGACY`` when you don't provide a value.
|
|
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.
|
|
7737
|
+
:param read_attributes: The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. When you don't specify the ``ReadAttributes`` for your app client, your app can read the values of ``email_verified`` , ``phone_number_verified`` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ``ReadAttributes`` doesn't return any information. Amazon Cognito only populates ``ReadAttributes`` in the API response if you have specified your own custom set of read attributes.
|
|
7768
7738
|
:param refresh_token_validity: The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for ``RefreshTokenValidity`` as ``seconds`` , ``minutes`` , ``hours`` , or ``days`` , set a ``TokenValidityUnits`` value in your API request. For example, when you set ``RefreshTokenValidity`` as ``10`` and ``TokenValidityUnits`` as ``days`` , your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for ``RefreshTokenValidity`` in an API request is days. You can't set ``RefreshTokenValidity`` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
|
|
7769
7739
|
:param supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ``COGNITO`` , ``Facebook`` , ``Google`` , ``SignInWithApple`` , and ``LoginWithAmazon`` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example ``MySAMLIdP`` or ``MyOIDCIdP`` . This parameter sets the IdPs that `managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ will display on the login page for your app client. The removal of ``COGNITO`` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
|
|
7770
7740
|
:param token_validity_units: The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
|
|
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.
|
|
7741
|
+
:param write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. When you don't specify the ``WriteAttributes`` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, ``WriteAttributes`` doesn't return any information. Amazon Cognito only populates ``WriteAttributes`` in the API response if you have specified your own custom set of write attributes. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see `Specifying IdP Attribute Mappings for Your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
|
|
7772
7742
|
'''
|
|
7773
7743
|
if __debug__:
|
|
7774
7744
|
type_hints = typing.get_type_hints(_typecheckingstub__87712ca9ae8faf9f73a6c5d11987fcf280543ea093bcc4253c800c0151725828)
|
|
@@ -8030,7 +8000,7 @@ class CfnUserPoolClient(
|
|
|
8030
8000
|
def enable_token_revocation(
|
|
8031
8001
|
self,
|
|
8032
8002
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
8033
|
-
'''Activates or deactivates
|
|
8003
|
+
'''Activates or deactivates token revocation.'''
|
|
8034
8004
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enableTokenRevocation"))
|
|
8035
8005
|
|
|
8036
8006
|
@enable_token_revocation.setter
|
|
@@ -8227,8 +8197,6 @@ class CfnUserPoolClient(
|
|
|
8227
8197
|
|
|
8228
8198
|
Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see `Amazon Cognito and Amazon Pinpoint Region availability <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings>`_ .
|
|
8229
8199
|
|
|
8230
|
-
This data type is a request parameter of ``API_CreateUserPoolClient`` and ``API_UpdateUserPoolClient`` , and a response parameter of ``API_DescribeUserPoolClient`` .
|
|
8231
|
-
|
|
8232
8200
|
:param application_arn: The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ``ApplicationArn`` declares. You can also configure your application to pass an endpoint ID in the ``AnalyticsMetadata`` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications
|
|
8233
8201
|
:param application_id: Your Amazon Pinpoint project ID.
|
|
8234
8202
|
:param external_id: The `external ID <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_ of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
|
|
@@ -8497,17 +8465,17 @@ class CfnUserPoolClientProps:
|
|
|
8497
8465
|
:param client_name: A friendly name for the app client that you want to create.
|
|
8498
8466
|
:param default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces ``redirect_uri`` in authentication requests. Must be in the ``CallbackURLs`` list.
|
|
8499
8467
|
:param enable_propagate_additional_user_context_data: When ``true`` , your application can include additional ``UserContextData`` in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see `Adding session data to API requests <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint>`_ . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
|
|
8500
|
-
:param enable_token_revocation: Activates or deactivates
|
|
8468
|
+
:param enable_token_revocation: Activates or deactivates token revocation. If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
8501
8469
|
:param explicit_auth_flows: The `authentication flows <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html>`_ that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your app client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . The values for authentication flow options include the following. - ``ALLOW_USER_AUTH`` : Enable selection-based sign-in with ``USER_AUTH`` . This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ``ExplicitAuthFlows`` permitting them. For example users can complete an SRP challenge through ``USER_AUTH`` without the flow ``USER_SRP_AUTH`` being active for the app client. This flow doesn't include ``CUSTOM_AUTH`` . To activate this setting, your user pool must be in the `Essentials tier <https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html>`_ or higher. - ``ALLOW_ADMIN_USER_PASSWORD_AUTH`` : Enable admin based user password authentication flow ``ADMIN_USER_PASSWORD_AUTH`` . This setting replaces the ``ADMIN_NO_SRP_AUTH`` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. - ``ALLOW_CUSTOM_AUTH`` : Enable Lambda trigger based authentication. - ``ALLOW_USER_PASSWORD_AUTH`` : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. - ``ALLOW_USER_SRP_AUTH`` : Enable SRP-based authentication. - ``ALLOW_REFRESH_TOKEN_AUTH`` : Enable authflow to refresh tokens. In some environments, you will see the values ``ADMIN_NO_SRP_AUTH`` , ``CUSTOM_AUTH_FLOW_ONLY`` , or ``USER_PASSWORD_AUTH`` . You can't assign these legacy ``ExplicitAuthFlows`` values to user pool clients at the same time as values that begin with ``ALLOW_`` , like ``ALLOW_USER_SRP_AUTH`` .
|
|
8502
8470
|
:param generate_secret: When ``true`` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see `App client types <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types>`_ .
|
|
8503
8471
|
:param id_token_validity: The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for ``IdTokenValidity`` as ``seconds`` , ``minutes`` , ``hours`` , or ``days`` , set a ``TokenValidityUnits`` value in your API request. For example, when you set ``IdTokenValidity`` as ``10`` and ``TokenValidityUnits`` as ``hours`` , your user can authenticate their session with their ID token for 10 hours. The default time unit for ``IdTokenValidity`` in an API request is hours. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
|
|
8504
8472
|
:param logout_ur_ls: A list of allowed logout URLs for managed login authentication. When you pass ``logout_uri`` and ``client_id`` parameters to ``/logout`` , Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of ``logout_uri`` . A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see `Logout endpoint <https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html>`_ .
|
|
8505
8473
|
:param prevent_user_existence_errors: Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ``ENABLED`` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ``LEGACY`` , those APIs return a ``UserNotFoundException`` exception if the user doesn't exist in the user pool. Valid values include: - ``ENABLED`` - This prevents user existence-related errors. - ``LEGACY`` - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented. Defaults to ``LEGACY`` when you don't provide a value.
|
|
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.
|
|
8474
|
+
:param read_attributes: The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. When you don't specify the ``ReadAttributes`` for your app client, your app can read the values of ``email_verified`` , ``phone_number_verified`` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ``ReadAttributes`` doesn't return any information. Amazon Cognito only populates ``ReadAttributes`` in the API response if you have specified your own custom set of read attributes.
|
|
8507
8475
|
:param refresh_token_validity: The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for ``RefreshTokenValidity`` as ``seconds`` , ``minutes`` , ``hours`` , or ``days`` , set a ``TokenValidityUnits`` value in your API request. For example, when you set ``RefreshTokenValidity`` as ``10`` and ``TokenValidityUnits`` as ``days`` , your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for ``RefreshTokenValidity`` in an API request is days. You can't set ``RefreshTokenValidity`` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. *Valid range* is displayed below in seconds. If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
|
|
8508
8476
|
:param supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ``COGNITO`` , ``Facebook`` , ``Google`` , ``SignInWithApple`` , and ``LoginWithAmazon`` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example ``MySAMLIdP`` or ``MyOIDCIdP`` . This parameter sets the IdPs that `managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ will display on the login page for your app client. The removal of ``COGNITO`` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
|
|
8509
8477
|
:param token_validity_units: The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
|
|
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.
|
|
8478
|
+
:param write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. When you don't specify the ``WriteAttributes`` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, ``WriteAttributes`` doesn't return any information. Amazon Cognito only populates ``WriteAttributes`` in the API response if you have specified your own custom set of write attributes. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see `Specifying IdP Attribute Mappings for Your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
|
|
8511
8479
|
|
|
8512
8480
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html
|
|
8513
8481
|
:exampleMetadata: fixture=_generated
|
|
@@ -8784,9 +8752,7 @@ class CfnUserPoolClientProps:
|
|
|
8784
8752
|
def enable_token_revocation(
|
|
8785
8753
|
self,
|
|
8786
8754
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
8787
|
-
'''Activates or deactivates
|
|
8788
|
-
|
|
8789
|
-
Revoke tokens with ``API_RevokeToken`` .
|
|
8755
|
+
'''Activates or deactivates token revocation.
|
|
8790
8756
|
|
|
8791
8757
|
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
8792
8758
|
|
|
@@ -8887,11 +8853,9 @@ class CfnUserPoolClientProps:
|
|
|
8887
8853
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8888
8854
|
'''The list of user attributes that you want your app client to have read access to.
|
|
8889
8855
|
|
|
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.
|
|
8856
|
+
After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information.
|
|
8893
8857
|
|
|
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
|
|
8858
|
+
When you don't specify the ``ReadAttributes`` for your app client, your app can read the values of ``email_verified`` , ``phone_number_verified`` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ``ReadAttributes`` doesn't return any information. Amazon Cognito only populates ``ReadAttributes`` in the API response if you have specified your own custom set of read attributes.
|
|
8895
8859
|
|
|
8896
8860
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes
|
|
8897
8861
|
'''
|
|
@@ -8951,8 +8915,6 @@ class CfnUserPoolClientProps:
|
|
|
8951
8915
|
|
|
8952
8916
|
After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.
|
|
8953
8917
|
|
|
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
8918
|
When you don't specify the ``WriteAttributes`` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, ``WriteAttributes`` doesn't return any information. Amazon Cognito only populates ``WriteAttributes`` in the API response if you have specified your own custom set of write attributes.
|
|
8957
8919
|
|
|
8958
8920
|
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 +8981,7 @@ class CfnUserPoolDomain(
|
|
|
9019
8981
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
9020
8982
|
:param domain: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example ``auth.example.com`` . For prefix domains, this is the prefix alone, such as ``myprefix`` .
|
|
9021
8983
|
: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
|
|
8984
|
+
:param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
|
|
9023
8985
|
:param managed_login_version: A version number that indicates the state of managed login for your domain. Version ``1`` is hosted UI (classic). Version ``2`` is the newer managed login with the branding designer. For more information, see `Managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ .
|
|
9024
8986
|
'''
|
|
9025
8987
|
if __debug__:
|
|
@@ -9119,7 +9081,7 @@ class CfnUserPoolDomain(
|
|
|
9119
9081
|
def custom_domain_config(
|
|
9120
9082
|
self,
|
|
9121
9083
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolDomain.CustomDomainConfigTypeProperty"]]:
|
|
9122
|
-
'''The configuration for a custom domain that hosts
|
|
9084
|
+
'''The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.'''
|
|
9123
9085
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolDomain.CustomDomainConfigTypeProperty"]], jsii.get(self, "customDomainConfig"))
|
|
9124
9086
|
|
|
9125
9087
|
@custom_domain_config.setter
|
|
@@ -9158,8 +9120,6 @@ class CfnUserPoolDomain(
|
|
|
9158
9120
|
) -> None:
|
|
9159
9121
|
'''The configuration for a hosted UI custom domain.
|
|
9160
9122
|
|
|
9161
|
-
This data type is a request parameter of ``API_CreateUserPoolDomain`` and ``API_UpdateUserPoolDomain`` .
|
|
9162
|
-
|
|
9163
9123
|
:param certificate_arn: The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
|
|
9164
9124
|
|
|
9165
9125
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html
|
|
@@ -9228,7 +9188,7 @@ class CfnUserPoolDomainProps:
|
|
|
9228
9188
|
|
|
9229
9189
|
:param domain: The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example ``auth.example.com`` . For prefix domains, this is the prefix alone, such as ``myprefix`` .
|
|
9230
9190
|
: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
|
|
9191
|
+
:param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
|
|
9232
9192
|
:param managed_login_version: A version number that indicates the state of managed login for your domain. Version ``1`` is hosted UI (classic). Version ``2`` is the newer managed login with the branding designer. For more information, see `Managed login <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html>`_ .
|
|
9233
9193
|
|
|
9234
9194
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html
|
|
@@ -9292,14 +9252,12 @@ class CfnUserPoolDomainProps:
|
|
|
9292
9252
|
def custom_domain_config(
|
|
9293
9253
|
self,
|
|
9294
9254
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolDomain.CustomDomainConfigTypeProperty]]:
|
|
9295
|
-
'''The configuration for a custom domain that hosts
|
|
9255
|
+
'''The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
|
|
9296
9256
|
|
|
9297
|
-
|
|
9257
|
+
Use this object to specify an SSL certificate that is managed by ACM.
|
|
9298
9258
|
|
|
9299
9259
|
When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.
|
|
9300
9260
|
|
|
9301
|
-
Update the RP ID in a ``API_SetUserPoolMfaConfig`` request.
|
|
9302
|
-
|
|
9303
9261
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig
|
|
9304
9262
|
'''
|
|
9305
9263
|
result = self._values.get("custom_domain_config")
|
|
@@ -9338,8 +9296,6 @@ class CfnUserPoolGroup(
|
|
|
9338
9296
|
|
|
9339
9297
|
Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.
|
|
9340
9298
|
|
|
9341
|
-
This data type is a response parameter of ``API_AdminListGroupsForUser`` , ``API_CreateGroup`` , ``API_GetGroup`` , ``API_ListGroups`` , and ``API_UpdateGroup`` .
|
|
9342
|
-
|
|
9343
9299
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html
|
|
9344
9300
|
:cloudformationResource: AWS::Cognito::UserPoolGroup
|
|
9345
9301
|
:exampleMetadata: fixture=_generated
|
|
@@ -10077,7 +10033,7 @@ class CfnUserPoolProps:
|
|
|
10077
10033
|
'''Properties for defining a ``CfnUserPool``.
|
|
10078
10034
|
|
|
10079
10035
|
:param account_recovery_setting: The available verified method a user can use to recover their password when they call ``ForgotPassword`` . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
|
|
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.
|
|
10036
|
+
:param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
10081
10037
|
:param alias_attributes: Attributes supported as an alias for this user pool. For more information about alias attributes, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
10082
10038
|
:param auto_verified_attributes: The attributes that you want your user pool to automatically verify. For more information, see `Verifying contact information at sign-up <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves>`_ .
|
|
10083
10039
|
:param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
|
|
@@ -10090,7 +10046,7 @@ class CfnUserPoolProps:
|
|
|
10090
10046
|
:param enabled_mfas: Set enabled MFA options on a specified user pool. To disable all MFAs after it has been enabled, set ``MfaConfiguration`` to ``OFF`` and remove EnabledMfas. MFAs can only be all disabled if ``MfaConfiguration`` is ``OFF`` . After you enable ``SMS_MFA`` , you can only disable it by setting ``MfaConfiguration`` to ``OFF`` . Can be one of the following values: - ``SMS_MFA`` - Enables MFA with SMS for the user pool. To select this option, you must also provide values for ``SmsConfiguration`` . - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. - ``EMAIL_OTP`` - Enables MFA with email for the user pool. To select this option, you must provide values for ``EmailConfiguration`` and within those, set ``EmailSendingAccount`` to ``DEVELOPER`` . Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA`` | ``EMAIL_OTP``
|
|
10091
10047
|
:param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
|
|
10092
10048
|
:param mfa_configuration: Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ``ON`` , all users must set up MFA before they can sign in. When ``OPTIONAL`` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose ``OPTIONAL`` . When ``MfaConfiguration`` is ``OPTIONAL`` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
|
|
10093
|
-
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
10049
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
10094
10050
|
:param schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see `Working with user attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html>`_ .
|
|
10095
10051
|
:param sms_authentication_message: The contents of the SMS authentication message.
|
|
10096
10052
|
:param sms_configuration: The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see `SMS message settings <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html>`_ .
|
|
@@ -10354,8 +10310,6 @@ class CfnUserPoolProps:
|
|
|
10354
10310
|
|
|
10355
10311
|
Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
10356
10312
|
|
|
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
10313
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
|
|
10360
10314
|
'''
|
|
10361
10315
|
result = self._values.get("admin_create_user_config")
|
|
@@ -10511,9 +10465,9 @@ class CfnUserPoolProps:
|
|
|
10511
10465
|
def policies(
|
|
10512
10466
|
self,
|
|
10513
10467
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.PoliciesProperty]]:
|
|
10514
|
-
'''A list of user pool policies.
|
|
10468
|
+
'''A list of user pool policies.
|
|
10515
10469
|
|
|
10516
|
-
|
|
10470
|
+
Contains the policy that sets password-complexity requirements.
|
|
10517
10471
|
|
|
10518
10472
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
|
|
10519
10473
|
'''
|
|
@@ -10874,8 +10828,6 @@ class CfnUserPoolResourceServer(
|
|
|
10874
10828
|
|
|
10875
10829
|
This data type is a member of ``ResourceServerScopeType`` . For more information, see `Scopes, M2M, and API authorization with resource servers <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html>`_ .
|
|
10876
10830
|
|
|
10877
|
-
This data type is a request parameter of ``API_CreateResourceServer`` and a response parameter of ``API_DescribeResourceServer`` .
|
|
10878
|
-
|
|
10879
10831
|
:param scope_description: A friendly description of a custom scope.
|
|
10880
10832
|
:param scope_name: The name of the scope. Amazon Cognito renders custom scopes in the format ``resourceServerIdentifier/ScopeName`` . For example, if this parameter is ``exampleScope`` in the resource server with the identifier ``exampleResourceServer`` , you request and receive the scope ``exampleResourceServer/exampleScope`` .
|
|
10881
10833
|
|
|
@@ -11305,9 +11257,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11305
11257
|
) -> None:
|
|
11306
11258
|
'''The automated response to a risk level for adaptive authentication in full-function, or ``ENFORCED`` , mode.
|
|
11307
11259
|
|
|
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`` .
|
|
11260
|
+
You can assign an action to each risk level that advanced security features evaluates.
|
|
11311
11261
|
|
|
11312
11262
|
:param event_action: The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows: - ``BLOCK`` : Block the request. - ``MFA_IF_CONFIGURED`` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request. - ``MFA_REQUIRED`` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor. - ``NO_ACTION`` : Take no action. Permit sign-in.
|
|
11313
11263
|
:param notify: Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
|
|
@@ -11390,9 +11340,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11390
11340
|
low_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11391
11341
|
medium_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11392
11342
|
) -> 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`` .
|
|
11343
|
+
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
11396
11344
|
|
|
11397
11345
|
:param high_action: The action that you assign to a high-risk assessment by threat protection.
|
|
11398
11346
|
:param low_action: The action that you assign to a low-risk assessment by threat protection.
|
|
@@ -11494,9 +11442,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11494
11442
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
11495
11443
|
notify_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11496
11444
|
) -> 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`` .
|
|
11445
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
11500
11446
|
|
|
11501
11447
|
:param actions: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection.
|
|
11502
11448
|
:param notify_configuration: The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
|
|
@@ -11610,9 +11556,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11610
11556
|
)
|
|
11611
11557
|
class CompromisedCredentialsActionsTypeProperty:
|
|
11612
11558
|
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`` .
|
|
11559
|
+
'''Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ``ENFORCED`` mode.
|
|
11616
11560
|
|
|
11617
11561
|
:param event_action: The action that Amazon Cognito takes when it detects compromised credentials.
|
|
11618
11562
|
|
|
@@ -11669,9 +11613,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11669
11613
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
11670
11614
|
event_filter: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
11671
11615
|
) -> 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`` .
|
|
11616
|
+
'''Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function ``ENFORCED`` mode.
|
|
11675
11617
|
|
|
11676
11618
|
:param actions: Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
|
|
11677
11619
|
:param event_filter: Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.
|
|
@@ -11761,9 +11703,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11761
11703
|
no_action_email: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11762
11704
|
reply_to: typing.Optional[builtins.str] = None,
|
|
11763
11705
|
) -> 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`` .
|
|
11706
|
+
'''The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a *Notify* action.
|
|
11767
11707
|
|
|
11768
11708
|
:param source_arn: The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the ``From`` parameter.
|
|
11769
11709
|
:param block_email: The template for the email message that your user pool sends when a detected risk event is blocked.
|
|
@@ -11925,9 +11865,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
11925
11865
|
html_body: typing.Optional[builtins.str] = None,
|
|
11926
11866
|
text_body: typing.Optional[builtins.str] = None,
|
|
11927
11867
|
) -> 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`` .
|
|
11868
|
+
'''The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
|
|
11931
11869
|
|
|
11932
11870
|
:param subject: The subject of the threat protection email notification.
|
|
11933
11871
|
:param html_body: The body of an email notification formatted in HTML. Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
|
|
@@ -12023,8 +11961,6 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
12023
11961
|
) -> None:
|
|
12024
11962
|
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
12025
11963
|
|
|
12026
|
-
This data type is a request parameter of ``API_SetRiskConfiguration`` and a response parameter of ``API_DescribeRiskConfiguration`` .
|
|
12027
|
-
|
|
12028
11964
|
:param blocked_ip_range_list: An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
|
|
12029
11965
|
:param skipped_ip_range_list: An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
|
|
12030
11966
|
|
|
@@ -12282,8 +12218,6 @@ class CfnUserPoolUICustomizationAttachment(
|
|
|
12282
12218
|
):
|
|
12283
12219
|
'''A container for the UI customization information for the hosted UI in a user pool.
|
|
12284
12220
|
|
|
12285
|
-
This data type is a response parameter of ``API_DescribeUserPoolClient`` .
|
|
12286
|
-
|
|
12287
12221
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html
|
|
12288
12222
|
:cloudformationResource: AWS::Cognito::UserPoolUICustomizationAttachment
|
|
12289
12223
|
:exampleMetadata: fixture=_generated
|
|
@@ -12559,7 +12493,7 @@ class CfnUserPoolUser(
|
|
|
12559
12493
|
:param desired_delivery_mediums: Specify ``EMAIL`` if email will be used to send the welcome message. Specify ``SMS`` if the phone number will be used. The default value is ``SMS`` . You can specify more than one value.
|
|
12560
12494
|
:param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the ``UserAttributes`` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
|
|
12561
12495
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
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``
|
|
12496
|
+
:param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12563
12497
|
:param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
12564
12498
|
:param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
|
|
12565
12499
|
'''
|
|
@@ -12756,8 +12690,6 @@ class CfnUserPoolUser(
|
|
|
12756
12690
|
) -> None:
|
|
12757
12691
|
'''The name and value of a user attribute.
|
|
12758
12692
|
|
|
12759
|
-
This data type is a request parameter of ``API_AdminUpdateUserAttributes`` and ``API_UpdateUserAttributes`` .
|
|
12760
|
-
|
|
12761
12693
|
:param name: The name of the attribute.
|
|
12762
12694
|
:param value: The value of the attribute.
|
|
12763
12695
|
|
|
@@ -12849,7 +12781,7 @@ class CfnUserPoolUserProps:
|
|
|
12849
12781
|
:param desired_delivery_mediums: Specify ``EMAIL`` if email will be used to send the welcome message. Specify ``SMS`` if the phone number will be used. The default value is ``SMS`` . You can specify more than one value.
|
|
12850
12782
|
:param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the ``UserAttributes`` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
|
|
12851
12783
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
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``
|
|
12784
|
+
:param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12853
12785
|
:param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
12854
12786
|
:param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
|
|
12855
12787
|
|
|
@@ -12996,12 +12928,10 @@ class CfnUserPoolUserProps:
|
|
|
12996
12928
|
|
|
12997
12929
|
You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` .
|
|
12998
12930
|
|
|
12999
|
-
In your ``AdminCreateUser``
|
|
12931
|
+
In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` .
|
|
13000
12932
|
|
|
13001
|
-
-
|
|
13002
|
-
-
|
|
13003
|
-
|
|
13004
|
-
You can also set attributes verified with ``API_AdminUpdateUserAttributes`` .
|
|
12933
|
+
- *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12934
|
+
- *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
13005
12935
|
|
|
13006
12936
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes
|
|
13007
12937
|
'''
|
|
@@ -13998,12 +13928,14 @@ class IUserPool(_IResource_c80c4260, typing_extensions.Protocol):
|
|
|
13998
13928
|
*,
|
|
13999
13929
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14000
13930
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
13931
|
+
managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
|
|
14001
13932
|
) -> "UserPoolDomain":
|
|
14002
13933
|
'''Associate a domain to this user pool.
|
|
14003
13934
|
|
|
14004
13935
|
:param id: -
|
|
14005
13936
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
14006
13937
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
13938
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
14007
13939
|
|
|
14008
13940
|
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
|
|
14009
13941
|
'''
|
|
@@ -14185,12 +14117,14 @@ class _IUserPoolProxy(
|
|
|
14185
14117
|
*,
|
|
14186
14118
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14187
14119
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
14120
|
+
managed_login_version: typing.Optional["ManagedLoginVersion"] = None,
|
|
14188
14121
|
) -> "UserPoolDomain":
|
|
14189
14122
|
'''Associate a domain to this user pool.
|
|
14190
14123
|
|
|
14191
14124
|
:param id: -
|
|
14192
14125
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
14193
14126
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
14127
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
14194
14128
|
|
|
14195
14129
|
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html
|
|
14196
14130
|
'''
|
|
@@ -14198,7 +14132,9 @@ class _IUserPoolProxy(
|
|
|
14198
14132
|
type_hints = typing.get_type_hints(_typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e7b1a458)
|
|
14199
14133
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
14200
14134
|
options = UserPoolDomainOptions(
|
|
14201
|
-
cognito_domain=cognito_domain,
|
|
14135
|
+
cognito_domain=cognito_domain,
|
|
14136
|
+
custom_domain=custom_domain,
|
|
14137
|
+
managed_login_version=managed_login_version,
|
|
14202
14138
|
)
|
|
14203
14139
|
|
|
14204
14140
|
return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
|
|
@@ -14589,6 +14525,39 @@ class LambdaVersion(enum.Enum):
|
|
|
14589
14525
|
'''
|
|
14590
14526
|
|
|
14591
14527
|
|
|
14528
|
+
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.ManagedLoginVersion")
|
|
14529
|
+
class ManagedLoginVersion(enum.Enum):
|
|
14530
|
+
'''The branding version of managed login for the domain.
|
|
14531
|
+
|
|
14532
|
+
:exampleMetadata: infused
|
|
14533
|
+
|
|
14534
|
+
Example::
|
|
14535
|
+
|
|
14536
|
+
pool = cognito.UserPool(self, "Pool")
|
|
14537
|
+
|
|
14538
|
+
# Use the new managed login page
|
|
14539
|
+
pool.add_domain("CognitoDomainWithBlandingDesignManagedLogin",
|
|
14540
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
14541
|
+
domain_prefix="blanding-design-ui"
|
|
14542
|
+
),
|
|
14543
|
+
managed_login_version=cognito.ManagedLoginVersion.NEWER_MANAGED_LOGIN
|
|
14544
|
+
)
|
|
14545
|
+
|
|
14546
|
+
# Use the classic hosted UI
|
|
14547
|
+
pool.add_domain("DomainWithClassicHostedUi",
|
|
14548
|
+
cognito_domain=cognito.CognitoDomainOptions(
|
|
14549
|
+
domain_prefix="classic-hosted-ui"
|
|
14550
|
+
),
|
|
14551
|
+
managed_login_version=cognito.ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
14552
|
+
)
|
|
14553
|
+
'''
|
|
14554
|
+
|
|
14555
|
+
CLASSIC_HOSTED_UI = "CLASSIC_HOSTED_UI"
|
|
14556
|
+
'''The classic hosted UI.'''
|
|
14557
|
+
NEWER_MANAGED_LOGIN = "NEWER_MANAGED_LOGIN"
|
|
14558
|
+
'''The newer managed login with the branding designer.'''
|
|
14559
|
+
|
|
14560
|
+
|
|
14592
14561
|
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.Mfa")
|
|
14593
14562
|
class Mfa(enum.Enum):
|
|
14594
14563
|
'''The different ways in which a user pool's MFA enforcement can be configured.
|
|
@@ -17450,18 +17419,22 @@ class UserPool(
|
|
|
17450
17419
|
*,
|
|
17451
17420
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17452
17421
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17422
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
17453
17423
|
) -> "UserPoolDomain":
|
|
17454
17424
|
'''Associate a domain to this user pool.
|
|
17455
17425
|
|
|
17456
17426
|
:param id: -
|
|
17457
17427
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
17458
17428
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
17429
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
17459
17430
|
'''
|
|
17460
17431
|
if __debug__:
|
|
17461
17432
|
type_hints = typing.get_type_hints(_typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2d48a103)
|
|
17462
17433
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
17463
17434
|
options = UserPoolDomainOptions(
|
|
17464
|
-
cognito_domain=cognito_domain,
|
|
17435
|
+
cognito_domain=cognito_domain,
|
|
17436
|
+
custom_domain=custom_domain,
|
|
17437
|
+
managed_login_version=managed_login_version,
|
|
17465
17438
|
)
|
|
17466
17439
|
|
|
17467
17440
|
return typing.cast("UserPoolDomain", jsii.invoke(self, "addDomain", [id, options]))
|
|
@@ -18514,6 +18487,7 @@ class UserPoolDomain(
|
|
|
18514
18487
|
user_pool: IUserPool,
|
|
18515
18488
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18516
18489
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18490
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18517
18491
|
) -> None:
|
|
18518
18492
|
'''
|
|
18519
18493
|
:param scope: -
|
|
@@ -18521,6 +18495,7 @@ class UserPoolDomain(
|
|
|
18521
18495
|
:param user_pool: The user pool to which this domain should be associated.
|
|
18522
18496
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
18523
18497
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
18498
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18524
18499
|
'''
|
|
18525
18500
|
if __debug__:
|
|
18526
18501
|
type_hints = typing.get_type_hints(_typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94152b471)
|
|
@@ -18530,6 +18505,7 @@ class UserPoolDomain(
|
|
|
18530
18505
|
user_pool=user_pool,
|
|
18531
18506
|
cognito_domain=cognito_domain,
|
|
18532
18507
|
custom_domain=custom_domain,
|
|
18508
|
+
managed_login_version=managed_login_version,
|
|
18533
18509
|
)
|
|
18534
18510
|
|
|
18535
18511
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -18623,7 +18599,11 @@ class UserPoolDomain(
|
|
|
18623
18599
|
@jsii.data_type(
|
|
18624
18600
|
jsii_type="aws-cdk-lib.aws_cognito.UserPoolDomainOptions",
|
|
18625
18601
|
jsii_struct_bases=[],
|
|
18626
|
-
name_mapping={
|
|
18602
|
+
name_mapping={
|
|
18603
|
+
"cognito_domain": "cognitoDomain",
|
|
18604
|
+
"custom_domain": "customDomain",
|
|
18605
|
+
"managed_login_version": "managedLoginVersion",
|
|
18606
|
+
},
|
|
18627
18607
|
)
|
|
18628
18608
|
class UserPoolDomainOptions:
|
|
18629
18609
|
def __init__(
|
|
@@ -18631,11 +18611,13 @@ class UserPoolDomainOptions:
|
|
|
18631
18611
|
*,
|
|
18632
18612
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18633
18613
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18614
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18634
18615
|
) -> None:
|
|
18635
18616
|
'''Options to create a UserPoolDomain.
|
|
18636
18617
|
|
|
18637
18618
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
18638
18619
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
18620
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18639
18621
|
|
|
18640
18622
|
:exampleMetadata: infused
|
|
18641
18623
|
|
|
@@ -18667,11 +18649,14 @@ class UserPoolDomainOptions:
|
|
|
18667
18649
|
type_hints = typing.get_type_hints(_typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af679070c0)
|
|
18668
18650
|
check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
|
|
18669
18651
|
check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
|
|
18652
|
+
check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
|
|
18670
18653
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
18671
18654
|
if cognito_domain is not None:
|
|
18672
18655
|
self._values["cognito_domain"] = cognito_domain
|
|
18673
18656
|
if custom_domain is not None:
|
|
18674
18657
|
self._values["custom_domain"] = custom_domain
|
|
18658
|
+
if managed_login_version is not None:
|
|
18659
|
+
self._values["managed_login_version"] = managed_login_version
|
|
18675
18660
|
|
|
18676
18661
|
@builtins.property
|
|
18677
18662
|
def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
|
|
@@ -18695,6 +18680,19 @@ class UserPoolDomainOptions:
|
|
|
18695
18680
|
result = self._values.get("custom_domain")
|
|
18696
18681
|
return typing.cast(typing.Optional[CustomDomainOptions], result)
|
|
18697
18682
|
|
|
18683
|
+
@builtins.property
|
|
18684
|
+
def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
|
|
18685
|
+
'''A version that indicates the state of managed login.
|
|
18686
|
+
|
|
18687
|
+
This choice applies to all app clients that host services at the domain.
|
|
18688
|
+
|
|
18689
|
+
:default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18690
|
+
|
|
18691
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
|
|
18692
|
+
'''
|
|
18693
|
+
result = self._values.get("managed_login_version")
|
|
18694
|
+
return typing.cast(typing.Optional[ManagedLoginVersion], result)
|
|
18695
|
+
|
|
18698
18696
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
18699
18697
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
18700
18698
|
|
|
@@ -18713,6 +18711,7 @@ class UserPoolDomainOptions:
|
|
|
18713
18711
|
name_mapping={
|
|
18714
18712
|
"cognito_domain": "cognitoDomain",
|
|
18715
18713
|
"custom_domain": "customDomain",
|
|
18714
|
+
"managed_login_version": "managedLoginVersion",
|
|
18716
18715
|
"user_pool": "userPool",
|
|
18717
18716
|
},
|
|
18718
18717
|
)
|
|
@@ -18722,12 +18721,14 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18722
18721
|
*,
|
|
18723
18722
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18724
18723
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
18724
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
18725
18725
|
user_pool: IUserPool,
|
|
18726
18726
|
) -> None:
|
|
18727
18727
|
'''Props for UserPoolDomain construct.
|
|
18728
18728
|
|
|
18729
18729
|
:param cognito_domain: Associate a cognito prefix domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``customDomain`` is specified, otherwise, throws an error.
|
|
18730
18730
|
:param custom_domain: Associate a custom domain with your user pool Either ``customDomain`` or ``cognitoDomain`` must be specified. Default: - not set if ``cognitoDomain`` is specified, otherwise, throws an error.
|
|
18731
|
+
:param managed_login_version: A version that indicates the state of managed login. This choice applies to all app clients that host services at the domain. Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18731
18732
|
:param user_pool: The user pool to which this domain should be associated.
|
|
18732
18733
|
|
|
18733
18734
|
:exampleMetadata: infused
|
|
@@ -18800,6 +18801,7 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18800
18801
|
type_hints = typing.get_type_hints(_typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c34f7baa)
|
|
18801
18802
|
check_type(argname="argument cognito_domain", value=cognito_domain, expected_type=type_hints["cognito_domain"])
|
|
18802
18803
|
check_type(argname="argument custom_domain", value=custom_domain, expected_type=type_hints["custom_domain"])
|
|
18804
|
+
check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
|
|
18803
18805
|
check_type(argname="argument user_pool", value=user_pool, expected_type=type_hints["user_pool"])
|
|
18804
18806
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
18805
18807
|
"user_pool": user_pool,
|
|
@@ -18808,6 +18810,8 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18808
18810
|
self._values["cognito_domain"] = cognito_domain
|
|
18809
18811
|
if custom_domain is not None:
|
|
18810
18812
|
self._values["custom_domain"] = custom_domain
|
|
18813
|
+
if managed_login_version is not None:
|
|
18814
|
+
self._values["managed_login_version"] = managed_login_version
|
|
18811
18815
|
|
|
18812
18816
|
@builtins.property
|
|
18813
18817
|
def cognito_domain(self) -> typing.Optional[CognitoDomainOptions]:
|
|
@@ -18831,6 +18835,19 @@ class UserPoolDomainProps(UserPoolDomainOptions):
|
|
|
18831
18835
|
result = self._values.get("custom_domain")
|
|
18832
18836
|
return typing.cast(typing.Optional[CustomDomainOptions], result)
|
|
18833
18837
|
|
|
18838
|
+
@builtins.property
|
|
18839
|
+
def managed_login_version(self) -> typing.Optional[ManagedLoginVersion]:
|
|
18840
|
+
'''A version that indicates the state of managed login.
|
|
18841
|
+
|
|
18842
|
+
This choice applies to all app clients that host services at the domain.
|
|
18843
|
+
|
|
18844
|
+
:default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI
|
|
18845
|
+
|
|
18846
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
|
|
18847
|
+
'''
|
|
18848
|
+
result = self._values.get("managed_login_version")
|
|
18849
|
+
return typing.cast(typing.Optional[ManagedLoginVersion], result)
|
|
18850
|
+
|
|
18834
18851
|
@builtins.property
|
|
18835
18852
|
def user_pool(self) -> IUserPool:
|
|
18836
18853
|
'''The user pool to which this domain should be associated.'''
|
|
@@ -22933,6 +22950,7 @@ __all__ = [
|
|
|
22933
22950
|
"IUserPoolResourceServer",
|
|
22934
22951
|
"KeepOriginalAttrs",
|
|
22935
22952
|
"LambdaVersion",
|
|
22953
|
+
"ManagedLoginVersion",
|
|
22936
22954
|
"Mfa",
|
|
22937
22955
|
"MfaSecondFactor",
|
|
22938
22956
|
"NumberAttribute",
|
|
@@ -24860,6 +24878,7 @@ def _typecheckingstub__792921e0d9eecd6253eadd31c7fba82fdce9c0ba38f25dcba7dcd063e
|
|
|
24860
24878
|
*,
|
|
24861
24879
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24862
24880
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24881
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
24863
24882
|
) -> None:
|
|
24864
24883
|
"""Type checking stubs"""
|
|
24865
24884
|
pass
|
|
@@ -25180,6 +25199,7 @@ def _typecheckingstub__f9659a33214c6a8f47e5cc02aec61f89c8bd48113d0c9b3e32a81fef2
|
|
|
25180
25199
|
*,
|
|
25181
25200
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25182
25201
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25202
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25183
25203
|
) -> None:
|
|
25184
25204
|
"""Type checking stubs"""
|
|
25185
25205
|
pass
|
|
@@ -25314,6 +25334,7 @@ def _typecheckingstub__370554f0c705ae872638d9d90d00b13abf8230d3666aa0d882b882f94
|
|
|
25314
25334
|
user_pool: IUserPool,
|
|
25315
25335
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25316
25336
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25337
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25317
25338
|
) -> None:
|
|
25318
25339
|
"""Type checking stubs"""
|
|
25319
25340
|
pass
|
|
@@ -25340,6 +25361,7 @@ def _typecheckingstub__4a5105d96e2071a7239518797c0a84f12539bde7c8fda8d40c7b23af6
|
|
|
25340
25361
|
*,
|
|
25341
25362
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25342
25363
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25364
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25343
25365
|
) -> None:
|
|
25344
25366
|
"""Type checking stubs"""
|
|
25345
25367
|
pass
|
|
@@ -25348,6 +25370,7 @@ def _typecheckingstub__4336d5dce146abd75b1697dd55937affe308b1524f218d9eb3835531c
|
|
|
25348
25370
|
*,
|
|
25349
25371
|
cognito_domain: typing.Optional[typing.Union[CognitoDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25350
25372
|
custom_domain: typing.Optional[typing.Union[CustomDomainOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25373
|
+
managed_login_version: typing.Optional[ManagedLoginVersion] = None,
|
|
25351
25374
|
user_pool: IUserPool,
|
|
25352
25375
|
) -> None:
|
|
25353
25376
|
"""Type checking stubs"""
|