aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__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 +57 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.172.0.jsii.tgz → aws-cdk-lib@2.173.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +111 -64
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_autoscaling/__init__.py +15 -6
- aws_cdk/aws_bedrock/__init__.py +32 -44
- aws_cdk/aws_chatbot/__init__.py +72 -46
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudfront/__init__.py +4 -2
- aws_cdk/aws_cloudtrail/__init__.py +104 -68
- aws_cdk/aws_cloudwatch/__init__.py +51 -14
- aws_cdk/aws_codebuild/__init__.py +39 -0
- aws_cdk/aws_codepipeline/__init__.py +4 -4
- aws_cdk/aws_cognito/__init__.py +221 -53
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +25 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +130 -48
- aws_cdk/aws_ecs/__init__.py +25 -13
- aws_cdk/aws_eks/__init__.py +86 -24
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +138 -128
- aws_cdk/aws_events/__init__.py +39 -26
- aws_cdk/aws_fsx/__init__.py +134 -10
- aws_cdk/aws_imagebuilder/__init__.py +8 -8
- aws_cdk/aws_invoicing/__init__.py +651 -0
- aws_cdk/aws_iot/__init__.py +28 -22
- aws_cdk/aws_iotfleetwise/__init__.py +473 -332
- aws_cdk/aws_iotsitewise/__init__.py +6 -4
- aws_cdk/aws_ivs/__init__.py +43 -31
- aws_cdk/aws_kendra/__init__.py +4 -0
- aws_cdk/aws_lakeformation/__init__.py +2 -1
- aws_cdk/aws_lambda/__init__.py +258 -156
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +15 -15
- aws_cdk/aws_mediaconnect/__init__.py +24 -14
- aws_cdk/aws_medialive/__init__.py +2359 -5
- aws_cdk/aws_mediapackage/__init__.py +3 -9
- aws_cdk/aws_mediapackagev2/__init__.py +19 -17
- aws_cdk/aws_memorydb/__init__.py +664 -4
- aws_cdk/aws_qbusiness/__init__.py +2018 -66
- aws_cdk/aws_rds/__init__.py +30 -0
- aws_cdk/aws_resourcegroups/__init__.py +26 -17
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +224 -100
- aws_cdk/aws_route53resolver/__init__.py +4 -2
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +30 -19
- aws_cdk/aws_sagemaker/__init__.py +783 -9
- aws_cdk/aws_secretsmanager/__init__.py +20 -6
- aws_cdk/aws_securityhub/__init__.py +64 -32
- aws_cdk/aws_servicediscovery/__init__.py +43 -0
- aws_cdk/aws_ses/__init__.py +109 -0
- aws_cdk/aws_stepfunctions_tasks/__init__.py +190 -35
- aws_cdk/aws_synthetics/__init__.py +7 -5
- aws_cdk/aws_vpclattice/__init__.py +1479 -122
- aws_cdk/aws_wisdom/__init__.py +2698 -232
- aws_cdk/aws_workspacesweb/__init__.py +118 -61
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -20,6 +20,7 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw
|
|
|
20
20
|
* [Table of Contents](#table-of-contents)
|
|
21
21
|
* [User Pools](#user-pools)
|
|
22
22
|
|
|
23
|
+
* [User pool feature plans](#user-pool-feature-plans)
|
|
23
24
|
* [Sign Up](#sign-up)
|
|
24
25
|
|
|
25
26
|
* [Code Verification](#code-verification)
|
|
@@ -80,6 +81,20 @@ role = iam.Role(self, "role",
|
|
|
80
81
|
user_pool.grant(role, "cognito-idp:AdminCreateUser")
|
|
81
82
|
```
|
|
82
83
|
|
|
84
|
+
### User pool feature plans
|
|
85
|
+
|
|
86
|
+
Amazon Cognito has feature plans for user pools. Each plan has a set of features and a monthly cost per active user. Each feature plan unlocks access to more features than the one before it.
|
|
87
|
+
Lean more aboug [feature plans here](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html).
|
|
88
|
+
|
|
89
|
+
* *Lite* - a low-cost feature plan for user pools with lower numbers of monthly active users.
|
|
90
|
+
* *Essentials* - all of the latest user pool authentication features.
|
|
91
|
+
* *Plus* - includes everything in the Essentials plan and adds advanced security features that protect your users.
|
|
92
|
+
|
|
93
|
+
The default feature plan is Essentials for newly create user pools.
|
|
94
|
+
For the existing user pools, Lite plan is automatically set.
|
|
95
|
+
|
|
96
|
+
Previously, some user pool features were included in [an advanced security features](#advanced-security-mode) pricing structure. The features that were included in this structure are now under either the Essentials or Plus plan.
|
|
97
|
+
|
|
83
98
|
### Sign Up
|
|
84
99
|
|
|
85
100
|
Users can either be signed up by the app's administrators or can sign themselves up. Once a user has signed up, their
|
|
@@ -311,8 +326,8 @@ configure an MFA token and use it for sign in. It also allows for the users to u
|
|
|
311
326
|
[time-based one time password
|
|
312
327
|
(TOTP)](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html).
|
|
313
328
|
|
|
314
|
-
If you want to enable email-based MFA, set `email` propety to the Amazon SES email-sending configuration and set `
|
|
315
|
-
For more information, see [
|
|
329
|
+
If you want to enable email-based MFA, set `email` propety to the Amazon SES email-sending configuration and set `featurePlan` to `FeaturePlan.ESSENTIALS` or `FeaturePlan.PLUS`.
|
|
330
|
+
For more information, see [SMS and email message MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-sms-email-message.html).
|
|
316
331
|
|
|
317
332
|
```python
|
|
318
333
|
cognito.UserPool(self, "myuserpool",
|
|
@@ -368,6 +383,8 @@ A user will not be allowed to reset their password via phone if they are also us
|
|
|
368
383
|
|
|
369
384
|
#### Advanced Security Mode
|
|
370
385
|
|
|
386
|
+
⚠️ Advanced Security Mode is deprecated in favor of [user pool feature plans](#user-pool-feature-plans).
|
|
387
|
+
|
|
371
388
|
User pools can be configured to use Advanced security. You can turn the user pool advanced security features on, and customize the actions that are taken in response to different risks. Or you can use audit mode to gather metrics on detected risks without taking action. In audit mode, the advanced security features publish metrics to Amazon CloudWatch. See the [documentation on Advanced security](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) to learn more.
|
|
372
389
|
|
|
373
390
|
```python
|
|
@@ -1153,9 +1170,12 @@ class AccountRecovery(enum.Enum):
|
|
|
1153
1170
|
|
|
1154
1171
|
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.AdvancedSecurityMode")
|
|
1155
1172
|
class AdvancedSecurityMode(enum.Enum):
|
|
1156
|
-
'''The different ways in which a user pool's Advanced Security Mode can be configured.
|
|
1173
|
+
'''(deprecated) The different ways in which a user pool's Advanced Security Mode can be configured.
|
|
1174
|
+
|
|
1175
|
+
:deprecated: Advanced Security Mode is deprecated in favor of user pool feature plans.
|
|
1157
1176
|
|
|
1158
1177
|
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode
|
|
1178
|
+
:stability: deprecated
|
|
1159
1179
|
:exampleMetadata: infused
|
|
1160
1180
|
|
|
1161
1181
|
Example::
|
|
@@ -1167,14 +1187,22 @@ class AdvancedSecurityMode(enum.Enum):
|
|
|
1167
1187
|
'''
|
|
1168
1188
|
|
|
1169
1189
|
ENFORCED = "ENFORCED"
|
|
1170
|
-
'''Enable advanced security mode.
|
|
1190
|
+
'''(deprecated) Enable advanced security mode.
|
|
1191
|
+
|
|
1192
|
+
:stability: deprecated
|
|
1193
|
+
'''
|
|
1171
1194
|
AUDIT = "AUDIT"
|
|
1172
|
-
'''gather metrics on detected risks without taking action.
|
|
1195
|
+
'''(deprecated) gather metrics on detected risks without taking action.
|
|
1173
1196
|
|
|
1174
1197
|
Metrics are published to Amazon CloudWatch
|
|
1198
|
+
|
|
1199
|
+
:stability: deprecated
|
|
1175
1200
|
'''
|
|
1176
1201
|
OFF = "OFF"
|
|
1177
|
-
'''Advanced security mode is disabled.
|
|
1202
|
+
'''(deprecated) Advanced security mode is disabled.
|
|
1203
|
+
|
|
1204
|
+
:stability: deprecated
|
|
1205
|
+
'''
|
|
1178
1206
|
|
|
1179
1207
|
|
|
1180
1208
|
@jsii.data_type(
|
|
@@ -3999,7 +4027,22 @@ class CfnManagedLoginBranding(
|
|
|
3999
4027
|
metaclass=jsii.JSIIMeta,
|
|
4000
4028
|
jsii_type="aws-cdk-lib.aws_cognito.CfnManagedLoginBranding",
|
|
4001
4029
|
):
|
|
4002
|
-
'''
|
|
4030
|
+
'''Creates a new set of branding settings for a user pool style and associates it with an app client.
|
|
4031
|
+
|
|
4032
|
+
This operation is the programmatic option for the creation of a new style in the branding designer.
|
|
4033
|
+
|
|
4034
|
+
Provides values for UI customization in a ``Settings`` JSON object and image files in an ``Assets`` array. To send the JSON object ``Document`` type parameter in ``Settings`` , you might need to update to the most recent version of your AWS SDK.
|
|
4035
|
+
|
|
4036
|
+
This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
|
|
4037
|
+
|
|
4038
|
+
As a best practice, modify the output of `DescribeManagedLoginBrandingByClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html>`_ into the request parameters for this operation. To get all settings, set ``ReturnMergedResources`` to ``true`` . For more information, see `API and SDK operations for managed login branding <https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api>`_
|
|
4039
|
+
.. epigraph::
|
|
4040
|
+
|
|
4041
|
+
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
|
|
4042
|
+
|
|
4043
|
+
**Learn more** - `Signing AWS API Requests <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html>`_
|
|
4044
|
+
|
|
4045
|
+
- `Using the Amazon Cognito user pools API and user pool endpoints <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html>`_
|
|
4003
4046
|
|
|
4004
4047
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html
|
|
4005
4048
|
:cloudformationResource: AWS::Cognito::ManagedLoginBranding
|
|
@@ -4048,12 +4091,12 @@ class CfnManagedLoginBranding(
|
|
|
4048
4091
|
'''
|
|
4049
4092
|
:param scope: Scope in which this resource is defined.
|
|
4050
4093
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4051
|
-
:param user_pool_id:
|
|
4052
|
-
:param assets:
|
|
4094
|
+
:param user_pool_id: The user pool where the branding style is assigned.
|
|
4095
|
+
:param assets: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
|
|
4053
4096
|
:param client_id:
|
|
4054
4097
|
:param return_merged_resources:
|
|
4055
|
-
:param settings:
|
|
4056
|
-
:param use_cognito_provided_values:
|
|
4098
|
+
:param settings: A JSON file, encoded as a ``Document`` type, with the the settings that you want to apply to your style.
|
|
4099
|
+
:param use_cognito_provided_values: When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer.
|
|
4057
4100
|
'''
|
|
4058
4101
|
if __debug__:
|
|
4059
4102
|
type_hints = typing.get_type_hints(_typecheckingstub__478f8899894ffccc3f20b06ae18c36beb41bf5c5c9aa65a99dbdbf95ce00be03)
|
|
@@ -4103,7 +4146,8 @@ class CfnManagedLoginBranding(
|
|
|
4103
4146
|
@builtins.property
|
|
4104
4147
|
@jsii.member(jsii_name="attrManagedLoginBrandingId")
|
|
4105
4148
|
def attr_managed_login_branding_id(self) -> builtins.str:
|
|
4106
|
-
'''
|
|
4149
|
+
'''The ID of the managed login branding style.
|
|
4150
|
+
|
|
4107
4151
|
:cloudformationAttribute: ManagedLoginBrandingId
|
|
4108
4152
|
'''
|
|
4109
4153
|
return typing.cast(builtins.str, jsii.get(self, "attrManagedLoginBrandingId"))
|
|
@@ -4116,6 +4160,7 @@ class CfnManagedLoginBranding(
|
|
|
4116
4160
|
@builtins.property
|
|
4117
4161
|
@jsii.member(jsii_name="userPoolId")
|
|
4118
4162
|
def user_pool_id(self) -> builtins.str:
|
|
4163
|
+
'''The user pool where the branding style is assigned.'''
|
|
4119
4164
|
return typing.cast(builtins.str, jsii.get(self, "userPoolId"))
|
|
4120
4165
|
|
|
4121
4166
|
@user_pool_id.setter
|
|
@@ -4130,6 +4175,7 @@ class CfnManagedLoginBranding(
|
|
|
4130
4175
|
def assets(
|
|
4131
4176
|
self,
|
|
4132
4177
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnManagedLoginBranding.AssetTypeProperty"]]]]:
|
|
4178
|
+
'''An array of image files that you want to apply to roles like backgrounds, logos, and icons.'''
|
|
4133
4179
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnManagedLoginBranding.AssetTypeProperty"]]]], jsii.get(self, "assets"))
|
|
4134
4180
|
|
|
4135
4181
|
@assets.setter
|
|
@@ -4174,6 +4220,7 @@ class CfnManagedLoginBranding(
|
|
|
4174
4220
|
@builtins.property
|
|
4175
4221
|
@jsii.member(jsii_name="settings")
|
|
4176
4222
|
def settings(self) -> typing.Any:
|
|
4223
|
+
'''A JSON file, encoded as a ``Document`` type, with the the settings that you want to apply to your style.'''
|
|
4177
4224
|
return typing.cast(typing.Any, jsii.get(self, "settings"))
|
|
4178
4225
|
|
|
4179
4226
|
@settings.setter
|
|
@@ -4188,6 +4235,7 @@ class CfnManagedLoginBranding(
|
|
|
4188
4235
|
def use_cognito_provided_values(
|
|
4189
4236
|
self,
|
|
4190
4237
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4238
|
+
'''When true, applies the default branding style options.'''
|
|
4191
4239
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "useCognitoProvidedValues"))
|
|
4192
4240
|
|
|
4193
4241
|
@use_cognito_provided_values.setter
|
|
@@ -4221,12 +4269,15 @@ class CfnManagedLoginBranding(
|
|
|
4221
4269
|
bytes: typing.Optional[builtins.str] = None,
|
|
4222
4270
|
resource_id: typing.Optional[builtins.str] = None,
|
|
4223
4271
|
) -> None:
|
|
4224
|
-
'''
|
|
4225
|
-
|
|
4226
|
-
|
|
4227
|
-
|
|
4228
|
-
:param
|
|
4229
|
-
:param
|
|
4272
|
+
'''An image file from a managed login branding style in a user pool.
|
|
4273
|
+
|
|
4274
|
+
This data type is a request parameter of `CreateManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html>`_ and `UpdateManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html>`_ , and a response parameter of `DescribeManagedLoginBranding <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html>`_ .
|
|
4275
|
+
|
|
4276
|
+
: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.
|
|
4277
|
+
: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.
|
|
4278
|
+
:param extension: The file type of the image file.
|
|
4279
|
+
:param bytes: The image file, in Base64-encoded binary.
|
|
4280
|
+
:param resource_id: The ID of the asset.
|
|
4230
4281
|
|
|
4231
4282
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html
|
|
4232
4283
|
:exampleMetadata: fixture=_generated
|
|
@@ -4266,7 +4317,10 @@ class CfnManagedLoginBranding(
|
|
|
4266
4317
|
|
|
4267
4318
|
@builtins.property
|
|
4268
4319
|
def category(self) -> builtins.str:
|
|
4269
|
-
'''
|
|
4320
|
+
'''The category that the image corresponds to in your managed login configuration.
|
|
4321
|
+
|
|
4322
|
+
Managed login has asset categories for different types of logos, backgrounds, and icons.
|
|
4323
|
+
|
|
4270
4324
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-category
|
|
4271
4325
|
'''
|
|
4272
4326
|
result = self._values.get("category")
|
|
@@ -4275,7 +4329,10 @@ class CfnManagedLoginBranding(
|
|
|
4275
4329
|
|
|
4276
4330
|
@builtins.property
|
|
4277
4331
|
def color_mode(self) -> builtins.str:
|
|
4278
|
-
'''
|
|
4332
|
+
'''The display-mode target of the asset: light, dark, or browser-adaptive.
|
|
4333
|
+
|
|
4334
|
+
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.
|
|
4335
|
+
|
|
4279
4336
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-colormode
|
|
4280
4337
|
'''
|
|
4281
4338
|
result = self._values.get("color_mode")
|
|
@@ -4284,7 +4341,8 @@ class CfnManagedLoginBranding(
|
|
|
4284
4341
|
|
|
4285
4342
|
@builtins.property
|
|
4286
4343
|
def extension(self) -> builtins.str:
|
|
4287
|
-
'''
|
|
4344
|
+
'''The file type of the image file.
|
|
4345
|
+
|
|
4288
4346
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-extension
|
|
4289
4347
|
'''
|
|
4290
4348
|
result = self._values.get("extension")
|
|
@@ -4293,7 +4351,8 @@ class CfnManagedLoginBranding(
|
|
|
4293
4351
|
|
|
4294
4352
|
@builtins.property
|
|
4295
4353
|
def bytes(self) -> typing.Optional[builtins.str]:
|
|
4296
|
-
'''
|
|
4354
|
+
'''The image file, in Base64-encoded binary.
|
|
4355
|
+
|
|
4297
4356
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-bytes
|
|
4298
4357
|
'''
|
|
4299
4358
|
result = self._values.get("bytes")
|
|
@@ -4301,7 +4360,8 @@ class CfnManagedLoginBranding(
|
|
|
4301
4360
|
|
|
4302
4361
|
@builtins.property
|
|
4303
4362
|
def resource_id(self) -> typing.Optional[builtins.str]:
|
|
4304
|
-
'''
|
|
4363
|
+
'''The ID of the asset.
|
|
4364
|
+
|
|
4305
4365
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-resourceid
|
|
4306
4366
|
'''
|
|
4307
4367
|
result = self._values.get("resource_id")
|
|
@@ -4344,12 +4404,12 @@ class CfnManagedLoginBrandingProps:
|
|
|
4344
4404
|
) -> None:
|
|
4345
4405
|
'''Properties for defining a ``CfnManagedLoginBranding``.
|
|
4346
4406
|
|
|
4347
|
-
:param user_pool_id:
|
|
4348
|
-
:param assets:
|
|
4407
|
+
:param user_pool_id: The user pool where the branding style is assigned.
|
|
4408
|
+
:param assets: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
|
|
4349
4409
|
:param client_id:
|
|
4350
4410
|
:param return_merged_resources:
|
|
4351
|
-
:param settings:
|
|
4352
|
-
:param use_cognito_provided_values:
|
|
4411
|
+
:param settings: A JSON file, encoded as a ``Document`` type, with the the settings that you want to apply to your style.
|
|
4412
|
+
:param use_cognito_provided_values: When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer.
|
|
4353
4413
|
|
|
4354
4414
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html
|
|
4355
4415
|
:exampleMetadata: fixture=_generated
|
|
@@ -4405,7 +4465,8 @@ class CfnManagedLoginBrandingProps:
|
|
|
4405
4465
|
|
|
4406
4466
|
@builtins.property
|
|
4407
4467
|
def user_pool_id(self) -> builtins.str:
|
|
4408
|
-
'''
|
|
4468
|
+
'''The user pool where the branding style is assigned.
|
|
4469
|
+
|
|
4409
4470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-userpoolid
|
|
4410
4471
|
'''
|
|
4411
4472
|
result = self._values.get("user_pool_id")
|
|
@@ -4416,7 +4477,10 @@ class CfnManagedLoginBrandingProps:
|
|
|
4416
4477
|
def assets(
|
|
4417
4478
|
self,
|
|
4418
4479
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnManagedLoginBranding.AssetTypeProperty]]]]:
|
|
4419
|
-
'''
|
|
4480
|
+
'''An array of image files that you want to apply to roles like backgrounds, logos, and icons.
|
|
4481
|
+
|
|
4482
|
+
Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
|
|
4483
|
+
|
|
4420
4484
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-assets
|
|
4421
4485
|
'''
|
|
4422
4486
|
result = self._values.get("assets")
|
|
@@ -4442,7 +4506,8 @@ class CfnManagedLoginBrandingProps:
|
|
|
4442
4506
|
|
|
4443
4507
|
@builtins.property
|
|
4444
4508
|
def settings(self) -> typing.Any:
|
|
4445
|
-
'''
|
|
4509
|
+
'''A JSON file, encoded as a ``Document`` type, with the the settings that you want to apply to your style.
|
|
4510
|
+
|
|
4446
4511
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-settings
|
|
4447
4512
|
'''
|
|
4448
4513
|
result = self._values.get("settings")
|
|
@@ -4452,7 +4517,10 @@ class CfnManagedLoginBrandingProps:
|
|
|
4452
4517
|
def use_cognito_provided_values(
|
|
4453
4518
|
self,
|
|
4454
4519
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4455
|
-
'''
|
|
4520
|
+
'''When true, applies the default branding style options.
|
|
4521
|
+
|
|
4522
|
+
This option reverts to a "blank" style that you can modify later in the branding designer.
|
|
4523
|
+
|
|
4456
4524
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-usecognitoprovidedvalues
|
|
4457
4525
|
'''
|
|
4458
4526
|
result = self._values.get("use_cognito_provided_values")
|
|
@@ -4684,7 +4752,7 @@ class CfnUserPool(
|
|
|
4684
4752
|
:param user_pool_add_ons: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to risky traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ .
|
|
4685
4753
|
:param user_pool_name: A string used to name the user pool.
|
|
4686
4754
|
:param user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
|
|
4687
|
-
:param user_pool_tier:
|
|
4755
|
+
:param user_pool_tier: The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .
|
|
4688
4756
|
:param verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your ``DefaultEmailOption`` selection. For ``CONFIRM_WITH_LINK`` , specify an ``EmailMessageByLink`` and leave ``EmailMessage`` blank. For ``CONFIRM_WITH_CODE`` , specify an ``EmailMessage`` and leave ``EmailMessageByLink`` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
|
|
4689
4757
|
:param web_authn_relying_party_id:
|
|
4690
4758
|
:param web_authn_user_verification:
|
|
@@ -5206,6 +5274,7 @@ class CfnUserPool(
|
|
|
5206
5274
|
@builtins.property
|
|
5207
5275
|
@jsii.member(jsii_name="userPoolTier")
|
|
5208
5276
|
def user_pool_tier(self) -> typing.Optional[builtins.str]:
|
|
5277
|
+
'''The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .'''
|
|
5209
5278
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "userPoolTier"))
|
|
5210
5279
|
|
|
5211
5280
|
@user_pool_tier.setter
|
|
@@ -5345,7 +5414,7 @@ class CfnUserPool(
|
|
|
5345
5414
|
This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
|
|
5346
5415
|
|
|
5347
5416
|
:param allow_admin_create_user_only: The setting for allowing self-service sign-up. When ``true`` , only administrators can create new user profiles. When ``false`` , users can register themselves and create a new user profile with the `SignUp <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html>`_ operation.
|
|
5348
|
-
:param invite_message_template: The template for the welcome message to new users. 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>`_ .
|
|
5417
|
+
: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>`_ .
|
|
5349
5418
|
:param unused_account_validity_days: This parameter is no longer in use. Configure the duration of temporary passwords with the ``TemporaryPasswordValidityDays`` parameter of `PasswordPolicyType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_PasswordPolicyType.html>`_ . For older user pools that have a ``UnusedAccountValidityDays`` configuration, that value is effective until you set a value for ``TemporaryPasswordValidityDays`` . The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call ``AdminCreateUser`` again, specifying ``RESEND`` for the ``MessageAction`` parameter. The default value for this parameter is 7.
|
|
5350
5419
|
|
|
5351
5420
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
|
|
@@ -5399,6 +5468,8 @@ class CfnUserPool(
|
|
|
5399
5468
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.InviteMessageTemplateProperty"]]:
|
|
5400
5469
|
'''The template for the welcome message to new users.
|
|
5401
5470
|
|
|
5471
|
+
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.
|
|
5472
|
+
|
|
5402
5473
|
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>`_ .
|
|
5403
5474
|
|
|
5404
5475
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate
|
|
@@ -5899,6 +5970,8 @@ class CfnUserPool(
|
|
|
5899
5970
|
) -> None:
|
|
5900
5971
|
'''The template for the welcome message to new users.
|
|
5901
5972
|
|
|
5973
|
+
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.
|
|
5974
|
+
|
|
5902
5975
|
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>`_ .
|
|
5903
5976
|
|
|
5904
5977
|
:param email_message: The message template for email messages. EmailMessage is allowed only if `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is DEVELOPER.
|
|
@@ -7664,16 +7737,16 @@ class CfnUserPoolClient(
|
|
|
7664
7737
|
:param callback_ur_ls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. See `OAuth 2.0 - Redirection Endpoint <https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
|
|
7665
7738
|
:param client_name: The client name for the user pool client you would like to create.
|
|
7666
7739
|
: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. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. For more information, see `Default redirect URI <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
|
|
7667
|
-
:param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-
|
|
7740
|
+
:param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
|
|
7668
7741
|
:param enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ . If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
7669
|
-
:param explicit_auth_flows: The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``ALLOW_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`` .
|
|
7742
|
+
:param explicit_auth_flows: The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``ALLOW_USER_AUTH`` : Enable selection-based sign-in with ``USER_AUTH`` . This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ``ExplicitAuthFlows`` permitting them. For example users can complete an SRP challenge through ``USER_AUTH`` without the flow ``USER_SRP_AUTH`` being active for the app client. This flow doesn't include ``CUSTOM_AUTH`` . - ``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`` .
|
|
7670
7743
|
:param generate_secret: Boolean to specify whether you want to generate a secret for the user pool client being created.
|
|
7671
7744
|
: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.
|
|
7672
7745
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
7673
7746
|
: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.
|
|
7674
7747
|
:param read_attributes: The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a `GetUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html>`_ API request to retrieve and display your user's profile data. When you don't specify the ``ReadAttributes`` for your app client, your app can read the values of ``email_verified`` , ``phone_number_verified`` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ``ReadAttributes`` doesn't return any information. Amazon Cognito only populates ``ReadAttributes`` in the API response if you have specified your own custom set of read attributes.
|
|
7675
7748
|
: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.
|
|
7676
|
-
: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`` .
|
|
7749
|
+
:param supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ``COGNITO`` , ``Facebook`` , ``Google`` , ``SignInWithApple`` , and ``LoginWithAmazon`` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example ``MySAMLIdP`` or ``MyOIDCIdP`` . This setting applies to providers that you can access with the `hosted UI and OAuth 2.0 authorization server <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html>`_ . The removal of ``COGNITO`` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
|
|
7677
7750
|
:param token_validity_units: The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
|
|
7678
7751
|
:param write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ API request and sets ``family_name`` to the new value. When you don't specify the ``WriteAttributes`` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, ``WriteAttributes`` doesn't return any information. Amazon Cognito only populates ``WriteAttributes`` in the API response if you have specified your own custom set of write attributes. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see `Specifying IdP Attribute Mappings for Your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
|
|
7679
7752
|
'''
|
|
@@ -8406,16 +8479,16 @@ class CfnUserPoolClientProps:
|
|
|
8406
8479
|
:param callback_ur_ls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. See `OAuth 2.0 - Redirection Endpoint <https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
|
|
8407
8480
|
:param client_name: The client name for the user pool client you would like to create.
|
|
8408
8481
|
: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. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. For more information, see `Default redirect URI <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about>`_ . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
|
|
8409
|
-
:param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-
|
|
8482
|
+
:param enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
|
|
8410
8483
|
:param enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ . If you don't include this parameter, token revocation is automatically activated for the new user pool client.
|
|
8411
|
-
:param explicit_auth_flows: The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``ALLOW_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`` .
|
|
8484
|
+
:param explicit_auth_flows: The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` . Valid values include: - ``ALLOW_USER_AUTH`` : Enable selection-based sign-in with ``USER_AUTH`` . This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ``ExplicitAuthFlows`` permitting them. For example users can complete an SRP challenge through ``USER_AUTH`` without the flow ``USER_SRP_AUTH`` being active for the app client. This flow doesn't include ``CUSTOM_AUTH`` . - ``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`` .
|
|
8412
8485
|
:param generate_secret: Boolean to specify whether you want to generate a secret for the user pool client being created.
|
|
8413
8486
|
: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.
|
|
8414
8487
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
8415
8488
|
: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.
|
|
8416
8489
|
:param read_attributes: The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a `GetUser <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html>`_ API request to retrieve and display your user's profile data. When you don't specify the ``ReadAttributes`` for your app client, your app can read the values of ``email_verified`` , ``phone_number_verified`` , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ``ReadAttributes`` doesn't return any information. Amazon Cognito only populates ``ReadAttributes`` in the API response if you have specified your own custom set of read attributes.
|
|
8417
8490
|
: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.
|
|
8418
|
-
: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`` .
|
|
8491
|
+
:param supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ``COGNITO`` , ``Facebook`` , ``Google`` , ``SignInWithApple`` , and ``LoginWithAmazon`` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example ``MySAMLIdP`` or ``MyOIDCIdP`` . This setting applies to providers that you can access with the `hosted UI and OAuth 2.0 authorization server <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html>`_ . The removal of ``COGNITO`` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
|
|
8419
8492
|
:param token_validity_units: The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
|
|
8420
8493
|
:param write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ API request and sets ``family_name`` to the new value. When you don't specify the ``WriteAttributes`` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, ``WriteAttributes`` doesn't return any information. Amazon Cognito only populates ``WriteAttributes`` in the API response if you have specified your own custom set of write attributes. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see `Specifying IdP Attribute Mappings for Your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html>`_ .
|
|
8421
8494
|
|
|
@@ -8695,7 +8768,7 @@ class CfnUserPoolClientProps:
|
|
|
8695
8768
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
8696
8769
|
'''Activates the propagation of additional user context data.
|
|
8697
8770
|
|
|
8698
|
-
For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-
|
|
8771
|
+
For more information about propagation of user context data, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`_ . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate ``EnablePropagateAdditionalUserContextData`` in an app client that has a client secret.
|
|
8699
8772
|
|
|
8700
8773
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-enablepropagateadditionalusercontextdata
|
|
8701
8774
|
'''
|
|
@@ -8726,6 +8799,7 @@ class CfnUserPoolClientProps:
|
|
|
8726
8799
|
|
|
8727
8800
|
Valid values include:
|
|
8728
8801
|
|
|
8802
|
+
- ``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`` .
|
|
8729
8803
|
- ``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.
|
|
8730
8804
|
- ``ALLOW_CUSTOM_AUTH`` : Enable Lambda trigger based authentication.
|
|
8731
8805
|
- ``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.
|
|
@@ -8836,6 +8910,8 @@ class CfnUserPoolClientProps:
|
|
|
8836
8910
|
|
|
8837
8911
|
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`` .
|
|
8838
8912
|
|
|
8913
|
+
This setting applies to providers that you can access with the `hosted UI and OAuth 2.0 authorization server <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html>`_ . The removal of ``COGNITO`` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a `AWS WAF rule <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html>`_ .
|
|
8914
|
+
|
|
8839
8915
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders
|
|
8840
8916
|
'''
|
|
8841
8917
|
result = self._values.get("supported_identity_providers")
|
|
@@ -8906,7 +8982,8 @@ class CfnUserPoolDomain(
|
|
|
8906
8982
|
# the properties below are optional
|
|
8907
8983
|
custom_domain_config=cognito.CfnUserPoolDomain.CustomDomainConfigTypeProperty(
|
|
8908
8984
|
certificate_arn="certificateArn"
|
|
8909
|
-
)
|
|
8985
|
+
),
|
|
8986
|
+
managed_login_version=123
|
|
8910
8987
|
)
|
|
8911
8988
|
'''
|
|
8912
8989
|
|
|
@@ -8918,13 +8995,15 @@ class CfnUserPoolDomain(
|
|
|
8918
8995
|
domain: builtins.str,
|
|
8919
8996
|
user_pool_id: builtins.str,
|
|
8920
8997
|
custom_domain_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolDomain.CustomDomainConfigTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8998
|
+
managed_login_version: typing.Optional[jsii.Number] = None,
|
|
8921
8999
|
) -> None:
|
|
8922
9000
|
'''
|
|
8923
9001
|
:param scope: Scope in which this resource is defined.
|
|
8924
9002
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
8925
9003
|
:param domain: The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be ``auth.example.com`` . This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
|
|
8926
9004
|
:param user_pool_id: The ID of the user pool that is associated with the custom domain whose certificate you're updating.
|
|
8927
|
-
: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.
|
|
9005
|
+
:param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
|
|
9006
|
+
: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>`_ .
|
|
8928
9007
|
'''
|
|
8929
9008
|
if __debug__:
|
|
8930
9009
|
type_hints = typing.get_type_hints(_typecheckingstub__6e0b36c4d155cfdfa9801e3f221c4fe6c5403bf24a64d17bd90fb5386301d675)
|
|
@@ -8934,6 +9013,7 @@ class CfnUserPoolDomain(
|
|
|
8934
9013
|
domain=domain,
|
|
8935
9014
|
user_pool_id=user_pool_id,
|
|
8936
9015
|
custom_domain_config=custom_domain_config,
|
|
9016
|
+
managed_login_version=managed_login_version,
|
|
8937
9017
|
)
|
|
8938
9018
|
|
|
8939
9019
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -9035,6 +9115,19 @@ class CfnUserPoolDomain(
|
|
|
9035
9115
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
9036
9116
|
jsii.set(self, "customDomainConfig", value) # pyright: ignore[reportArgumentType]
|
|
9037
9117
|
|
|
9118
|
+
@builtins.property
|
|
9119
|
+
@jsii.member(jsii_name="managedLoginVersion")
|
|
9120
|
+
def managed_login_version(self) -> typing.Optional[jsii.Number]:
|
|
9121
|
+
'''A version number that indicates the state of managed login for your domain.'''
|
|
9122
|
+
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "managedLoginVersion"))
|
|
9123
|
+
|
|
9124
|
+
@managed_login_version.setter
|
|
9125
|
+
def managed_login_version(self, value: typing.Optional[jsii.Number]) -> None:
|
|
9126
|
+
if __debug__:
|
|
9127
|
+
type_hints = typing.get_type_hints(_typecheckingstub__b1d6e8e96816f3572291ff67691b98d76a166cf058320e0e73e58062b8093526)
|
|
9128
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
9129
|
+
jsii.set(self, "managedLoginVersion", value) # pyright: ignore[reportArgumentType]
|
|
9130
|
+
|
|
9038
9131
|
@jsii.data_type(
|
|
9039
9132
|
jsii_type="aws-cdk-lib.aws_cognito.CfnUserPoolDomain.CustomDomainConfigTypeProperty",
|
|
9040
9133
|
jsii_struct_bases=[],
|
|
@@ -9102,6 +9195,7 @@ class CfnUserPoolDomain(
|
|
|
9102
9195
|
"domain": "domain",
|
|
9103
9196
|
"user_pool_id": "userPoolId",
|
|
9104
9197
|
"custom_domain_config": "customDomainConfig",
|
|
9198
|
+
"managed_login_version": "managedLoginVersion",
|
|
9105
9199
|
},
|
|
9106
9200
|
)
|
|
9107
9201
|
class CfnUserPoolDomainProps:
|
|
@@ -9111,12 +9205,14 @@ class CfnUserPoolDomainProps:
|
|
|
9111
9205
|
domain: builtins.str,
|
|
9112
9206
|
user_pool_id: builtins.str,
|
|
9113
9207
|
custom_domain_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPoolDomain.CustomDomainConfigTypeProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
9208
|
+
managed_login_version: typing.Optional[jsii.Number] = None,
|
|
9114
9209
|
) -> None:
|
|
9115
9210
|
'''Properties for defining a ``CfnUserPoolDomain``.
|
|
9116
9211
|
|
|
9117
9212
|
:param domain: The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be ``auth.example.com`` . This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
|
|
9118
9213
|
:param user_pool_id: The ID of the user pool that is associated with the custom domain whose certificate you're updating.
|
|
9119
|
-
: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.
|
|
9214
|
+
:param custom_domain_config: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
|
|
9215
|
+
: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>`_ .
|
|
9120
9216
|
|
|
9121
9217
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html
|
|
9122
9218
|
:exampleMetadata: fixture=_generated
|
|
@@ -9134,7 +9230,8 @@ class CfnUserPoolDomainProps:
|
|
|
9134
9230
|
# the properties below are optional
|
|
9135
9231
|
custom_domain_config=cognito.CfnUserPoolDomain.CustomDomainConfigTypeProperty(
|
|
9136
9232
|
certificate_arn="certificateArn"
|
|
9137
|
-
)
|
|
9233
|
+
),
|
|
9234
|
+
managed_login_version=123
|
|
9138
9235
|
)
|
|
9139
9236
|
'''
|
|
9140
9237
|
if __debug__:
|
|
@@ -9142,12 +9239,15 @@ class CfnUserPoolDomainProps:
|
|
|
9142
9239
|
check_type(argname="argument domain", value=domain, expected_type=type_hints["domain"])
|
|
9143
9240
|
check_type(argname="argument user_pool_id", value=user_pool_id, expected_type=type_hints["user_pool_id"])
|
|
9144
9241
|
check_type(argname="argument custom_domain_config", value=custom_domain_config, expected_type=type_hints["custom_domain_config"])
|
|
9242
|
+
check_type(argname="argument managed_login_version", value=managed_login_version, expected_type=type_hints["managed_login_version"])
|
|
9145
9243
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
9146
9244
|
"domain": domain,
|
|
9147
9245
|
"user_pool_id": user_pool_id,
|
|
9148
9246
|
}
|
|
9149
9247
|
if custom_domain_config is not None:
|
|
9150
9248
|
self._values["custom_domain_config"] = custom_domain_config
|
|
9249
|
+
if managed_login_version is not None:
|
|
9250
|
+
self._values["managed_login_version"] = managed_login_version
|
|
9151
9251
|
|
|
9152
9252
|
@builtins.property
|
|
9153
9253
|
def domain(self) -> builtins.str:
|
|
@@ -9181,11 +9281,24 @@ class CfnUserPoolDomainProps:
|
|
|
9181
9281
|
|
|
9182
9282
|
Use this object to specify an SSL certificate that is managed by ACM.
|
|
9183
9283
|
|
|
9284
|
+
When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a `SetUserPoolMfaConfig <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html>`_ request.
|
|
9285
|
+
|
|
9184
9286
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig
|
|
9185
9287
|
'''
|
|
9186
9288
|
result = self._values.get("custom_domain_config")
|
|
9187
9289
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolDomain.CustomDomainConfigTypeProperty]], result)
|
|
9188
9290
|
|
|
9291
|
+
@builtins.property
|
|
9292
|
+
def managed_login_version(self) -> typing.Optional[jsii.Number]:
|
|
9293
|
+
'''A version number that indicates the state of managed login for your domain.
|
|
9294
|
+
|
|
9295
|
+
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>`_ .
|
|
9296
|
+
|
|
9297
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-managedloginversion
|
|
9298
|
+
'''
|
|
9299
|
+
result = self._values.get("managed_login_version")
|
|
9300
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
|
9301
|
+
|
|
9189
9302
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
9190
9303
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
9191
9304
|
|
|
@@ -9961,7 +10074,7 @@ class CfnUserPoolProps:
|
|
|
9961
10074
|
:param user_pool_add_ons: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to ``AUDIT`` . To configure automatic security responses to risky traffic to your user pool, set to ``ENFORCED`` . For more information, see `Adding advanced security to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ .
|
|
9962
10075
|
:param user_pool_name: A string used to name the user pool.
|
|
9963
10076
|
:param user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
|
|
9964
|
-
:param user_pool_tier:
|
|
10077
|
+
:param user_pool_tier: The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .
|
|
9965
10078
|
:param verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your ``DefaultEmailOption`` selection. For ``CONFIRM_WITH_LINK`` , specify an ``EmailMessageByLink`` and leave ``EmailMessage`` blank. For ``CONFIRM_WITH_CODE`` , specify an ``EmailMessage`` and leave ``EmailMessageByLink`` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
|
|
9966
10079
|
:param web_authn_relying_party_id:
|
|
9967
10080
|
:param web_authn_user_verification:
|
|
@@ -10502,7 +10615,8 @@ class CfnUserPoolProps:
|
|
|
10502
10615
|
|
|
10503
10616
|
@builtins.property
|
|
10504
10617
|
def user_pool_tier(self) -> typing.Optional[builtins.str]:
|
|
10505
|
-
'''
|
|
10618
|
+
'''The user pool `feature plan <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html>`_ , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ``ESSENTIALS`` .
|
|
10619
|
+
|
|
10506
10620
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier
|
|
10507
10621
|
'''
|
|
10508
10622
|
result = self._values.get("user_pool_tier")
|
|
@@ -12406,7 +12520,7 @@ class CfnUserPoolUser(
|
|
|
12406
12520
|
: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.
|
|
12407
12521
|
: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, the API call will migrate 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`` .
|
|
12408
12522
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
12409
|
-
: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. In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12523
|
+
:param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12410
12524
|
: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>`_ .
|
|
12411
12525
|
:param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
|
|
12412
12526
|
'''
|
|
@@ -12696,7 +12810,7 @@ class CfnUserPoolUserProps:
|
|
|
12696
12810
|
: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.
|
|
12697
12811
|
: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, the API call will migrate 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`` .
|
|
12698
12812
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
12699
|
-
: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. In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12813
|
+
:param user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to ``AdminCreateUser`` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a ``TemporaryPassword`` . In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ . - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
12700
12814
|
: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>`_ .
|
|
12701
12815
|
:param validation_data: Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain. Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network. For more information about the pre sign-up Lambda trigger, see `Pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ .
|
|
12702
12816
|
|
|
@@ -12841,6 +12955,8 @@ class CfnUserPoolUserProps:
|
|
|
12841
12955
|
|
|
12842
12956
|
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.
|
|
12843
12957
|
|
|
12958
|
+
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`` .
|
|
12959
|
+
|
|
12844
12960
|
In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . You can also do this by calling `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .
|
|
12845
12961
|
|
|
12846
12962
|
- *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.
|
|
@@ -13714,6 +13830,21 @@ class EmailSettings:
|
|
|
13714
13830
|
)
|
|
13715
13831
|
|
|
13716
13832
|
|
|
13833
|
+
@jsii.enum(jsii_type="aws-cdk-lib.aws_cognito.FeaturePlan")
|
|
13834
|
+
class FeaturePlan(enum.Enum):
|
|
13835
|
+
'''The user pool feature plan, or tier.
|
|
13836
|
+
|
|
13837
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
|
|
13838
|
+
'''
|
|
13839
|
+
|
|
13840
|
+
LITE = "LITE"
|
|
13841
|
+
'''Lite feature plan.'''
|
|
13842
|
+
ESSENTIALS = "ESSENTIALS"
|
|
13843
|
+
'''Essentials feature plan.'''
|
|
13844
|
+
PLUS = "PLUS"
|
|
13845
|
+
'''Plus feature plan.'''
|
|
13846
|
+
|
|
13847
|
+
|
|
13717
13848
|
@jsii.interface(jsii_type="aws-cdk-lib.aws_cognito.ICustomAttribute")
|
|
13718
13849
|
class ICustomAttribute(typing_extensions.Protocol):
|
|
13719
13850
|
'''Represents a custom attribute type.'''
|
|
@@ -14462,7 +14593,7 @@ class MfaSecondFactor:
|
|
|
14462
14593
|
|
|
14463
14594
|
:param otp: The MFA token is a time-based one time password that is generated by a hardware or software token. Default: false
|
|
14464
14595
|
:param sms: The MFA token is sent to the user via SMS to their verified phone numbers. Default: true
|
|
14465
|
-
:param email: The MFA token is sent to the user via EMAIL. To enable email-based MFA, set ``email`` property to the Amazon SES email-sending configuration and set ``
|
|
14596
|
+
:param email: The MFA token is sent to the user via EMAIL. To enable email-based MFA, set ``email`` property to the Amazon SES email-sending configuration and set ``feturePlan`` to ``FeaturePlan.ESSENTIALS`` or ``FeaturePlan.PLUS`` Default: false
|
|
14466
14597
|
|
|
14467
14598
|
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html
|
|
14468
14599
|
:exampleMetadata: infused
|
|
@@ -14520,7 +14651,7 @@ class MfaSecondFactor:
|
|
|
14520
14651
|
'''The MFA token is sent to the user via EMAIL.
|
|
14521
14652
|
|
|
14522
14653
|
To enable email-based MFA, set ``email`` property to the Amazon SES email-sending configuration
|
|
14523
|
-
and set ``
|
|
14654
|
+
and set ``feturePlan`` to ``FeaturePlan.ESSENTIALS`` or ``FeaturePlan.PLUS``
|
|
14524
14655
|
|
|
14525
14656
|
:default: false
|
|
14526
14657
|
|
|
@@ -17080,6 +17211,7 @@ class UserPool(
|
|
|
17080
17211
|
device_tracking: typing.Optional[typing.Union[DeviceTracking, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17081
17212
|
email: typing.Optional["UserPoolEmail"] = None,
|
|
17082
17213
|
enable_sms_role: typing.Optional[builtins.bool] = None,
|
|
17214
|
+
feature_plan: typing.Optional[FeaturePlan] = None,
|
|
17083
17215
|
keep_original: typing.Optional[typing.Union[KeepOriginalAttrs, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17084
17216
|
lambda_triggers: typing.Optional[typing.Union["UserPoolTriggers", typing.Dict[builtins.str, typing.Any]]] = None,
|
|
17085
17217
|
mfa: typing.Optional[Mfa] = None,
|
|
@@ -17102,7 +17234,7 @@ class UserPool(
|
|
|
17102
17234
|
:param scope: -
|
|
17103
17235
|
:param id: -
|
|
17104
17236
|
:param account_recovery: How will a user be able to recover their account? Default: AccountRecovery.PHONE_WITHOUT_MFA_AND_EMAIL
|
|
17105
|
-
:param advanced_security_mode: The user pool's Advanced Security Mode. Default: - no value
|
|
17237
|
+
:param advanced_security_mode: (deprecated) The user pool's Advanced Security Mode. Default: - no value
|
|
17106
17238
|
:param auto_verify: Attributes which Cognito will look to verify automatically upon user sign up. EMAIL and PHONE are the only available options. Default: - If ``signInAlias`` includes email and/or phone, they will be included in ``autoVerifiedAttributes`` by default. If absent, no attributes will be auto-verified.
|
|
17107
17239
|
:param custom_attributes: Define a set of custom attributes that can be configured for each user in the user pool. Default: - No custom attributes.
|
|
17108
17240
|
:param custom_sender_kms_key: This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates. Default: - no key ID configured
|
|
@@ -17110,6 +17242,7 @@ class UserPool(
|
|
|
17110
17242
|
:param device_tracking: Device tracking settings. Default: - see defaults on each property of DeviceTracking.
|
|
17111
17243
|
:param email: Email settings for a user pool. Default: - cognito will use the default email configuration
|
|
17112
17244
|
:param enable_sms_role: Setting this would explicitly enable or disable SMS role creation. When left unspecified, CDK will determine based on other properties if a role is needed or not. Default: - CDK will determine based on other properties of the user pool if an SMS role should be created or not.
|
|
17245
|
+
:param feature_plan: The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Default: - FeaturePlan.ESSENTIALS for a newly created user pool; FeaturePlan.LITE otherwise
|
|
17113
17246
|
:param keep_original: Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes. EMAIL and PHONE are the only available options. Default: - Nothing is kept.
|
|
17114
17247
|
:param lambda_triggers: Lambda functions to use for supported Cognito triggers. Default: - No Lambda triggers.
|
|
17115
17248
|
:param mfa: Configure whether users of this user pool can or are required use MFA to sign in. Default: Mfa.OFF
|
|
@@ -17142,6 +17275,7 @@ class UserPool(
|
|
|
17142
17275
|
device_tracking=device_tracking,
|
|
17143
17276
|
email=email,
|
|
17144
17277
|
enable_sms_role=enable_sms_role,
|
|
17278
|
+
feature_plan=feature_plan,
|
|
17145
17279
|
keep_original=keep_original,
|
|
17146
17280
|
lambda_triggers=lambda_triggers,
|
|
17147
17281
|
mfa=mfa,
|
|
@@ -20385,6 +20519,7 @@ class UserPoolOperation(
|
|
|
20385
20519
|
"device_tracking": "deviceTracking",
|
|
20386
20520
|
"email": "email",
|
|
20387
20521
|
"enable_sms_role": "enableSmsRole",
|
|
20522
|
+
"feature_plan": "featurePlan",
|
|
20388
20523
|
"keep_original": "keepOriginal",
|
|
20389
20524
|
"lambda_triggers": "lambdaTriggers",
|
|
20390
20525
|
"mfa": "mfa",
|
|
@@ -20417,6 +20552,7 @@ class UserPoolProps:
|
|
|
20417
20552
|
device_tracking: typing.Optional[typing.Union[DeviceTracking, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20418
20553
|
email: typing.Optional[UserPoolEmail] = None,
|
|
20419
20554
|
enable_sms_role: typing.Optional[builtins.bool] = None,
|
|
20555
|
+
feature_plan: typing.Optional[FeaturePlan] = None,
|
|
20420
20556
|
keep_original: typing.Optional[typing.Union[KeepOriginalAttrs, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20421
20557
|
lambda_triggers: typing.Optional[typing.Union["UserPoolTriggers", typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20422
20558
|
mfa: typing.Optional[Mfa] = None,
|
|
@@ -20438,7 +20574,7 @@ class UserPoolProps:
|
|
|
20438
20574
|
'''Props for the UserPool construct.
|
|
20439
20575
|
|
|
20440
20576
|
:param account_recovery: How will a user be able to recover their account? Default: AccountRecovery.PHONE_WITHOUT_MFA_AND_EMAIL
|
|
20441
|
-
:param advanced_security_mode: The user pool's Advanced Security Mode. Default: - no value
|
|
20577
|
+
:param advanced_security_mode: (deprecated) The user pool's Advanced Security Mode. Default: - no value
|
|
20442
20578
|
:param auto_verify: Attributes which Cognito will look to verify automatically upon user sign up. EMAIL and PHONE are the only available options. Default: - If ``signInAlias`` includes email and/or phone, they will be included in ``autoVerifiedAttributes`` by default. If absent, no attributes will be auto-verified.
|
|
20443
20579
|
:param custom_attributes: Define a set of custom attributes that can be configured for each user in the user pool. Default: - No custom attributes.
|
|
20444
20580
|
:param custom_sender_kms_key: This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates. Default: - no key ID configured
|
|
@@ -20446,6 +20582,7 @@ class UserPoolProps:
|
|
|
20446
20582
|
:param device_tracking: Device tracking settings. Default: - see defaults on each property of DeviceTracking.
|
|
20447
20583
|
:param email: Email settings for a user pool. Default: - cognito will use the default email configuration
|
|
20448
20584
|
:param enable_sms_role: Setting this would explicitly enable or disable SMS role creation. When left unspecified, CDK will determine based on other properties if a role is needed or not. Default: - CDK will determine based on other properties of the user pool if an SMS role should be created or not.
|
|
20585
|
+
:param feature_plan: The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Default: - FeaturePlan.ESSENTIALS for a newly created user pool; FeaturePlan.LITE otherwise
|
|
20449
20586
|
:param keep_original: Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes. EMAIL and PHONE are the only available options. Default: - Nothing is kept.
|
|
20450
20587
|
:param lambda_triggers: Lambda functions to use for supported Cognito triggers. Default: - No Lambda triggers.
|
|
20451
20588
|
:param mfa: Configure whether users of this user pool can or are required use MFA to sign in. Default: Mfa.OFF
|
|
@@ -20510,6 +20647,7 @@ class UserPoolProps:
|
|
|
20510
20647
|
check_type(argname="argument device_tracking", value=device_tracking, expected_type=type_hints["device_tracking"])
|
|
20511
20648
|
check_type(argname="argument email", value=email, expected_type=type_hints["email"])
|
|
20512
20649
|
check_type(argname="argument enable_sms_role", value=enable_sms_role, expected_type=type_hints["enable_sms_role"])
|
|
20650
|
+
check_type(argname="argument feature_plan", value=feature_plan, expected_type=type_hints["feature_plan"])
|
|
20513
20651
|
check_type(argname="argument keep_original", value=keep_original, expected_type=type_hints["keep_original"])
|
|
20514
20652
|
check_type(argname="argument lambda_triggers", value=lambda_triggers, expected_type=type_hints["lambda_triggers"])
|
|
20515
20653
|
check_type(argname="argument mfa", value=mfa, expected_type=type_hints["mfa"])
|
|
@@ -20546,6 +20684,8 @@ class UserPoolProps:
|
|
|
20546
20684
|
self._values["email"] = email
|
|
20547
20685
|
if enable_sms_role is not None:
|
|
20548
20686
|
self._values["enable_sms_role"] = enable_sms_role
|
|
20687
|
+
if feature_plan is not None:
|
|
20688
|
+
self._values["feature_plan"] = feature_plan
|
|
20549
20689
|
if keep_original is not None:
|
|
20550
20690
|
self._values["keep_original"] = keep_original
|
|
20551
20691
|
if lambda_triggers is not None:
|
|
@@ -20592,9 +20732,13 @@ class UserPoolProps:
|
|
|
20592
20732
|
|
|
20593
20733
|
@builtins.property
|
|
20594
20734
|
def advanced_security_mode(self) -> typing.Optional[AdvancedSecurityMode]:
|
|
20595
|
-
'''The user pool's Advanced Security Mode.
|
|
20735
|
+
'''(deprecated) The user pool's Advanced Security Mode.
|
|
20596
20736
|
|
|
20597
20737
|
:default: - no value
|
|
20738
|
+
|
|
20739
|
+
:deprecated: Advanced Security Mode is deprecated in favor of user pool feature plans.
|
|
20740
|
+
|
|
20741
|
+
:stability: deprecated
|
|
20598
20742
|
'''
|
|
20599
20743
|
result = self._values.get("advanced_security_mode")
|
|
20600
20744
|
return typing.cast(typing.Optional[AdvancedSecurityMode], result)
|
|
@@ -20673,6 +20817,19 @@ class UserPoolProps:
|
|
|
20673
20817
|
result = self._values.get("enable_sms_role")
|
|
20674
20818
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
20675
20819
|
|
|
20820
|
+
@builtins.property
|
|
20821
|
+
def feature_plan(self) -> typing.Optional[FeaturePlan]:
|
|
20822
|
+
'''The user pool feature plan, or tier.
|
|
20823
|
+
|
|
20824
|
+
This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection.
|
|
20825
|
+
|
|
20826
|
+
:default: - FeaturePlan.ESSENTIALS for a newly created user pool; FeaturePlan.LITE otherwise
|
|
20827
|
+
|
|
20828
|
+
:see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
|
|
20829
|
+
'''
|
|
20830
|
+
result = self._values.get("feature_plan")
|
|
20831
|
+
return typing.cast(typing.Optional[FeaturePlan], result)
|
|
20832
|
+
|
|
20676
20833
|
@builtins.property
|
|
20677
20834
|
def keep_original(self) -> typing.Optional[KeepOriginalAttrs]:
|
|
20678
20835
|
'''Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes.
|
|
@@ -22725,6 +22882,7 @@ __all__ = [
|
|
|
22725
22882
|
"DateTimeAttribute",
|
|
22726
22883
|
"DeviceTracking",
|
|
22727
22884
|
"EmailSettings",
|
|
22885
|
+
"FeaturePlan",
|
|
22728
22886
|
"ICustomAttribute",
|
|
22729
22887
|
"IUserPool",
|
|
22730
22888
|
"IUserPoolClient",
|
|
@@ -23948,6 +24106,7 @@ def _typecheckingstub__6e0b36c4d155cfdfa9801e3f221c4fe6c5403bf24a64d17bd90fb5386
|
|
|
23948
24106
|
domain: builtins.str,
|
|
23949
24107
|
user_pool_id: builtins.str,
|
|
23950
24108
|
custom_domain_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPoolDomain.CustomDomainConfigTypeProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
24109
|
+
managed_login_version: typing.Optional[jsii.Number] = None,
|
|
23951
24110
|
) -> None:
|
|
23952
24111
|
"""Type checking stubs"""
|
|
23953
24112
|
pass
|
|
@@ -23982,6 +24141,12 @@ def _typecheckingstub__534c4957c36eac9a89217ff1b762b65d25e33f26c5048218fc840dc7f
|
|
|
23982
24141
|
"""Type checking stubs"""
|
|
23983
24142
|
pass
|
|
23984
24143
|
|
|
24144
|
+
def _typecheckingstub__b1d6e8e96816f3572291ff67691b98d76a166cf058320e0e73e58062b8093526(
|
|
24145
|
+
value: typing.Optional[jsii.Number],
|
|
24146
|
+
) -> None:
|
|
24147
|
+
"""Type checking stubs"""
|
|
24148
|
+
pass
|
|
24149
|
+
|
|
23985
24150
|
def _typecheckingstub__dde97995e450b3b0c5468a27b415565086c00f64bdc255f297a8471e77b85243(
|
|
23986
24151
|
*,
|
|
23987
24152
|
certificate_arn: typing.Optional[builtins.str] = None,
|
|
@@ -23994,6 +24159,7 @@ def _typecheckingstub__fe5ef2b7c4347565bc988b8d9120bbd5feadcfadd061512019de1519e
|
|
|
23994
24159
|
domain: builtins.str,
|
|
23995
24160
|
user_pool_id: builtins.str,
|
|
23996
24161
|
custom_domain_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPoolDomain.CustomDomainConfigTypeProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
24162
|
+
managed_login_version: typing.Optional[jsii.Number] = None,
|
|
23997
24163
|
) -> None:
|
|
23998
24164
|
"""Type checking stubs"""
|
|
23999
24165
|
pass
|
|
@@ -24908,6 +25074,7 @@ def _typecheckingstub__677a8ec9a3f2a22d2dfde6fd6818121e4a071dc4e942f6bbe219e5a9b
|
|
|
24908
25074
|
device_tracking: typing.Optional[typing.Union[DeviceTracking, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24909
25075
|
email: typing.Optional[UserPoolEmail] = None,
|
|
24910
25076
|
enable_sms_role: typing.Optional[builtins.bool] = None,
|
|
25077
|
+
feature_plan: typing.Optional[FeaturePlan] = None,
|
|
24911
25078
|
keep_original: typing.Optional[typing.Union[KeepOriginalAttrs, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24912
25079
|
lambda_triggers: typing.Optional[typing.Union[UserPoolTriggers, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24913
25080
|
mfa: typing.Optional[Mfa] = None,
|
|
@@ -25356,6 +25523,7 @@ def _typecheckingstub__754b1af40b4712720733e130c63a8ec0ca9a35d4cfb25450725d5aa02
|
|
|
25356
25523
|
device_tracking: typing.Optional[typing.Union[DeviceTracking, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25357
25524
|
email: typing.Optional[UserPoolEmail] = None,
|
|
25358
25525
|
enable_sms_role: typing.Optional[builtins.bool] = None,
|
|
25526
|
+
feature_plan: typing.Optional[FeaturePlan] = None,
|
|
25359
25527
|
keep_original: typing.Optional[typing.Union[KeepOriginalAttrs, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25360
25528
|
lambda_triggers: typing.Optional[typing.Union[UserPoolTriggers, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25361
25529
|
mfa: typing.Optional[Mfa] = None,
|