aws-cdk-lib 2.158.0__py3-none-any.whl → 2.159.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 +36 -19
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.158.0.jsii.tgz → aws-cdk-lib@2.159.1.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +22 -8
- aws_cdk/aws_apigatewayv2/__init__.py +30 -0
- aws_cdk/aws_appconfig/__init__.py +3 -3
- aws_cdk/aws_applicationinsights/__init__.py +544 -4
- aws_cdk/aws_applicationsignals/__init__.py +170 -142
- aws_cdk/aws_athena/__init__.py +15 -15
- aws_cdk/aws_auditmanager/__init__.py +5 -5
- aws_cdk/aws_bedrock/__init__.py +7 -7
- aws_cdk/aws_codebuild/__init__.py +39 -18
- aws_cdk/aws_codeconnections/__init__.py +1 -1
- aws_cdk/aws_cognito/__init__.py +390 -203
- aws_cdk/aws_connect/__init__.py +1679 -152
- aws_cdk/aws_datazone/__init__.py +665 -40
- aws_cdk/aws_docdb/__init__.py +6 -1
- aws_cdk/aws_dynamodb/__init__.py +5 -5
- aws_cdk/aws_ec2/__init__.py +121 -36
- aws_cdk/aws_ecr/__init__.py +14 -6
- aws_cdk/aws_ecs/__init__.py +20 -20
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +167 -20
- aws_cdk/aws_emr/__init__.py +8 -8
- aws_cdk/aws_events/__init__.py +19 -17
- aws_cdk/aws_events_targets/__init__.py +165 -85
- aws_cdk/aws_fms/__init__.py +59 -0
- aws_cdk/aws_fsx/__init__.py +3 -3
- aws_cdk/aws_gamelift/__init__.py +40 -52
- aws_cdk/aws_globalaccelerator/__init__.py +22 -29
- aws_cdk/aws_iam/__init__.py +22 -20
- aws_cdk/aws_iotfleetwise/__init__.py +419 -0
- aws_cdk/aws_iotsitewise/__init__.py +90 -1
- aws_cdk/aws_iotwireless/__init__.py +205 -0
- aws_cdk/aws_lambda/__init__.py +129 -16
- aws_cdk/aws_lex/__init__.py +15 -1
- aws_cdk/aws_logs/__init__.py +1 -1
- aws_cdk/aws_mediaconnect/__init__.py +111 -0
- aws_cdk/aws_medialive/__init__.py +7988 -3262
- aws_cdk/aws_msk/__init__.py +287 -479
- aws_cdk/aws_opensearchservice/__init__.py +6 -0
- aws_cdk/aws_pcaconnectorscep/__init__.py +69 -30
- aws_cdk/aws_pipes/__init__.py +49 -0
- aws_cdk/aws_qbusiness/__init__.py +11 -14
- aws_cdk/aws_quicksight/__init__.py +638 -99
- aws_cdk/aws_rds/__init__.py +38 -27
- aws_cdk/aws_s3/__init__.py +215 -33
- aws_cdk/aws_s3objectlambda/__init__.py +2 -2
- aws_cdk/aws_sagemaker/__init__.py +872 -58
- aws_cdk/aws_secretsmanager/__init__.py +22 -8
- aws_cdk/aws_securityhub/__init__.py +261 -19
- aws_cdk/aws_securitylake/__init__.py +327 -7
- aws_cdk/aws_servicediscovery/__init__.py +5 -5
- aws_cdk/aws_sns/__init__.py +0 -8
- aws_cdk/aws_ssm/__init__.py +20 -12
- aws_cdk/aws_stepfunctions_tasks/__init__.py +36 -0
- aws_cdk/cx_api/__init__.py +19 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/RECORD +62 -62
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -3365,7 +3365,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3365
3365
|
metaclass=jsii.JSIIMeta,
|
|
3366
3366
|
jsii_type="aws-cdk-lib.aws_cognito.CfnLogDeliveryConfiguration",
|
|
3367
3367
|
):
|
|
3368
|
-
'''The logging parameters of a user pool returned in response to
|
|
3368
|
+
'''The logging parameters of a user pool, as returned in the response to a `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ request.
|
|
3369
3369
|
|
|
3370
3370
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html
|
|
3371
3371
|
:cloudformationResource: AWS::Cognito::LogDeliveryConfiguration
|
|
@@ -3509,6 +3509,8 @@ class CfnLogDeliveryConfiguration(
|
|
|
3509
3509
|
) -> None:
|
|
3510
3510
|
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3511
3511
|
|
|
3512
|
+
This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
|
|
3513
|
+
|
|
3512
3514
|
:param log_group_arn: The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with AWS Key Management Service and must be in the same AWS account as your user pool. To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with ``/aws/vendedlogs`` . For more information, see `Enabling logging from certain AWS services <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html>`_ .
|
|
3513
3515
|
|
|
3514
3516
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html
|
|
@@ -3627,9 +3629,11 @@ class CfnLogDeliveryConfiguration(
|
|
|
3627
3629
|
log_level: typing.Optional[builtins.str] = None,
|
|
3628
3630
|
s3_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnLogDeliveryConfiguration.S3ConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3629
3631
|
) -> None:
|
|
3630
|
-
'''The
|
|
3632
|
+
'''The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
|
|
3633
|
+
|
|
3634
|
+
This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
|
|
3631
3635
|
|
|
3632
|
-
:param cloud_watch_logs_configuration: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3636
|
+
:param cloud_watch_logs_configuration: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features. This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
|
|
3633
3637
|
:param event_source: The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to ``userNotification`` . To send info-level logs about advanced security features user activity, set to ``userAuthEvents`` .
|
|
3634
3638
|
:param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.
|
|
3635
3639
|
:param log_level: The ``errorlevel`` selection of logs that a user pool sends for detailed activity logging. To send ``userNotification`` activity with `information about message delivery <https://docs.aws.amazon.com/cognito/latest/developerguide/tracking-quotas-and-usage-in-cloud-watch-logs.html>`_ , choose ``ERROR`` with ``CloudWatchLogsConfiguration`` . To send ``userAuthEvents`` activity with user logs from advanced security features, choose ``INFO`` with one of ``CloudWatchLogsConfiguration`` , ``FirehoseConfiguration`` , or ``S3Configuration`` .
|
|
@@ -3683,6 +3687,8 @@ class CfnLogDeliveryConfiguration(
|
|
|
3683
3687
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.CloudWatchLogsConfigurationProperty"]]:
|
|
3684
3688
|
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3685
3689
|
|
|
3690
|
+
This data type is a request parameter of `SetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html>`_ and a response parameter of `GetLogDeliveryConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html>`_ .
|
|
3691
|
+
|
|
3686
3692
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration
|
|
3687
3693
|
'''
|
|
3688
3694
|
result = self._values.get("cloud_watch_logs_configuration")
|
|
@@ -3936,6 +3942,8 @@ class CfnUserPool(
|
|
|
3936
3942
|
challenge_required_on_new_device=False,
|
|
3937
3943
|
device_only_remembered_on_user_prompt=False
|
|
3938
3944
|
),
|
|
3945
|
+
email_authentication_message="emailAuthenticationMessage",
|
|
3946
|
+
email_authentication_subject="emailAuthenticationSubject",
|
|
3939
3947
|
email_configuration=cognito.CfnUserPool.EmailConfigurationProperty(
|
|
3940
3948
|
configuration_set="configurationSet",
|
|
3941
3949
|
email_sending_account="emailSendingAccount",
|
|
@@ -4042,6 +4050,8 @@ class CfnUserPool(
|
|
|
4042
4050
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
4043
4051
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
4044
4052
|
device_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.DeviceConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4053
|
+
email_authentication_message: typing.Optional[builtins.str] = None,
|
|
4054
|
+
email_authentication_subject: typing.Optional[builtins.str] = None,
|
|
4045
4055
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.EmailConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4046
4056
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
4047
4057
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -4065,18 +4075,20 @@ class CfnUserPool(
|
|
|
4065
4075
|
:param scope: Scope in which this resource is defined.
|
|
4066
4076
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4067
4077
|
:param account_recovery_setting: Use this setting to define which verified available method a user can use to recover their password when they call ``ForgotPassword`` . It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
|
|
4068
|
-
:param admin_create_user_config: The
|
|
4078
|
+
:param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
|
|
4069
4079
|
:param alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . .. epigraph:: This user pool property cannot be updated.
|
|
4070
4080
|
:param auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* .
|
|
4071
4081
|
:param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
|
|
4072
4082
|
:param device_configuration: The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. .. epigraph:: When you provide a value for any ``DeviceConfiguration`` field, you activate the Amazon Cognito device-remembering feature.
|
|
4083
|
+
:param email_authentication_message:
|
|
4084
|
+
:param email_authentication_subject:
|
|
4073
4085
|
:param email_configuration: The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
|
|
4074
4086
|
:param email_verification_message: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html>`_ .
|
|
4075
4087
|
:param email_verification_subject: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html>`_ .
|
|
4076
4088
|
:param enabled_mfas: Enables MFA on a specified user pool. To disable all MFAs after it has been enabled, set MfaConfiguration to “OFF” and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values: - ``SMS_MFA`` - Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided. - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA``
|
|
4077
|
-
:param lambda_config:
|
|
4089
|
+
:param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
|
|
4078
4090
|
:param mfa_configuration: The multi-factor authentication (MFA) configuration. Valid values include:. - ``OFF`` MFA won't be used for any users. - ``ON`` MFA is required for all users to sign in. - ``OPTIONAL`` MFA will be required only for individual users who have an MFA factor activated.
|
|
4079
|
-
:param policies:
|
|
4091
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
|
|
4080
4092
|
:param schema: The schema attributes for the new user pool. These attributes can be standard or custom attributes. .. epigraph:: During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
|
|
4081
4093
|
:param sms_authentication_message: A string representing the SMS authentication message.
|
|
4082
4094
|
:param sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .
|
|
@@ -4087,7 +4099,7 @@ class CfnUserPool(
|
|
|
4087
4099
|
: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>`_ .
|
|
4088
4100
|
:param user_pool_name: A string used to name the user pool.
|
|
4089
4101
|
: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.
|
|
4090
|
-
:param verification_message_template: The template for the verification message that
|
|
4102
|
+
: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.
|
|
4091
4103
|
'''
|
|
4092
4104
|
if __debug__:
|
|
4093
4105
|
type_hints = typing.get_type_hints(_typecheckingstub__32d20f28e2758f9a461380e2ed5d06233baf0f45541047ba837f26ebc37ee551)
|
|
@@ -4100,6 +4112,8 @@ class CfnUserPool(
|
|
|
4100
4112
|
auto_verified_attributes=auto_verified_attributes,
|
|
4101
4113
|
deletion_protection=deletion_protection,
|
|
4102
4114
|
device_configuration=device_configuration,
|
|
4115
|
+
email_authentication_message=email_authentication_message,
|
|
4116
|
+
email_authentication_subject=email_authentication_subject,
|
|
4103
4117
|
email_configuration=email_configuration,
|
|
4104
4118
|
email_verification_message=email_verification_message,
|
|
4105
4119
|
email_verification_subject=email_verification_subject,
|
|
@@ -4222,7 +4236,7 @@ class CfnUserPool(
|
|
|
4222
4236
|
def admin_create_user_config(
|
|
4223
4237
|
self,
|
|
4224
4238
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.AdminCreateUserConfigProperty"]]:
|
|
4225
|
-
'''The
|
|
4239
|
+
'''The settings for administrator creation of users in a user pool.'''
|
|
4226
4240
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.AdminCreateUserConfigProperty"]], jsii.get(self, "adminCreateUserConfig"))
|
|
4227
4241
|
|
|
4228
4242
|
@admin_create_user_config.setter
|
|
@@ -4301,6 +4315,36 @@ class CfnUserPool(
|
|
|
4301
4315
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
4302
4316
|
jsii.set(self, "deviceConfiguration", value) # pyright: ignore[reportArgumentType]
|
|
4303
4317
|
|
|
4318
|
+
@builtins.property
|
|
4319
|
+
@jsii.member(jsii_name="emailAuthenticationMessage")
|
|
4320
|
+
def email_authentication_message(self) -> typing.Optional[builtins.str]:
|
|
4321
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "emailAuthenticationMessage"))
|
|
4322
|
+
|
|
4323
|
+
@email_authentication_message.setter
|
|
4324
|
+
def email_authentication_message(
|
|
4325
|
+
self,
|
|
4326
|
+
value: typing.Optional[builtins.str],
|
|
4327
|
+
) -> None:
|
|
4328
|
+
if __debug__:
|
|
4329
|
+
type_hints = typing.get_type_hints(_typecheckingstub__3cf4765f879f49f79c6984252af6993fe6fdf6838989608b11e192c544fce53c)
|
|
4330
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
4331
|
+
jsii.set(self, "emailAuthenticationMessage", value) # pyright: ignore[reportArgumentType]
|
|
4332
|
+
|
|
4333
|
+
@builtins.property
|
|
4334
|
+
@jsii.member(jsii_name="emailAuthenticationSubject")
|
|
4335
|
+
def email_authentication_subject(self) -> typing.Optional[builtins.str]:
|
|
4336
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "emailAuthenticationSubject"))
|
|
4337
|
+
|
|
4338
|
+
@email_authentication_subject.setter
|
|
4339
|
+
def email_authentication_subject(
|
|
4340
|
+
self,
|
|
4341
|
+
value: typing.Optional[builtins.str],
|
|
4342
|
+
) -> None:
|
|
4343
|
+
if __debug__:
|
|
4344
|
+
type_hints = typing.get_type_hints(_typecheckingstub__1e1d4523d17f0641e76142be67287be5dc758d191f5eba3fa217d8c5d0170791)
|
|
4345
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
4346
|
+
jsii.set(self, "emailAuthenticationSubject", value) # pyright: ignore[reportArgumentType]
|
|
4347
|
+
|
|
4304
4348
|
@builtins.property
|
|
4305
4349
|
@jsii.member(jsii_name="emailConfiguration")
|
|
4306
4350
|
def email_configuration(
|
|
@@ -4363,7 +4407,7 @@ class CfnUserPool(
|
|
|
4363
4407
|
def lambda_config(
|
|
4364
4408
|
self,
|
|
4365
4409
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.LambdaConfigProperty"]]:
|
|
4366
|
-
'''
|
|
4410
|
+
'''A collection of user pool Lambda triggers.'''
|
|
4367
4411
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.LambdaConfigProperty"]], jsii.get(self, "lambdaConfig"))
|
|
4368
4412
|
|
|
4369
4413
|
@lambda_config.setter
|
|
@@ -4397,7 +4441,10 @@ class CfnUserPool(
|
|
|
4397
4441
|
def policies(
|
|
4398
4442
|
self,
|
|
4399
4443
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]]:
|
|
4400
|
-
'''
|
|
4444
|
+
'''A list of user pool policies.
|
|
4445
|
+
|
|
4446
|
+
Contains the policy that sets password-complexity requirements.
|
|
4447
|
+
'''
|
|
4401
4448
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]], jsii.get(self, "policies"))
|
|
4402
4449
|
|
|
4403
4450
|
@policies.setter
|
|
@@ -4576,7 +4623,7 @@ class CfnUserPool(
|
|
|
4576
4623
|
def verification_message_template(
|
|
4577
4624
|
self,
|
|
4578
4625
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.VerificationMessageTemplateProperty"]]:
|
|
4579
|
-
'''The template for the verification message that
|
|
4626
|
+
'''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.'''
|
|
4580
4627
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.VerificationMessageTemplateProperty"]], jsii.get(self, "verificationMessageTemplate"))
|
|
4581
4628
|
|
|
4582
4629
|
@verification_message_template.setter
|
|
@@ -4670,9 +4717,9 @@ class CfnUserPool(
|
|
|
4670
4717
|
) -> None:
|
|
4671
4718
|
'''The configuration for ``AdminCreateUser`` requests.
|
|
4672
4719
|
|
|
4673
|
-
:param allow_admin_create_user_only:
|
|
4720
|
+
: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.
|
|
4674
4721
|
:param invite_message_template: The message template to be used 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>`_ .
|
|
4675
|
-
:param unused_account_validity_days:
|
|
4722
|
+
: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.
|
|
4676
4723
|
|
|
4677
4724
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
|
|
4678
4725
|
:exampleMetadata: fixture=_generated
|
|
@@ -4710,9 +4757,9 @@ class CfnUserPool(
|
|
|
4710
4757
|
def allow_admin_create_user_only(
|
|
4711
4758
|
self,
|
|
4712
4759
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4713
|
-
'''
|
|
4760
|
+
'''The setting for allowing self-service sign-up.
|
|
4714
4761
|
|
|
4715
|
-
|
|
4762
|
+
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.
|
|
4716
4763
|
|
|
4717
4764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly
|
|
4718
4765
|
'''
|
|
@@ -4734,12 +4781,13 @@ class CfnUserPool(
|
|
|
4734
4781
|
|
|
4735
4782
|
@builtins.property
|
|
4736
4783
|
def unused_account_validity_days(self) -> typing.Optional[jsii.Number]:
|
|
4737
|
-
'''
|
|
4784
|
+
'''This parameter is no longer in use.
|
|
4738
4785
|
|
|
4739
|
-
|
|
4740
|
-
.. epigraph::
|
|
4786
|
+
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`` .
|
|
4741
4787
|
|
|
4742
|
-
|
|
4788
|
+
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.
|
|
4789
|
+
|
|
4790
|
+
The default value for this parameter is 7.
|
|
4743
4791
|
|
|
4744
4792
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays
|
|
4745
4793
|
'''
|
|
@@ -4978,6 +5026,8 @@ class CfnUserPool(
|
|
|
4978
5026
|
|
|
4979
5027
|
When you provide a value for any property of ``DeviceConfiguration`` , you activate the device remembering for the user pool.
|
|
4980
5028
|
|
|
5029
|
+
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>`_ .
|
|
5030
|
+
|
|
4981
5031
|
:param challenge_required_on_new_device: When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA). .. epigraph:: Whether or not ``ChallengeRequiredOnNewDevice`` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
|
|
4982
5032
|
:param device_only_remembered_on_user_prompt: When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a `ConfirmDevice <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html>`_ API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an `UpdateDeviceStatus <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html>`_ API request. When ``DeviceOnlyRememberedOnUserPrompt`` is ``false`` , Amazon Cognito immediately remembers devices that you register in a ``ConfirmDevice`` API request.
|
|
4983
5033
|
|
|
@@ -5212,7 +5262,7 @@ class CfnUserPool(
|
|
|
5212
5262
|
email_subject: typing.Optional[builtins.str] = None,
|
|
5213
5263
|
sms_message: typing.Optional[builtins.str] = None,
|
|
5214
5264
|
) -> None:
|
|
5215
|
-
'''The
|
|
5265
|
+
'''The template for the welcome message to new users.
|
|
5216
5266
|
|
|
5217
5267
|
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>`_ .
|
|
5218
5268
|
|
|
@@ -5329,22 +5379,26 @@ class CfnUserPool(
|
|
|
5329
5379
|
user_migration: typing.Optional[builtins.str] = None,
|
|
5330
5380
|
verify_auth_challenge_response: typing.Optional[builtins.str] = None,
|
|
5331
5381
|
) -> None:
|
|
5332
|
-
'''
|
|
5382
|
+
'''A collection of user pool Lambda triggers.
|
|
5383
|
+
|
|
5384
|
+
Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
|
|
5333
5385
|
|
|
5334
|
-
|
|
5386
|
+
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>`_ .
|
|
5387
|
+
|
|
5388
|
+
:param create_auth_challenge: The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5335
5389
|
:param custom_email_sender: A custom email sender AWS Lambda trigger.
|
|
5336
|
-
:param custom_message: A custom
|
|
5390
|
+
:param custom_message: A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.
|
|
5337
5391
|
:param custom_sms_sender: A custom SMS sender AWS Lambda trigger.
|
|
5338
|
-
:param define_auth_challenge:
|
|
5392
|
+
:param define_auth_challenge: The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5339
5393
|
:param kms_key_id: The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to ``CustomEmailSender`` and ``CustomSMSSender`` .
|
|
5340
|
-
:param post_authentication:
|
|
5341
|
-
:param post_confirmation:
|
|
5342
|
-
:param pre_authentication:
|
|
5343
|
-
:param pre_sign_up:
|
|
5344
|
-
:param pre_token_generation: The
|
|
5345
|
-
:param pre_token_generation_config: The detailed configuration of a pre token generation trigger. If you also set an ARN in ``PreTokenGeneration`` , its value must be identical to ``PreTokenGenerationConfig`` .
|
|
5346
|
-
:param user_migration: The user
|
|
5347
|
-
:param verify_auth_challenge_response:
|
|
5394
|
+
:param post_authentication: The configuration of a `post authentication Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html>`_ in a user pool. This trigger can take custom actions after a user signs in.
|
|
5395
|
+
:param post_confirmation: The configuration of a `post confirmation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html>`_ in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.
|
|
5396
|
+
:param pre_authentication: The configuration of a `pre authentication trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html>`_ in a user pool. This trigger can evaluate and modify user sign-in events.
|
|
5397
|
+
:param pre_sign_up: The configuration of a `pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ in a user pool. This trigger evaluates new users and can bypass confirmation, `link a federated user profile <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html>`_ , or block sign-up requests.
|
|
5398
|
+
:param pre_token_generation: The legacy configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`_ in a user pool. Set this parameter for legacy purposes. If you also set an ARN in ``PreTokenGenerationConfig`` , its value must be identical to ``PreTokenGeneration`` . For new instances of pre token generation triggers, set the ``LambdaArn`` of ``PreTokenGenerationConfig`` .
|
|
5399
|
+
:param pre_token_generation_config: The detailed configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`_ in a user pool. If you also set an ARN in ``PreTokenGeneration`` , its value must be identical to ``PreTokenGenerationConfig`` .
|
|
5400
|
+
:param user_migration: The configuration of a `migrate user Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html>`_ in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.
|
|
5401
|
+
:param verify_auth_challenge_response: The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5348
5402
|
|
|
5349
5403
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html
|
|
5350
5404
|
:exampleMetadata: fixture=_generated
|
|
@@ -5429,7 +5483,7 @@ class CfnUserPool(
|
|
|
5429
5483
|
|
|
5430
5484
|
@builtins.property
|
|
5431
5485
|
def create_auth_challenge(self) -> typing.Optional[builtins.str]:
|
|
5432
|
-
'''
|
|
5486
|
+
'''The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5433
5487
|
|
|
5434
5488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge
|
|
5435
5489
|
'''
|
|
@@ -5449,7 +5503,9 @@ class CfnUserPool(
|
|
|
5449
5503
|
|
|
5450
5504
|
@builtins.property
|
|
5451
5505
|
def custom_message(self) -> typing.Optional[builtins.str]:
|
|
5452
|
-
'''A custom
|
|
5506
|
+
'''A custom message Lambda trigger.
|
|
5507
|
+
|
|
5508
|
+
This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.
|
|
5453
5509
|
|
|
5454
5510
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage
|
|
5455
5511
|
'''
|
|
@@ -5469,7 +5525,7 @@ class CfnUserPool(
|
|
|
5469
5525
|
|
|
5470
5526
|
@builtins.property
|
|
5471
5527
|
def define_auth_challenge(self) -> typing.Optional[builtins.str]:
|
|
5472
|
-
'''
|
|
5528
|
+
'''The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5473
5529
|
|
|
5474
5530
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge
|
|
5475
5531
|
'''
|
|
@@ -5489,7 +5545,7 @@ class CfnUserPool(
|
|
|
5489
5545
|
|
|
5490
5546
|
@builtins.property
|
|
5491
5547
|
def post_authentication(self) -> typing.Optional[builtins.str]:
|
|
5492
|
-
'''
|
|
5548
|
+
'''The configuration of a `post authentication Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html>`_ in a user pool. This trigger can take custom actions after a user signs in.
|
|
5493
5549
|
|
|
5494
5550
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication
|
|
5495
5551
|
'''
|
|
@@ -5498,7 +5554,7 @@ class CfnUserPool(
|
|
|
5498
5554
|
|
|
5499
5555
|
@builtins.property
|
|
5500
5556
|
def post_confirmation(self) -> typing.Optional[builtins.str]:
|
|
5501
|
-
'''
|
|
5557
|
+
'''The configuration of a `post confirmation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html>`_ in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.
|
|
5502
5558
|
|
|
5503
5559
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation
|
|
5504
5560
|
'''
|
|
@@ -5507,7 +5563,7 @@ class CfnUserPool(
|
|
|
5507
5563
|
|
|
5508
5564
|
@builtins.property
|
|
5509
5565
|
def pre_authentication(self) -> typing.Optional[builtins.str]:
|
|
5510
|
-
'''
|
|
5566
|
+
'''The configuration of a `pre authentication trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html>`_ in a user pool. This trigger can evaluate and modify user sign-in events.
|
|
5511
5567
|
|
|
5512
5568
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication
|
|
5513
5569
|
'''
|
|
@@ -5516,7 +5572,7 @@ class CfnUserPool(
|
|
|
5516
5572
|
|
|
5517
5573
|
@builtins.property
|
|
5518
5574
|
def pre_sign_up(self) -> typing.Optional[builtins.str]:
|
|
5519
|
-
'''
|
|
5575
|
+
'''The configuration of a `pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`_ in a user pool. This trigger evaluates new users and can bypass confirmation, `link a federated user profile <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html>`_ , or block sign-up requests.
|
|
5520
5576
|
|
|
5521
5577
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup
|
|
5522
5578
|
'''
|
|
@@ -5525,12 +5581,10 @@ class CfnUserPool(
|
|
|
5525
5581
|
|
|
5526
5582
|
@builtins.property
|
|
5527
5583
|
def pre_token_generation(self) -> typing.Optional[builtins.str]:
|
|
5528
|
-
'''The
|
|
5584
|
+
'''The legacy configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`_ in a user pool.
|
|
5529
5585
|
|
|
5530
5586
|
Set this parameter for legacy purposes. If you also set an ARN in ``PreTokenGenerationConfig`` , its value must be identical to ``PreTokenGeneration`` . For new instances of pre token generation triggers, set the ``LambdaArn`` of ``PreTokenGenerationConfig`` .
|
|
5531
5587
|
|
|
5532
|
-
You can set ``
|
|
5533
|
-
|
|
5534
5588
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration
|
|
5535
5589
|
'''
|
|
5536
5590
|
result = self._values.get("pre_token_generation")
|
|
@@ -5540,9 +5594,7 @@ class CfnUserPool(
|
|
|
5540
5594
|
def pre_token_generation_config(
|
|
5541
5595
|
self,
|
|
5542
5596
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PreTokenGenerationConfigProperty"]]:
|
|
5543
|
-
'''The detailed configuration of a pre token generation trigger.
|
|
5544
|
-
|
|
5545
|
-
If you also set an ARN in ``PreTokenGeneration`` , its value must be identical to ``PreTokenGenerationConfig`` .
|
|
5597
|
+
'''The detailed configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`_ in a user pool. If you also set an ARN in ``PreTokenGeneration`` , its value must be identical to ``PreTokenGenerationConfig`` .
|
|
5546
5598
|
|
|
5547
5599
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengenerationconfig
|
|
5548
5600
|
'''
|
|
@@ -5551,7 +5603,7 @@ class CfnUserPool(
|
|
|
5551
5603
|
|
|
5552
5604
|
@builtins.property
|
|
5553
5605
|
def user_migration(self) -> typing.Optional[builtins.str]:
|
|
5554
|
-
'''The user
|
|
5606
|
+
'''The configuration of a `migrate user Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html>`_ in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.
|
|
5555
5607
|
|
|
5556
5608
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration
|
|
5557
5609
|
'''
|
|
@@ -5560,7 +5612,7 @@ class CfnUserPool(
|
|
|
5560
5612
|
|
|
5561
5613
|
@builtins.property
|
|
5562
5614
|
def verify_auth_challenge_response(self) -> typing.Optional[builtins.str]:
|
|
5563
|
-
'''
|
|
5615
|
+
'''The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`_ .
|
|
5564
5616
|
|
|
5565
5617
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse
|
|
5566
5618
|
'''
|
|
@@ -5590,7 +5642,9 @@ class CfnUserPool(
|
|
|
5590
5642
|
max_value: typing.Optional[builtins.str] = None,
|
|
5591
5643
|
min_value: typing.Optional[builtins.str] = None,
|
|
5592
5644
|
) -> None:
|
|
5593
|
-
'''The minimum and maximum values of an attribute that is of the number
|
|
5645
|
+
'''The minimum and maximum values of an attribute that is of the number type, for example ``custom:age`` .
|
|
5646
|
+
|
|
5647
|
+
This data type is part of `SchemaAttributeType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html>`_ . It defines the length constraints on number-type attributes that you configure in `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and displays the length constraints of all number-type attributes in the response to `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_
|
|
5594
5648
|
|
|
5595
5649
|
:param max_value: The maximum length of a number attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
|
|
5596
5650
|
:param min_value: The minimum value of an attribute that is of the number data type.
|
|
@@ -5675,14 +5729,16 @@ class CfnUserPool(
|
|
|
5675
5729
|
require_uppercase: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
5676
5730
|
temporary_password_validity_days: typing.Optional[jsii.Number] = None,
|
|
5677
5731
|
) -> None:
|
|
5678
|
-
'''The password policy
|
|
5732
|
+
'''The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
5733
|
+
|
|
5734
|
+
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>`_ .
|
|
5679
5735
|
|
|
5680
5736
|
:param minimum_length: The minimum length of the password in the policy that you have set. This value can't be less than 6.
|
|
5681
5737
|
:param password_history_size: The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of ``n`` previous passwords, where ``n`` is the value of ``PasswordHistorySize`` . Password history isn't enforced and isn't displayed in `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ responses when you set this value to ``0`` or don't provide it. To activate this setting, `advanced security features <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html>`_ must be active in your user pool.
|
|
5682
|
-
:param require_lowercase:
|
|
5683
|
-
:param require_numbers:
|
|
5684
|
-
:param require_symbols:
|
|
5685
|
-
:param require_uppercase:
|
|
5738
|
+
:param require_lowercase: The requirement in a password policy that users must include at least one lowercase letter in their password.
|
|
5739
|
+
:param require_numbers: The requirement in a password policy that users must include at least one number in their password.
|
|
5740
|
+
:param require_symbols: The requirement in a password policy that users must include at least one symbol in their password.
|
|
5741
|
+
:param require_uppercase: The requirement in a password policy that users must include at least one uppercase letter in their password.
|
|
5686
5742
|
:param temporary_password_validity_days: The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to ``7`` . If you submit a value of ``0`` , Amazon Cognito treats it as a null value and sets ``TemporaryPasswordValidityDays`` to its default value. .. epigraph:: When you set ``TemporaryPasswordValidityDays`` for a user pool, you can no longer set a value for the legacy ``UnusedAccountValidityDays`` parameter in that user pool.
|
|
5687
5743
|
|
|
5688
5744
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html
|
|
@@ -5757,7 +5813,7 @@ class CfnUserPool(
|
|
|
5757
5813
|
def require_lowercase(
|
|
5758
5814
|
self,
|
|
5759
5815
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5760
|
-
'''
|
|
5816
|
+
'''The requirement in a password policy that users must include at least one lowercase letter in their password.
|
|
5761
5817
|
|
|
5762
5818
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase
|
|
5763
5819
|
'''
|
|
@@ -5768,7 +5824,7 @@ class CfnUserPool(
|
|
|
5768
5824
|
def require_numbers(
|
|
5769
5825
|
self,
|
|
5770
5826
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5771
|
-
'''
|
|
5827
|
+
'''The requirement in a password policy that users must include at least one number in their password.
|
|
5772
5828
|
|
|
5773
5829
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers
|
|
5774
5830
|
'''
|
|
@@ -5779,7 +5835,7 @@ class CfnUserPool(
|
|
|
5779
5835
|
def require_symbols(
|
|
5780
5836
|
self,
|
|
5781
5837
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5782
|
-
'''
|
|
5838
|
+
'''The requirement in a password policy that users must include at least one symbol in their password.
|
|
5783
5839
|
|
|
5784
5840
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols
|
|
5785
5841
|
'''
|
|
@@ -5790,7 +5846,7 @@ class CfnUserPool(
|
|
|
5790
5846
|
def require_uppercase(
|
|
5791
5847
|
self,
|
|
5792
5848
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5793
|
-
'''
|
|
5849
|
+
'''The requirement in a password policy that users must include at least one uppercase letter in their password.
|
|
5794
5850
|
|
|
5795
5851
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase
|
|
5796
5852
|
'''
|
|
@@ -5833,9 +5889,11 @@ class CfnUserPool(
|
|
|
5833
5889
|
*,
|
|
5834
5890
|
password_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.PasswordPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5835
5891
|
) -> None:
|
|
5836
|
-
'''
|
|
5892
|
+
'''A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
5837
5893
|
|
|
5838
|
-
|
|
5894
|
+
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>`_ .
|
|
5895
|
+
|
|
5896
|
+
:param password_policy: The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
5839
5897
|
|
|
5840
5898
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html
|
|
5841
5899
|
:exampleMetadata: fixture=_generated
|
|
@@ -5869,7 +5927,7 @@ class CfnUserPool(
|
|
|
5869
5927
|
def password_policy(
|
|
5870
5928
|
self,
|
|
5871
5929
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PasswordPolicyProperty"]]:
|
|
5872
|
-
'''The password policy.
|
|
5930
|
+
'''The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
5873
5931
|
|
|
5874
5932
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-passwordpolicy
|
|
5875
5933
|
'''
|
|
@@ -5901,6 +5959,8 @@ class CfnUserPool(
|
|
|
5901
5959
|
) -> None:
|
|
5902
5960
|
'''The properties of a pre token generation Lambda trigger.
|
|
5903
5961
|
|
|
5962
|
+
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>`_ .
|
|
5963
|
+
|
|
5904
5964
|
:param lambda_arn: The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger. This parameter and the ``PreTokenGeneration`` property of ``LambdaConfig`` have the same value. For new instances of pre token generation triggers, set ``LambdaArn`` .
|
|
5905
5965
|
:param lambda_version: The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
|
|
5906
5966
|
|
|
@@ -6060,7 +6120,9 @@ class CfnUserPool(
|
|
|
6060
6120
|
|
|
6061
6121
|
The attribute schema contains standard attributes, custom attributes with a ``custom:`` prefix, and developer attributes with a ``dev:`` prefix. For more information, see `User pool attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html>`_ .
|
|
6062
6122
|
|
|
6063
|
-
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
|
|
6123
|
+
Developer-only ``dev:`` attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
|
|
6124
|
+
|
|
6125
|
+
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>`_ .
|
|
6064
6126
|
|
|
6065
6127
|
:param attribute_data_type: The data format of the values for your attribute. When you choose an ``AttributeDataType`` , Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example ``"custom:isMember" : "true"`` or ``"custom:YearsAsMember" : "12"`` .
|
|
6066
6128
|
:param developer_only_attribute: .. epigraph:: We recommend that you use `WriteAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes>`_ in the user pool client to control how attributes can be mutated for new use cases instead of using ``DeveloperOnlyAttribute`` . Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token.
|
|
@@ -6332,7 +6394,7 @@ class CfnUserPool(
|
|
|
6332
6394
|
``StringAttributeConstraints`` is a subproperty of the `SchemaAttribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html>`_ property type.
|
|
6333
6395
|
|
|
6334
6396
|
:param max_length: The maximum length of a string attribute value. Must be a number less than or equal to ``2^1023`` , represented as a string with a length of 131072 characters or fewer.
|
|
6335
|
-
:param min_length: The minimum length.
|
|
6397
|
+
:param min_length: The minimum length of a string attribute value.
|
|
6336
6398
|
|
|
6337
6399
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html
|
|
6338
6400
|
:exampleMetadata: fixture=_generated
|
|
@@ -6371,7 +6433,7 @@ class CfnUserPool(
|
|
|
6371
6433
|
|
|
6372
6434
|
@builtins.property
|
|
6373
6435
|
def min_length(self) -> typing.Optional[builtins.str]:
|
|
6374
|
-
'''The minimum length.
|
|
6436
|
+
'''The minimum length of a string attribute value.
|
|
6375
6437
|
|
|
6376
6438
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength
|
|
6377
6439
|
'''
|
|
@@ -6480,6 +6542,8 @@ class CfnUserPool(
|
|
|
6480
6542
|
|
|
6481
6543
|
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>`_ .
|
|
6482
6544
|
|
|
6545
|
+
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>`_ .
|
|
6546
|
+
|
|
6483
6547
|
:param advanced_security_additional_flows:
|
|
6484
6548
|
:param advanced_security_mode: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
|
|
6485
6549
|
|
|
@@ -6552,7 +6616,7 @@ class CfnUserPool(
|
|
|
6552
6616
|
) -> None:
|
|
6553
6617
|
'''The ``UsernameConfiguration`` property type specifies case sensitivity on the username input for the selected sign-in option.
|
|
6554
6618
|
|
|
6555
|
-
:param case_sensitive: Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name. Valid values include: - **
|
|
6619
|
+
:param case_sensitive: Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to ``False`` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name. Valid values include: - **true** - Enables case sensitivity for all username input. When this option is set to ``true`` , users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - **false** - Enables case insensitivity for all username input. For example, when this option is set to ``false`` , users can sign in using ``username`` , ``USERNAME`` , or ``UserName`` . This option also enables both ``preferred_username`` and ``email`` alias to be case insensitive, in addition to the ``username`` attribute.
|
|
6556
6620
|
|
|
6557
6621
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html
|
|
6558
6622
|
:exampleMetadata: fixture=_generated
|
|
@@ -6584,8 +6648,8 @@ class CfnUserPool(
|
|
|
6584
6648
|
|
|
6585
6649
|
Valid values include:
|
|
6586
6650
|
|
|
6587
|
-
- **
|
|
6588
|
-
- **
|
|
6651
|
+
- **true** - Enables case sensitivity for all username input. When this option is set to ``true`` , users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
|
|
6652
|
+
- **false** - Enables case insensitivity for all username input. For example, when this option is set to ``false`` , users can sign in using ``username`` , ``USERNAME`` , or ``UserName`` . This option also enables both ``preferred_username`` and ``email`` alias to be case insensitive, in addition to the ``username`` attribute.
|
|
6589
6653
|
|
|
6590
6654
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html#cfn-cognito-userpool-usernameconfiguration-casesensitive
|
|
6591
6655
|
'''
|
|
@@ -6626,9 +6690,11 @@ class CfnUserPool(
|
|
|
6626
6690
|
email_subject_by_link: typing.Optional[builtins.str] = None,
|
|
6627
6691
|
sms_message: typing.Optional[builtins.str] = None,
|
|
6628
6692
|
) -> None:
|
|
6629
|
-
'''The template for verification
|
|
6693
|
+
'''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
|
|
6630
6694
|
|
|
6631
|
-
|
|
6695
|
+
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>`_ .
|
|
6696
|
+
|
|
6697
|
+
:param default_email_option: The configuration of verification emails to contain a clickable link or a verification code. For link, your template body must contain link text in the format ``{##Click here##}`` . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format ``{####}`` .
|
|
6632
6698
|
:param email_message: The template for email messages that Amazon Cognito sends to your users. You can set an ``EmailMessage`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
|
|
6633
6699
|
:param email_message_by_link: The email message template for sending a confirmation link to the user. You can set an ``EmailMessageByLink`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
|
|
6634
6700
|
:param email_subject: The subject line for the email message template. You can set an ``EmailSubject`` template only if the value of `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` . When your `EmailSendingAccount <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount>`_ is ``DEVELOPER`` , your user pool sends email messages with your own Amazon SES configuration.
|
|
@@ -6677,7 +6743,9 @@ class CfnUserPool(
|
|
|
6677
6743
|
|
|
6678
6744
|
@builtins.property
|
|
6679
6745
|
def default_email_option(self) -> typing.Optional[builtins.str]:
|
|
6680
|
-
'''The
|
|
6746
|
+
'''The configuration of verification emails to contain a clickable link or a verification code.
|
|
6747
|
+
|
|
6748
|
+
For link, your template body must contain link text in the format ``{##Click here##}`` . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format ``{####}`` .
|
|
6681
6749
|
|
|
6682
6750
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-defaultemailoption
|
|
6683
6751
|
'''
|
|
@@ -6874,7 +6942,7 @@ class CfnUserPoolClient(
|
|
|
6874
6942
|
: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.
|
|
6875
6943
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
6876
6944
|
:param prevent_user_existence_errors: Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ``ENABLED`` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ``LEGACY`` , those APIs will return a ``UserNotFoundException`` exception if the user does not exist in the user pool.
|
|
6877
|
-
:param read_attributes: The list of user attributes that you want your app client to have read
|
|
6945
|
+
: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.
|
|
6878
6946
|
: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.
|
|
6879
6947
|
: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`` .
|
|
6880
6948
|
: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.
|
|
@@ -7235,7 +7303,7 @@ class CfnUserPoolClient(
|
|
|
7235
7303
|
@builtins.property
|
|
7236
7304
|
@jsii.member(jsii_name="readAttributes")
|
|
7237
7305
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7238
|
-
'''The list of user attributes that you want your app client to have read
|
|
7306
|
+
'''The list of user attributes that you want your app client to have read access to.'''
|
|
7239
7307
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "readAttributes"))
|
|
7240
7308
|
|
|
7241
7309
|
@read_attributes.setter
|
|
@@ -7334,16 +7402,18 @@ class CfnUserPoolClient(
|
|
|
7334
7402
|
role_arn: typing.Optional[builtins.str] = None,
|
|
7335
7403
|
user_data_shared: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
7336
7404
|
) -> None:
|
|
7337
|
-
'''The Amazon Pinpoint analytics configuration
|
|
7405
|
+
'''The settings for Amazon Pinpoint analytics configuration.
|
|
7338
7406
|
|
|
7339
|
-
|
|
7407
|
+
With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.
|
|
7408
|
+
|
|
7409
|
+
Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see `Amazon Cognito and Amazon Pinpoint Region availability <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings>`_ .
|
|
7340
7410
|
|
|
7341
|
-
|
|
7411
|
+
This data type is a request parameter of `CreateUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html>`_ and `UpdateUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html>`_ , and a response parameter of `DescribeUserPoolClient <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html>`_ .
|
|
7342
7412
|
|
|
7343
7413
|
:param application_arn: The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen user pool client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
|
|
7344
|
-
:param application_id:
|
|
7345
|
-
:param external_id: The external ID.
|
|
7346
|
-
:param role_arn: The ARN of an AWS Identity and Access Management role that
|
|
7414
|
+
:param application_id: Your Amazon Pinpoint project ID.
|
|
7415
|
+
:param external_id: The `external ID <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_ of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
|
|
7416
|
+
:param role_arn: The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
|
|
7347
7417
|
:param user_data_shared: If ``UserDataShared`` is ``true`` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
|
|
7348
7418
|
|
|
7349
7419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html
|
|
@@ -7395,7 +7465,7 @@ class CfnUserPoolClient(
|
|
|
7395
7465
|
|
|
7396
7466
|
@builtins.property
|
|
7397
7467
|
def application_id(self) -> typing.Optional[builtins.str]:
|
|
7398
|
-
'''
|
|
7468
|
+
'''Your Amazon Pinpoint project ID.
|
|
7399
7469
|
|
|
7400
7470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid
|
|
7401
7471
|
'''
|
|
@@ -7404,7 +7474,7 @@ class CfnUserPoolClient(
|
|
|
7404
7474
|
|
|
7405
7475
|
@builtins.property
|
|
7406
7476
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
7407
|
-
'''The external ID.
|
|
7477
|
+
'''The `external ID <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_ of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
|
|
7408
7478
|
|
|
7409
7479
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-externalid
|
|
7410
7480
|
'''
|
|
@@ -7413,7 +7483,7 @@ class CfnUserPoolClient(
|
|
|
7413
7483
|
|
|
7414
7484
|
@builtins.property
|
|
7415
7485
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
7416
|
-
'''The ARN of an AWS Identity and Access Management role that
|
|
7486
|
+
'''The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
|
|
7417
7487
|
|
|
7418
7488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn
|
|
7419
7489
|
'''
|
|
@@ -7463,9 +7533,9 @@ class CfnUserPoolClient(
|
|
|
7463
7533
|
|
|
7464
7534
|
The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
|
|
7465
7535
|
|
|
7466
|
-
:param access_token: A time unit
|
|
7467
|
-
:param id_token: A time unit
|
|
7468
|
-
:param refresh_token: A time unit
|
|
7536
|
+
:param access_token: A time unit for the value that you set in the ``AccessTokenValidity`` parameter. The default ``AccessTokenValidity`` time unit is ``hours`` . ``AccessTokenValidity`` duration can range from five minutes to one day.
|
|
7537
|
+
:param id_token: A time unit for the value that you set in the ``IdTokenValidity`` parameter. The default ``IdTokenValidity`` time unit is ``hours`` . ``IdTokenValidity`` duration can range from five minutes to one day.
|
|
7538
|
+
:param refresh_token: A time unit for the value that you set in the ``RefreshTokenValidity`` parameter. The default ``RefreshTokenValidity`` time unit is ``days`` . ``RefreshTokenValidity`` duration can range from 60 minutes to 10 years.
|
|
7469
7539
|
|
|
7470
7540
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html
|
|
7471
7541
|
:exampleMetadata: fixture=_generated
|
|
@@ -7497,9 +7567,9 @@ class CfnUserPoolClient(
|
|
|
7497
7567
|
|
|
7498
7568
|
@builtins.property
|
|
7499
7569
|
def access_token(self) -> typing.Optional[builtins.str]:
|
|
7500
|
-
'''A time unit
|
|
7570
|
+
'''A time unit for the value that you set in the ``AccessTokenValidity`` parameter.
|
|
7501
7571
|
|
|
7502
|
-
The default ``AccessTokenValidity`` time unit is hours. ``AccessTokenValidity`` duration can range from five minutes to one day.
|
|
7572
|
+
The default ``AccessTokenValidity`` time unit is ``hours`` . ``AccessTokenValidity`` duration can range from five minutes to one day.
|
|
7503
7573
|
|
|
7504
7574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-accesstoken
|
|
7505
7575
|
'''
|
|
@@ -7508,9 +7578,9 @@ class CfnUserPoolClient(
|
|
|
7508
7578
|
|
|
7509
7579
|
@builtins.property
|
|
7510
7580
|
def id_token(self) -> typing.Optional[builtins.str]:
|
|
7511
|
-
'''A time unit
|
|
7581
|
+
'''A time unit for the value that you set in the ``IdTokenValidity`` parameter.
|
|
7512
7582
|
|
|
7513
|
-
The default ``IdTokenValidity`` time unit is hours. ``IdTokenValidity`` duration can range from five minutes to one day.
|
|
7583
|
+
The default ``IdTokenValidity`` time unit is ``hours`` . ``IdTokenValidity`` duration can range from five minutes to one day.
|
|
7514
7584
|
|
|
7515
7585
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-idtoken
|
|
7516
7586
|
'''
|
|
@@ -7519,9 +7589,9 @@ class CfnUserPoolClient(
|
|
|
7519
7589
|
|
|
7520
7590
|
@builtins.property
|
|
7521
7591
|
def refresh_token(self) -> typing.Optional[builtins.str]:
|
|
7522
|
-
'''A time unit
|
|
7592
|
+
'''A time unit for the value that you set in the ``RefreshTokenValidity`` parameter.
|
|
7523
7593
|
|
|
7524
|
-
The default ``RefreshTokenValidity`` time unit is days. ``RefreshTokenValidity`` duration can range from 60 minutes to 10 years.
|
|
7594
|
+
The default ``RefreshTokenValidity`` time unit is ``days`` . ``RefreshTokenValidity`` duration can range from 60 minutes to 10 years.
|
|
7525
7595
|
|
|
7526
7596
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-refreshtoken
|
|
7527
7597
|
'''
|
|
@@ -7614,7 +7684,7 @@ class CfnUserPoolClientProps:
|
|
|
7614
7684
|
: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.
|
|
7615
7685
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
7616
7686
|
:param prevent_user_existence_errors: Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ``ENABLED`` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ``LEGACY`` , those APIs will return a ``UserNotFoundException`` exception if the user does not exist in the user pool.
|
|
7617
|
-
:param read_attributes: The list of user attributes that you want your app client to have read
|
|
7687
|
+
: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.
|
|
7618
7688
|
: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.
|
|
7619
7689
|
: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`` .
|
|
7620
7690
|
: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.
|
|
@@ -7985,11 +8055,11 @@ class CfnUserPoolClientProps:
|
|
|
7985
8055
|
|
|
7986
8056
|
@builtins.property
|
|
7987
8057
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7988
|
-
'''The list of user attributes that you want your app client to have read
|
|
8058
|
+
'''The list of user attributes that you want your app client to have read access to.
|
|
7989
8059
|
|
|
7990
8060
|
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.
|
|
7991
8061
|
|
|
7992
|
-
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 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.
|
|
8062
|
+
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.
|
|
7993
8063
|
|
|
7994
8064
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes
|
|
7995
8065
|
'''
|
|
@@ -8229,7 +8299,9 @@ class CfnUserPoolDomain(
|
|
|
8229
8299
|
*,
|
|
8230
8300
|
certificate_arn: typing.Optional[builtins.str] = None,
|
|
8231
8301
|
) -> None:
|
|
8232
|
-
'''The configuration for a custom domain
|
|
8302
|
+
'''The configuration for a hosted UI custom domain.
|
|
8303
|
+
|
|
8304
|
+
This data type is a request parameter of `CreateUserPoolDomain <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html>`_ and `UpdateUserPoolDomain <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html>`_ .
|
|
8233
8305
|
|
|
8234
8306
|
:param certificate_arn: The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
|
|
8235
8307
|
|
|
@@ -9061,6 +9133,8 @@ class CfnUserPoolIdentityProviderProps:
|
|
|
9061
9133
|
"auto_verified_attributes": "autoVerifiedAttributes",
|
|
9062
9134
|
"deletion_protection": "deletionProtection",
|
|
9063
9135
|
"device_configuration": "deviceConfiguration",
|
|
9136
|
+
"email_authentication_message": "emailAuthenticationMessage",
|
|
9137
|
+
"email_authentication_subject": "emailAuthenticationSubject",
|
|
9064
9138
|
"email_configuration": "emailConfiguration",
|
|
9065
9139
|
"email_verification_message": "emailVerificationMessage",
|
|
9066
9140
|
"email_verification_subject": "emailVerificationSubject",
|
|
@@ -9091,6 +9165,8 @@ class CfnUserPoolProps:
|
|
|
9091
9165
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
9092
9166
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
9093
9167
|
device_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.DeviceConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
9168
|
+
email_authentication_message: typing.Optional[builtins.str] = None,
|
|
9169
|
+
email_authentication_subject: typing.Optional[builtins.str] = None,
|
|
9094
9170
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
9095
9171
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
9096
9172
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -9113,18 +9189,20 @@ class CfnUserPoolProps:
|
|
|
9113
9189
|
'''Properties for defining a ``CfnUserPool``.
|
|
9114
9190
|
|
|
9115
9191
|
:param account_recovery_setting: Use this setting to define which verified available method a user can use to recover their password when they call ``ForgotPassword`` . It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
|
|
9116
|
-
:param admin_create_user_config: The
|
|
9192
|
+
:param admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
|
|
9117
9193
|
:param alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . .. epigraph:: This user pool property cannot be updated.
|
|
9118
9194
|
:param auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* .
|
|
9119
9195
|
:param deletion_protection: When active, ``DeletionProtection`` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a ``DeleteUserPool`` API request, Amazon Cognito returns an ``InvalidParameterException`` error. To delete a protected user pool, send a new ``DeleteUserPool`` request after you deactivate deletion protection in an ``UpdateUserPool`` API request.
|
|
9120
9196
|
:param device_configuration: The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. .. epigraph:: When you provide a value for any ``DeviceConfiguration`` field, you activate the Amazon Cognito device-remembering feature.
|
|
9197
|
+
:param email_authentication_message:
|
|
9198
|
+
:param email_authentication_subject:
|
|
9121
9199
|
:param email_configuration: The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
|
|
9122
9200
|
:param email_verification_message: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html>`_ .
|
|
9123
9201
|
:param email_verification_subject: This parameter is no longer used. See `VerificationMessageTemplateType <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html>`_ .
|
|
9124
9202
|
:param enabled_mfas: Enables MFA on a specified user pool. To disable all MFAs after it has been enabled, set MfaConfiguration to “OFF” and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values: - ``SMS_MFA`` - Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided. - ``SOFTWARE_TOKEN_MFA`` - Enables software token MFA for the user pool. Allowed values: ``SMS_MFA`` | ``SOFTWARE_TOKEN_MFA``
|
|
9125
|
-
:param lambda_config:
|
|
9203
|
+
:param lambda_config: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
|
|
9126
9204
|
:param mfa_configuration: The multi-factor authentication (MFA) configuration. Valid values include:. - ``OFF`` MFA won't be used for any users. - ``ON`` MFA is required for all users to sign in. - ``OPTIONAL`` MFA will be required only for individual users who have an MFA factor activated.
|
|
9127
|
-
:param policies:
|
|
9205
|
+
:param policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of `CreateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ and `UpdateUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html>`_ , and a response parameter of `DescribeUserPool <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html>`_ .
|
|
9128
9206
|
:param schema: The schema attributes for the new user pool. These attributes can be standard or custom attributes. .. epigraph:: During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
|
|
9129
9207
|
:param sms_authentication_message: A string representing the SMS authentication message.
|
|
9130
9208
|
:param sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .
|
|
@@ -9135,7 +9213,7 @@ class CfnUserPoolProps:
|
|
|
9135
9213
|
: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>`_ .
|
|
9136
9214
|
:param user_pool_name: A string used to name the user pool.
|
|
9137
9215
|
: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.
|
|
9138
|
-
:param verification_message_template: The template for the verification message that
|
|
9216
|
+
: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.
|
|
9139
9217
|
|
|
9140
9218
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html
|
|
9141
9219
|
:exampleMetadata: fixture=_generated
|
|
@@ -9171,6 +9249,8 @@ class CfnUserPoolProps:
|
|
|
9171
9249
|
challenge_required_on_new_device=False,
|
|
9172
9250
|
device_only_remembered_on_user_prompt=False
|
|
9173
9251
|
),
|
|
9252
|
+
email_authentication_message="emailAuthenticationMessage",
|
|
9253
|
+
email_authentication_subject="emailAuthenticationSubject",
|
|
9174
9254
|
email_configuration=cognito.CfnUserPool.EmailConfigurationProperty(
|
|
9175
9255
|
configuration_set="configurationSet",
|
|
9176
9256
|
email_sending_account="emailSendingAccount",
|
|
@@ -9273,6 +9353,8 @@ class CfnUserPoolProps:
|
|
|
9273
9353
|
check_type(argname="argument auto_verified_attributes", value=auto_verified_attributes, expected_type=type_hints["auto_verified_attributes"])
|
|
9274
9354
|
check_type(argname="argument deletion_protection", value=deletion_protection, expected_type=type_hints["deletion_protection"])
|
|
9275
9355
|
check_type(argname="argument device_configuration", value=device_configuration, expected_type=type_hints["device_configuration"])
|
|
9356
|
+
check_type(argname="argument email_authentication_message", value=email_authentication_message, expected_type=type_hints["email_authentication_message"])
|
|
9357
|
+
check_type(argname="argument email_authentication_subject", value=email_authentication_subject, expected_type=type_hints["email_authentication_subject"])
|
|
9276
9358
|
check_type(argname="argument email_configuration", value=email_configuration, expected_type=type_hints["email_configuration"])
|
|
9277
9359
|
check_type(argname="argument email_verification_message", value=email_verification_message, expected_type=type_hints["email_verification_message"])
|
|
9278
9360
|
check_type(argname="argument email_verification_subject", value=email_verification_subject, expected_type=type_hints["email_verification_subject"])
|
|
@@ -9304,6 +9386,10 @@ class CfnUserPoolProps:
|
|
|
9304
9386
|
self._values["deletion_protection"] = deletion_protection
|
|
9305
9387
|
if device_configuration is not None:
|
|
9306
9388
|
self._values["device_configuration"] = device_configuration
|
|
9389
|
+
if email_authentication_message is not None:
|
|
9390
|
+
self._values["email_authentication_message"] = email_authentication_message
|
|
9391
|
+
if email_authentication_subject is not None:
|
|
9392
|
+
self._values["email_authentication_subject"] = email_authentication_subject
|
|
9307
9393
|
if email_configuration is not None:
|
|
9308
9394
|
self._values["email_configuration"] = email_configuration
|
|
9309
9395
|
if email_verification_message is not None:
|
|
@@ -9358,7 +9444,11 @@ class CfnUserPoolProps:
|
|
|
9358
9444
|
def admin_create_user_config(
|
|
9359
9445
|
self,
|
|
9360
9446
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.AdminCreateUserConfigProperty]]:
|
|
9361
|
-
'''The
|
|
9447
|
+
'''The settings for administrator creation of users in a user pool.
|
|
9448
|
+
|
|
9449
|
+
Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
|
|
9450
|
+
|
|
9451
|
+
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>`_ .
|
|
9362
9452
|
|
|
9363
9453
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
|
|
9364
9454
|
'''
|
|
@@ -9419,6 +9509,22 @@ class CfnUserPoolProps:
|
|
|
9419
9509
|
result = self._values.get("device_configuration")
|
|
9420
9510
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.DeviceConfigurationProperty]], result)
|
|
9421
9511
|
|
|
9512
|
+
@builtins.property
|
|
9513
|
+
def email_authentication_message(self) -> typing.Optional[builtins.str]:
|
|
9514
|
+
'''
|
|
9515
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage
|
|
9516
|
+
'''
|
|
9517
|
+
result = self._values.get("email_authentication_message")
|
|
9518
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
9519
|
+
|
|
9520
|
+
@builtins.property
|
|
9521
|
+
def email_authentication_subject(self) -> typing.Optional[builtins.str]:
|
|
9522
|
+
'''
|
|
9523
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject
|
|
9524
|
+
'''
|
|
9525
|
+
result = self._values.get("email_authentication_subject")
|
|
9526
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
9527
|
+
|
|
9422
9528
|
@builtins.property
|
|
9423
9529
|
def email_configuration(
|
|
9424
9530
|
self,
|
|
@@ -9474,15 +9580,9 @@ class CfnUserPoolProps:
|
|
|
9474
9580
|
def lambda_config(
|
|
9475
9581
|
self,
|
|
9476
9582
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.LambdaConfigProperty]]:
|
|
9477
|
-
'''
|
|
9583
|
+
'''A collection of user pool Lambda triggers.
|
|
9478
9584
|
|
|
9479
|
-
|
|
9480
|
-
|
|
9481
|
-
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
|
|
9482
|
-
|
|
9483
|
-
For more information on using the Lambda API to add permission, see `AddPermission <https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html>`_ .
|
|
9484
|
-
|
|
9485
|
-
For adding permission using the AWS CLI , see `add-permission <https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html>`_ .
|
|
9585
|
+
Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
|
|
9486
9586
|
|
|
9487
9587
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig
|
|
9488
9588
|
'''
|
|
@@ -9506,7 +9606,9 @@ class CfnUserPoolProps:
|
|
|
9506
9606
|
def policies(
|
|
9507
9607
|
self,
|
|
9508
9608
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.PoliciesProperty]]:
|
|
9509
|
-
'''
|
|
9609
|
+
'''A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
9610
|
+
|
|
9611
|
+
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>`_ .
|
|
9510
9612
|
|
|
9511
9613
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
|
|
9512
9614
|
'''
|
|
@@ -9641,7 +9743,9 @@ class CfnUserPoolProps:
|
|
|
9641
9743
|
def verification_message_template(
|
|
9642
9744
|
self,
|
|
9643
9745
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.VerificationMessageTemplateProperty]]:
|
|
9644
|
-
'''The template for the verification message that
|
|
9746
|
+
'''The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
|
|
9747
|
+
|
|
9748
|
+
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.
|
|
9645
9749
|
|
|
9646
9750
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate
|
|
9647
9751
|
'''
|
|
@@ -9830,10 +9934,14 @@ class CfnUserPoolResourceServer(
|
|
|
9830
9934
|
scope_description: builtins.str,
|
|
9831
9935
|
scope_name: builtins.str,
|
|
9832
9936
|
) -> None:
|
|
9833
|
-
'''
|
|
9937
|
+
'''One custom scope associated with a user pool resource server.
|
|
9938
|
+
|
|
9939
|
+
This data type is a member of ``ResourceServerScopeType`` . For more information, see `Scopes, M2M, and API authorization with resource servers <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html>`_ .
|
|
9834
9940
|
|
|
9835
|
-
|
|
9836
|
-
|
|
9941
|
+
This data type is a request parameter of `CreateResourceServer <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html>`_ and a response parameter of `DescribeResourceServer <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html>`_ .
|
|
9942
|
+
|
|
9943
|
+
:param scope_description: A friendly description of a custom scope.
|
|
9944
|
+
:param scope_name: The name of the scope. Amazon Cognito renders custom scopes in the format ``resourceServerIdentifier/ScopeName`` . For example, if this parameter is ``exampleScope`` in the resource server with the identifier ``exampleResourceServer`` , you request and receive the scope ``exampleResourceServer/exampleScope`` .
|
|
9837
9945
|
|
|
9838
9946
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html
|
|
9839
9947
|
:exampleMetadata: fixture=_generated
|
|
@@ -9860,7 +9968,7 @@ class CfnUserPoolResourceServer(
|
|
|
9860
9968
|
|
|
9861
9969
|
@builtins.property
|
|
9862
9970
|
def scope_description(self) -> builtins.str:
|
|
9863
|
-
'''A description of
|
|
9971
|
+
'''A friendly description of a custom scope.
|
|
9864
9972
|
|
|
9865
9973
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription
|
|
9866
9974
|
'''
|
|
@@ -9872,6 +9980,8 @@ class CfnUserPoolResourceServer(
|
|
|
9872
9980
|
def scope_name(self) -> builtins.str:
|
|
9873
9981
|
'''The name of the scope.
|
|
9874
9982
|
|
|
9983
|
+
Amazon Cognito renders custom scopes in the format ``resourceServerIdentifier/ScopeName`` . For example, if this parameter is ``exampleScope`` in the resource server with the identifier ``exampleResourceServer`` , you request and receive the scope ``exampleResourceServer/exampleScope`` .
|
|
9984
|
+
|
|
9875
9985
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename
|
|
9876
9986
|
'''
|
|
9877
9987
|
result = self._values.get("scope_name")
|
|
@@ -10109,10 +10219,10 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10109
10219
|
:param scope: Scope in which this resource is defined.
|
|
10110
10220
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
10111
10221
|
:param client_id: The app client ID. You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ``ALL`` ).
|
|
10112
|
-
:param user_pool_id: The user pool
|
|
10113
|
-
:param account_takeover_risk_configuration: The
|
|
10114
|
-
:param compromised_credentials_risk_configuration:
|
|
10115
|
-
:param risk_exception_configuration:
|
|
10222
|
+
:param user_pool_id: The ID of the user pool that has the risk configuration applied.
|
|
10223
|
+
:param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
10224
|
+
:param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
|
|
10225
|
+
:param risk_exception_configuration: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
10116
10226
|
'''
|
|
10117
10227
|
if __debug__:
|
|
10118
10228
|
type_hints = typing.get_type_hints(_typecheckingstub__e3245a667ca916eabc555ef843b4a36bfcb47060fa353bd730066a76dcad5a96)
|
|
@@ -10179,7 +10289,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10179
10289
|
@builtins.property
|
|
10180
10290
|
@jsii.member(jsii_name="userPoolId")
|
|
10181
10291
|
def user_pool_id(self) -> builtins.str:
|
|
10182
|
-
'''The user pool
|
|
10292
|
+
'''The ID of the user pool that has the risk configuration applied.'''
|
|
10183
10293
|
return typing.cast(builtins.str, jsii.get(self, "userPoolId"))
|
|
10184
10294
|
|
|
10185
10295
|
@user_pool_id.setter
|
|
@@ -10194,7 +10304,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10194
10304
|
def account_takeover_risk_configuration(
|
|
10195
10305
|
self,
|
|
10196
10306
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]]:
|
|
10197
|
-
'''The
|
|
10307
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.'''
|
|
10198
10308
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]], jsii.get(self, "accountTakeoverRiskConfiguration"))
|
|
10199
10309
|
|
|
10200
10310
|
@account_takeover_risk_configuration.setter
|
|
@@ -10212,7 +10322,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10212
10322
|
def compromised_credentials_risk_configuration(
|
|
10213
10323
|
self,
|
|
10214
10324
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]]:
|
|
10215
|
-
'''
|
|
10325
|
+
'''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.'''
|
|
10216
10326
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]], jsii.get(self, "compromisedCredentialsRiskConfiguration"))
|
|
10217
10327
|
|
|
10218
10328
|
@compromised_credentials_risk_configuration.setter
|
|
@@ -10230,7 +10340,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10230
10340
|
def risk_exception_configuration(
|
|
10231
10341
|
self,
|
|
10232
10342
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty"]]:
|
|
10233
|
-
'''
|
|
10343
|
+
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.'''
|
|
10234
10344
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty"]], jsii.get(self, "riskExceptionConfiguration"))
|
|
10235
10345
|
|
|
10236
10346
|
@risk_exception_configuration.setter
|
|
@@ -10255,10 +10365,14 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10255
10365
|
event_action: builtins.str,
|
|
10256
10366
|
notify: typing.Union[builtins.bool, _IResolvable_da3f097b],
|
|
10257
10367
|
) -> None:
|
|
10258
|
-
'''
|
|
10368
|
+
'''The automated response to a risk level for adaptive authentication in full-function, or ``ENFORCED`` , mode.
|
|
10259
10369
|
|
|
10260
|
-
|
|
10261
|
-
|
|
10370
|
+
You can assign an action to each risk level that advanced security features evaluates.
|
|
10371
|
+
|
|
10372
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10373
|
+
|
|
10374
|
+
:param event_action: The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows: - ``BLOCK`` : Block the request. - ``MFA_IF_CONFIGURED`` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request. - ``MFA_REQUIRED`` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor. - ``NO_ACTION`` : Take no action. Permit sign-in.
|
|
10375
|
+
:param notify: Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
|
|
10262
10376
|
|
|
10263
10377
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html
|
|
10264
10378
|
:exampleMetadata: fixture=_generated
|
|
@@ -10285,12 +10399,14 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10285
10399
|
|
|
10286
10400
|
@builtins.property
|
|
10287
10401
|
def event_action(self) -> builtins.str:
|
|
10288
|
-
'''The action to take
|
|
10402
|
+
'''The action to take for the attempted account takeover action for the associated risk level.
|
|
10289
10403
|
|
|
10290
|
-
|
|
10291
|
-
|
|
10292
|
-
- ``
|
|
10293
|
-
- ``
|
|
10404
|
+
Valid values are as follows:
|
|
10405
|
+
|
|
10406
|
+
- ``BLOCK`` : Block the request.
|
|
10407
|
+
- ``MFA_IF_CONFIGURED`` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
|
|
10408
|
+
- ``MFA_REQUIRED`` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
|
|
10409
|
+
- ``NO_ACTION`` : Take no action. Permit sign-in.
|
|
10294
10410
|
|
|
10295
10411
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction
|
|
10296
10412
|
'''
|
|
@@ -10300,7 +10416,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10300
10416
|
|
|
10301
10417
|
@builtins.property
|
|
10302
10418
|
def notify(self) -> typing.Union[builtins.bool, _IResolvable_da3f097b]:
|
|
10303
|
-
'''
|
|
10419
|
+
'''Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
|
|
10304
10420
|
|
|
10305
10421
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify
|
|
10306
10422
|
'''
|
|
@@ -10336,11 +10452,13 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10336
10452
|
low_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10337
10453
|
medium_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10338
10454
|
) -> None:
|
|
10339
|
-
'''
|
|
10455
|
+
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
10456
|
+
|
|
10457
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10340
10458
|
|
|
10341
|
-
:param high_action:
|
|
10342
|
-
:param low_action:
|
|
10343
|
-
:param medium_action:
|
|
10459
|
+
:param high_action: The action that you assign to a high-risk assessment by advanced security features.
|
|
10460
|
+
:param low_action: The action that you assign to a low-risk assessment by advanced security features.
|
|
10461
|
+
:param medium_action: The action that you assign to a medium-risk assessment by advanced security features.
|
|
10344
10462
|
|
|
10345
10463
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html
|
|
10346
10464
|
:exampleMetadata: fixture=_generated
|
|
@@ -10383,7 +10501,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10383
10501
|
def high_action(
|
|
10384
10502
|
self,
|
|
10385
10503
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10386
|
-
'''
|
|
10504
|
+
'''The action that you assign to a high-risk assessment by advanced security features.
|
|
10387
10505
|
|
|
10388
10506
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction
|
|
10389
10507
|
'''
|
|
@@ -10394,7 +10512,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10394
10512
|
def low_action(
|
|
10395
10513
|
self,
|
|
10396
10514
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10397
|
-
'''
|
|
10515
|
+
'''The action that you assign to a low-risk assessment by advanced security features.
|
|
10398
10516
|
|
|
10399
10517
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction
|
|
10400
10518
|
'''
|
|
@@ -10405,7 +10523,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10405
10523
|
def medium_action(
|
|
10406
10524
|
self,
|
|
10407
10525
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10408
|
-
'''
|
|
10526
|
+
'''The action that you assign to a medium-risk assessment by advanced security features.
|
|
10409
10527
|
|
|
10410
10528
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction
|
|
10411
10529
|
'''
|
|
@@ -10438,10 +10556,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10438
10556
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
10439
10557
|
notify_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10440
10558
|
) -> None:
|
|
10441
|
-
'''
|
|
10559
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
10442
10560
|
|
|
10443
|
-
|
|
10444
|
-
|
|
10561
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10562
|
+
|
|
10563
|
+
:param actions: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
10564
|
+
:param notify_configuration: The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication. When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
|
|
10445
10565
|
|
|
10446
10566
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html
|
|
10447
10567
|
:exampleMetadata: fixture=_generated
|
|
@@ -10513,7 +10633,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10513
10633
|
def actions(
|
|
10514
10634
|
self,
|
|
10515
10635
|
) -> typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty"]:
|
|
10516
|
-
'''
|
|
10636
|
+
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
10517
10637
|
|
|
10518
10638
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions
|
|
10519
10639
|
'''
|
|
@@ -10525,7 +10645,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10525
10645
|
def notify_configuration(
|
|
10526
10646
|
self,
|
|
10527
10647
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty"]]:
|
|
10528
|
-
'''The
|
|
10648
|
+
'''The settings for composing and sending an email message when advanced security features assesses a risk level with adaptive authentication.
|
|
10649
|
+
|
|
10650
|
+
When you choose to notify users in ``AccountTakeoverRiskConfiguration`` , Amazon Cognito sends an email message using the method and template that you set with this data type.
|
|
10529
10651
|
|
|
10530
10652
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration
|
|
10531
10653
|
'''
|
|
@@ -10550,9 +10672,11 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10550
10672
|
)
|
|
10551
10673
|
class CompromisedCredentialsActionsTypeProperty:
|
|
10552
10674
|
def __init__(self, *, event_action: builtins.str) -> None:
|
|
10553
|
-
'''
|
|
10675
|
+
'''Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ``ENFORCED`` mode.
|
|
10554
10676
|
|
|
10555
|
-
|
|
10677
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10678
|
+
|
|
10679
|
+
:param event_action: The action that Amazon Cognito takes when it detects compromised credentials.
|
|
10556
10680
|
|
|
10557
10681
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html
|
|
10558
10682
|
:exampleMetadata: fixture=_generated
|
|
@@ -10576,7 +10700,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10576
10700
|
|
|
10577
10701
|
@builtins.property
|
|
10578
10702
|
def event_action(self) -> builtins.str:
|
|
10579
|
-
'''The
|
|
10703
|
+
'''The action that Amazon Cognito takes when it detects compromised credentials.
|
|
10580
10704
|
|
|
10581
10705
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction
|
|
10582
10706
|
'''
|
|
@@ -10607,10 +10731,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10607
10731
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
10608
10732
|
event_filter: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10609
10733
|
) -> None:
|
|
10610
|
-
'''
|
|
10734
|
+
'''Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function ``ENFORCED`` mode.
|
|
10735
|
+
|
|
10736
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10611
10737
|
|
|
10612
|
-
:param actions:
|
|
10613
|
-
:param event_filter:
|
|
10738
|
+
:param actions: Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
|
|
10739
|
+
:param event_filter: Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.
|
|
10614
10740
|
|
|
10615
10741
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html
|
|
10616
10742
|
:exampleMetadata: fixture=_generated
|
|
@@ -10644,7 +10770,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10644
10770
|
def actions(
|
|
10645
10771
|
self,
|
|
10646
10772
|
) -> typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty"]:
|
|
10647
|
-
'''
|
|
10773
|
+
'''Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
|
|
10648
10774
|
|
|
10649
10775
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions
|
|
10650
10776
|
'''
|
|
@@ -10654,9 +10780,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10654
10780
|
|
|
10655
10781
|
@builtins.property
|
|
10656
10782
|
def event_filter(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10657
|
-
'''
|
|
10783
|
+
'''Settings for the sign-in activity where you want to configure compromised-credentials actions.
|
|
10658
10784
|
|
|
10659
|
-
|
|
10785
|
+
Defaults to all events.
|
|
10660
10786
|
|
|
10661
10787
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter
|
|
10662
10788
|
'''
|
|
@@ -10697,14 +10823,16 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10697
10823
|
no_action_email: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10698
10824
|
reply_to: typing.Optional[builtins.str] = None,
|
|
10699
10825
|
) -> None:
|
|
10700
|
-
'''The
|
|
10826
|
+
'''The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a *Notify* action.
|
|
10827
|
+
|
|
10828
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10701
10829
|
|
|
10702
10830
|
:param source_arn: The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the ``From`` parameter.
|
|
10703
|
-
:param block_email:
|
|
10704
|
-
:param from_: The email address that
|
|
10705
|
-
:param mfa_email: The
|
|
10706
|
-
:param no_action_email: The email
|
|
10707
|
-
:param reply_to: The
|
|
10831
|
+
:param block_email: The template for the email message that your user pool sends when a detected risk event is blocked.
|
|
10832
|
+
:param from_: The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
|
|
10833
|
+
:param mfa_email: The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
|
|
10834
|
+
:param no_action_email: The template for the email message that your user pool sends when no action is taken in response to a detected risk.
|
|
10835
|
+
:param reply_to: The reply-to email address of an email template.
|
|
10708
10836
|
|
|
10709
10837
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html
|
|
10710
10838
|
:exampleMetadata: fixture=_generated
|
|
@@ -10782,7 +10910,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10782
10910
|
def block_email(
|
|
10783
10911
|
self,
|
|
10784
10912
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10785
|
-
'''
|
|
10913
|
+
'''The template for the email message that your user pool sends when a detected risk event is blocked.
|
|
10786
10914
|
|
|
10787
10915
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail
|
|
10788
10916
|
'''
|
|
@@ -10791,7 +10919,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10791
10919
|
|
|
10792
10920
|
@builtins.property
|
|
10793
10921
|
def from_(self) -> typing.Optional[builtins.str]:
|
|
10794
|
-
'''The email address that
|
|
10922
|
+
'''The email address that sends the email message.
|
|
10795
10923
|
|
|
10796
10924
|
The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
|
|
10797
10925
|
|
|
@@ -10804,7 +10932,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10804
10932
|
def mfa_email(
|
|
10805
10933
|
self,
|
|
10806
10934
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10807
|
-
'''The
|
|
10935
|
+
'''The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
|
|
10808
10936
|
|
|
10809
10937
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail
|
|
10810
10938
|
'''
|
|
@@ -10815,7 +10943,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10815
10943
|
def no_action_email(
|
|
10816
10944
|
self,
|
|
10817
10945
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10818
|
-
'''The email
|
|
10946
|
+
'''The template for the email message that your user pool sends when no action is taken in response to a detected risk.
|
|
10819
10947
|
|
|
10820
10948
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail
|
|
10821
10949
|
'''
|
|
@@ -10824,7 +10952,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10824
10952
|
|
|
10825
10953
|
@builtins.property
|
|
10826
10954
|
def reply_to(self) -> typing.Optional[builtins.str]:
|
|
10827
|
-
'''The
|
|
10955
|
+
'''The reply-to email address of an email template.
|
|
10828
10956
|
|
|
10829
10957
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto
|
|
10830
10958
|
'''
|
|
@@ -10859,11 +10987,13 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10859
10987
|
html_body: typing.Optional[builtins.str] = None,
|
|
10860
10988
|
text_body: typing.Optional[builtins.str] = None,
|
|
10861
10989
|
) -> None:
|
|
10862
|
-
'''The
|
|
10990
|
+
'''The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
|
|
10991
|
+
|
|
10992
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10863
10993
|
|
|
10864
|
-
:param subject: The email
|
|
10865
|
-
:param html_body: The email HTML
|
|
10866
|
-
:param text_body: The email
|
|
10994
|
+
:param subject: The subject of the threat protection email notification.
|
|
10995
|
+
:param html_body: The body of an email notification formatted in HTML. Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
|
|
10996
|
+
:param text_body: The body of an email notification formatted in plaintext. Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
|
|
10867
10997
|
|
|
10868
10998
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html
|
|
10869
10999
|
:exampleMetadata: fixture=_generated
|
|
@@ -10897,7 +11027,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10897
11027
|
|
|
10898
11028
|
@builtins.property
|
|
10899
11029
|
def subject(self) -> builtins.str:
|
|
10900
|
-
'''The email
|
|
11030
|
+
'''The subject of the threat protection email notification.
|
|
10901
11031
|
|
|
10902
11032
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject
|
|
10903
11033
|
'''
|
|
@@ -10907,7 +11037,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10907
11037
|
|
|
10908
11038
|
@builtins.property
|
|
10909
11039
|
def html_body(self) -> typing.Optional[builtins.str]:
|
|
10910
|
-
'''The email HTML
|
|
11040
|
+
'''The body of an email notification formatted in HTML.
|
|
11041
|
+
|
|
11042
|
+
Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
|
|
10911
11043
|
|
|
10912
11044
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody
|
|
10913
11045
|
'''
|
|
@@ -10916,7 +11048,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10916
11048
|
|
|
10917
11049
|
@builtins.property
|
|
10918
11050
|
def text_body(self) -> typing.Optional[builtins.str]:
|
|
10919
|
-
'''The email
|
|
11051
|
+
'''The body of an email notification formatted in plaintext.
|
|
11052
|
+
|
|
11053
|
+
Choose an ``HtmlBody`` or a ``TextBody`` to send an HTML-formatted or plaintext message, respectively.
|
|
10920
11054
|
|
|
10921
11055
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody
|
|
10922
11056
|
'''
|
|
@@ -10949,10 +11083,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10949
11083
|
blocked_ip_range_list: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10950
11084
|
skipped_ip_range_list: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10951
11085
|
) -> None:
|
|
10952
|
-
'''
|
|
11086
|
+
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
11087
|
+
|
|
11088
|
+
This data type is a request parameter of `SetRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html>`_ and a response parameter of `DescribeRiskConfiguration <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html>`_ .
|
|
10953
11089
|
|
|
10954
|
-
:param blocked_ip_range_list: Overrides the risk decision
|
|
10955
|
-
:param skipped_ip_range_list: Risk detection isn't performed on the IP addresses in this range list.
|
|
11090
|
+
:param blocked_ip_range_list: An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
|
|
11091
|
+
:param skipped_ip_range_list: An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
|
|
10956
11092
|
|
|
10957
11093
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html
|
|
10958
11094
|
:exampleMetadata: fixture=_generated
|
|
@@ -10980,9 +11116,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10980
11116
|
|
|
10981
11117
|
@builtins.property
|
|
10982
11118
|
def blocked_ip_range_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10983
|
-
'''
|
|
11119
|
+
'''An always-block IP address list.
|
|
10984
11120
|
|
|
10985
|
-
|
|
11121
|
+
Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
|
|
10986
11122
|
|
|
10987
11123
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist
|
|
10988
11124
|
'''
|
|
@@ -10991,9 +11127,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10991
11127
|
|
|
10992
11128
|
@builtins.property
|
|
10993
11129
|
def skipped_ip_range_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10994
|
-
'''
|
|
11130
|
+
'''An always-allow IP address list.
|
|
10995
11131
|
|
|
10996
|
-
|
|
11132
|
+
Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
|
|
10997
11133
|
|
|
10998
11134
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist
|
|
10999
11135
|
'''
|
|
@@ -11036,10 +11172,10 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11036
11172
|
'''Properties for defining a ``CfnUserPoolRiskConfigurationAttachment``.
|
|
11037
11173
|
|
|
11038
11174
|
:param client_id: The app client ID. You can specify the risk configuration for a single client (with a specific ClientId) or for all clients (by setting the ClientId to ``ALL`` ).
|
|
11039
|
-
:param user_pool_id: The user pool
|
|
11040
|
-
:param account_takeover_risk_configuration: The
|
|
11041
|
-
:param compromised_credentials_risk_configuration:
|
|
11042
|
-
:param risk_exception_configuration:
|
|
11175
|
+
:param user_pool_id: The ID of the user pool that has the risk configuration applied.
|
|
11176
|
+
:param account_takeover_risk_configuration: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
11177
|
+
:param compromised_credentials_risk_configuration: Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
|
|
11178
|
+
:param risk_exception_configuration: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
11043
11179
|
|
|
11044
11180
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html
|
|
11045
11181
|
:exampleMetadata: fixture=_generated
|
|
@@ -11147,7 +11283,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11147
11283
|
|
|
11148
11284
|
@builtins.property
|
|
11149
11285
|
def user_pool_id(self) -> builtins.str:
|
|
11150
|
-
'''The user pool
|
|
11286
|
+
'''The ID of the user pool that has the risk configuration applied.
|
|
11151
11287
|
|
|
11152
11288
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid
|
|
11153
11289
|
'''
|
|
@@ -11159,7 +11295,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11159
11295
|
def account_takeover_risk_configuration(
|
|
11160
11296
|
self,
|
|
11161
11297
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty]]:
|
|
11162
|
-
'''The
|
|
11298
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
11163
11299
|
|
|
11164
11300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration
|
|
11165
11301
|
'''
|
|
@@ -11170,7 +11306,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11170
11306
|
def compromised_credentials_risk_configuration(
|
|
11171
11307
|
self,
|
|
11172
11308
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty]]:
|
|
11173
|
-
'''
|
|
11309
|
+
'''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
|
|
11174
11310
|
|
|
11175
11311
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration
|
|
11176
11312
|
'''
|
|
@@ -11181,7 +11317,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11181
11317
|
def risk_exception_configuration(
|
|
11182
11318
|
self,
|
|
11183
11319
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty]]:
|
|
11184
|
-
'''
|
|
11320
|
+
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
11185
11321
|
|
|
11186
11322
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration
|
|
11187
11323
|
'''
|
|
@@ -11683,7 +11819,9 @@ class CfnUserPoolUser(
|
|
|
11683
11819
|
name: typing.Optional[builtins.str] = None,
|
|
11684
11820
|
value: typing.Optional[builtins.str] = None,
|
|
11685
11821
|
) -> None:
|
|
11686
|
-
'''
|
|
11822
|
+
'''The name and value of a user attribute.
|
|
11823
|
+
|
|
11824
|
+
This data type is a request parameter of `AdminUpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ and `UpdateUserAttributes <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html>`_ .
|
|
11687
11825
|
|
|
11688
11826
|
:param name: The name of the attribute.
|
|
11689
11827
|
:param value: The value of the attribute.
|
|
@@ -17740,15 +17878,16 @@ class UserPoolIdentityProviderApple(
|
|
|
17740
17878
|
|
|
17741
17879
|
# The code below shows an example of how to instantiate this type.
|
|
17742
17880
|
# The values are placeholders you should change.
|
|
17881
|
+
import aws_cdk as cdk
|
|
17743
17882
|
from aws_cdk import aws_cognito as cognito
|
|
17744
17883
|
|
|
17745
17884
|
# provider_attribute: cognito.ProviderAttribute
|
|
17885
|
+
# secret_value: cdk.SecretValue
|
|
17746
17886
|
# user_pool: cognito.UserPool
|
|
17747
17887
|
|
|
17748
17888
|
user_pool_identity_provider_apple = cognito.UserPoolIdentityProviderApple(self, "MyUserPoolIdentityProviderApple",
|
|
17749
17889
|
client_id="clientId",
|
|
17750
17890
|
key_id="keyId",
|
|
17751
|
-
private_key="privateKey",
|
|
17752
17891
|
team_id="teamId",
|
|
17753
17892
|
user_pool=user_pool,
|
|
17754
17893
|
|
|
@@ -17775,6 +17914,8 @@ class UserPoolIdentityProviderApple(
|
|
|
17775
17914
|
timezone=provider_attribute,
|
|
17776
17915
|
website=provider_attribute
|
|
17777
17916
|
),
|
|
17917
|
+
private_key="privateKey",
|
|
17918
|
+
private_key_value=secret_value,
|
|
17778
17919
|
scopes=["scopes"]
|
|
17779
17920
|
)
|
|
17780
17921
|
'''
|
|
@@ -17786,8 +17927,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17786
17927
|
*,
|
|
17787
17928
|
client_id: builtins.str,
|
|
17788
17929
|
key_id: builtins.str,
|
|
17789
|
-
private_key: builtins.str,
|
|
17790
17930
|
team_id: builtins.str,
|
|
17931
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
17932
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
17791
17933
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
17792
17934
|
user_pool: IUserPool,
|
|
17793
17935
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -17797,8 +17939,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17797
17939
|
:param id: -
|
|
17798
17940
|
:param client_id: The client id recognized by Apple APIs.
|
|
17799
17941
|
:param key_id: The keyId (of the same key, which content has to be later supplied as ``privateKey``) for Apple APIs to authenticate the client.
|
|
17800
|
-
:param private_key: The privateKey content for Apple APIs to authenticate the client.
|
|
17801
17942
|
:param team_id: The teamId for Apple APIs to authenticate the client.
|
|
17943
|
+
:param private_key: (deprecated) The privateKey content for Apple APIs to authenticate the client. Default: none
|
|
17944
|
+
:param private_key_value: The privateKey content for Apple APIs to authenticate the client. Default: none
|
|
17802
17945
|
:param scopes: The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]
|
|
17803
17946
|
:param user_pool: The user pool to which this construct provides identities.
|
|
17804
17947
|
:param attribute_mapping: Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping
|
|
@@ -17810,8 +17953,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17810
17953
|
props = UserPoolIdentityProviderAppleProps(
|
|
17811
17954
|
client_id=client_id,
|
|
17812
17955
|
key_id=key_id,
|
|
17813
|
-
private_key=private_key,
|
|
17814
17956
|
team_id=team_id,
|
|
17957
|
+
private_key=private_key,
|
|
17958
|
+
private_key_value=private_key_value,
|
|
17815
17959
|
scopes=scopes,
|
|
17816
17960
|
user_pool=user_pool,
|
|
17817
17961
|
attribute_mapping=attribute_mapping,
|
|
@@ -20339,8 +20483,9 @@ class UserPoolIdentityProviderAmazonProps(UserPoolIdentityProviderProps):
|
|
|
20339
20483
|
"attribute_mapping": "attributeMapping",
|
|
20340
20484
|
"client_id": "clientId",
|
|
20341
20485
|
"key_id": "keyId",
|
|
20342
|
-
"private_key": "privateKey",
|
|
20343
20486
|
"team_id": "teamId",
|
|
20487
|
+
"private_key": "privateKey",
|
|
20488
|
+
"private_key_value": "privateKeyValue",
|
|
20344
20489
|
"scopes": "scopes",
|
|
20345
20490
|
},
|
|
20346
20491
|
)
|
|
@@ -20352,8 +20497,9 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20352
20497
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20353
20498
|
client_id: builtins.str,
|
|
20354
20499
|
key_id: builtins.str,
|
|
20355
|
-
private_key: builtins.str,
|
|
20356
20500
|
team_id: builtins.str,
|
|
20501
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
20502
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
20357
20503
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
20358
20504
|
) -> None:
|
|
20359
20505
|
'''Properties to initialize UserPoolAppleIdentityProvider.
|
|
@@ -20362,8 +20508,9 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20362
20508
|
:param attribute_mapping: Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping
|
|
20363
20509
|
:param client_id: The client id recognized by Apple APIs.
|
|
20364
20510
|
:param key_id: The keyId (of the same key, which content has to be later supplied as ``privateKey``) for Apple APIs to authenticate the client.
|
|
20365
|
-
:param private_key: The privateKey content for Apple APIs to authenticate the client.
|
|
20366
20511
|
:param team_id: The teamId for Apple APIs to authenticate the client.
|
|
20512
|
+
:param private_key: (deprecated) The privateKey content for Apple APIs to authenticate the client. Default: none
|
|
20513
|
+
:param private_key_value: The privateKey content for Apple APIs to authenticate the client. Default: none
|
|
20367
20514
|
:param scopes: The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]
|
|
20368
20515
|
|
|
20369
20516
|
:exampleMetadata: fixture=_generated
|
|
@@ -20372,15 +20519,16 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20372
20519
|
|
|
20373
20520
|
# The code below shows an example of how to instantiate this type.
|
|
20374
20521
|
# The values are placeholders you should change.
|
|
20522
|
+
import aws_cdk as cdk
|
|
20375
20523
|
from aws_cdk import aws_cognito as cognito
|
|
20376
20524
|
|
|
20377
20525
|
# provider_attribute: cognito.ProviderAttribute
|
|
20526
|
+
# secret_value: cdk.SecretValue
|
|
20378
20527
|
# user_pool: cognito.UserPool
|
|
20379
20528
|
|
|
20380
20529
|
user_pool_identity_provider_apple_props = cognito.UserPoolIdentityProviderAppleProps(
|
|
20381
20530
|
client_id="clientId",
|
|
20382
20531
|
key_id="keyId",
|
|
20383
|
-
private_key="privateKey",
|
|
20384
20532
|
team_id="teamId",
|
|
20385
20533
|
user_pool=user_pool,
|
|
20386
20534
|
|
|
@@ -20407,6 +20555,8 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20407
20555
|
timezone=provider_attribute,
|
|
20408
20556
|
website=provider_attribute
|
|
20409
20557
|
),
|
|
20558
|
+
private_key="privateKey",
|
|
20559
|
+
private_key_value=secret_value,
|
|
20410
20560
|
scopes=["scopes"]
|
|
20411
20561
|
)
|
|
20412
20562
|
'''
|
|
@@ -20418,18 +20568,22 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20418
20568
|
check_type(argname="argument attribute_mapping", value=attribute_mapping, expected_type=type_hints["attribute_mapping"])
|
|
20419
20569
|
check_type(argname="argument client_id", value=client_id, expected_type=type_hints["client_id"])
|
|
20420
20570
|
check_type(argname="argument key_id", value=key_id, expected_type=type_hints["key_id"])
|
|
20421
|
-
check_type(argname="argument private_key", value=private_key, expected_type=type_hints["private_key"])
|
|
20422
20571
|
check_type(argname="argument team_id", value=team_id, expected_type=type_hints["team_id"])
|
|
20572
|
+
check_type(argname="argument private_key", value=private_key, expected_type=type_hints["private_key"])
|
|
20573
|
+
check_type(argname="argument private_key_value", value=private_key_value, expected_type=type_hints["private_key_value"])
|
|
20423
20574
|
check_type(argname="argument scopes", value=scopes, expected_type=type_hints["scopes"])
|
|
20424
20575
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
20425
20576
|
"user_pool": user_pool,
|
|
20426
20577
|
"client_id": client_id,
|
|
20427
20578
|
"key_id": key_id,
|
|
20428
|
-
"private_key": private_key,
|
|
20429
20579
|
"team_id": team_id,
|
|
20430
20580
|
}
|
|
20431
20581
|
if attribute_mapping is not None:
|
|
20432
20582
|
self._values["attribute_mapping"] = attribute_mapping
|
|
20583
|
+
if private_key is not None:
|
|
20584
|
+
self._values["private_key"] = private_key
|
|
20585
|
+
if private_key_value is not None:
|
|
20586
|
+
self._values["private_key_value"] = private_key_value
|
|
20433
20587
|
if scopes is not None:
|
|
20434
20588
|
self._values["scopes"] = scopes
|
|
20435
20589
|
|
|
@@ -20466,13 +20620,6 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20466
20620
|
assert result is not None, "Required property 'key_id' is missing"
|
|
20467
20621
|
return typing.cast(builtins.str, result)
|
|
20468
20622
|
|
|
20469
|
-
@builtins.property
|
|
20470
|
-
def private_key(self) -> builtins.str:
|
|
20471
|
-
'''The privateKey content for Apple APIs to authenticate the client.'''
|
|
20472
|
-
result = self._values.get("private_key")
|
|
20473
|
-
assert result is not None, "Required property 'private_key' is missing"
|
|
20474
|
-
return typing.cast(builtins.str, result)
|
|
20475
|
-
|
|
20476
20623
|
@builtins.property
|
|
20477
20624
|
def team_id(self) -> builtins.str:
|
|
20478
20625
|
'''The teamId for Apple APIs to authenticate the client.'''
|
|
@@ -20480,6 +20627,28 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20480
20627
|
assert result is not None, "Required property 'team_id' is missing"
|
|
20481
20628
|
return typing.cast(builtins.str, result)
|
|
20482
20629
|
|
|
20630
|
+
@builtins.property
|
|
20631
|
+
def private_key(self) -> typing.Optional[builtins.str]:
|
|
20632
|
+
'''(deprecated) The privateKey content for Apple APIs to authenticate the client.
|
|
20633
|
+
|
|
20634
|
+
:default: none
|
|
20635
|
+
|
|
20636
|
+
:deprecated: use privateKeyValue
|
|
20637
|
+
|
|
20638
|
+
:stability: deprecated
|
|
20639
|
+
'''
|
|
20640
|
+
result = self._values.get("private_key")
|
|
20641
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
20642
|
+
|
|
20643
|
+
@builtins.property
|
|
20644
|
+
def private_key_value(self) -> typing.Optional[_SecretValue_3dd0ddae]:
|
|
20645
|
+
'''The privateKey content for Apple APIs to authenticate the client.
|
|
20646
|
+
|
|
20647
|
+
:default: none
|
|
20648
|
+
'''
|
|
20649
|
+
result = self._values.get("private_key_value")
|
|
20650
|
+
return typing.cast(typing.Optional[_SecretValue_3dd0ddae], result)
|
|
20651
|
+
|
|
20483
20652
|
@builtins.property
|
|
20484
20653
|
def scopes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
20485
20654
|
'''The list of apple permissions to obtain for getting access to the apple profile.
|
|
@@ -21566,6 +21735,8 @@ def _typecheckingstub__32d20f28e2758f9a461380e2ed5d06233baf0f45541047ba837f26ebc
|
|
|
21566
21735
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
21567
21736
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
21568
21737
|
device_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.DeviceConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
21738
|
+
email_authentication_message: typing.Optional[builtins.str] = None,
|
|
21739
|
+
email_authentication_subject: typing.Optional[builtins.str] = None,
|
|
21569
21740
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
21570
21741
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
21571
21742
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -21636,6 +21807,18 @@ def _typecheckingstub__7eb821a70b459056b6d26722d06f8b948b315111a936804d8aba0e7ff
|
|
|
21636
21807
|
"""Type checking stubs"""
|
|
21637
21808
|
pass
|
|
21638
21809
|
|
|
21810
|
+
def _typecheckingstub__3cf4765f879f49f79c6984252af6993fe6fdf6838989608b11e192c544fce53c(
|
|
21811
|
+
value: typing.Optional[builtins.str],
|
|
21812
|
+
) -> None:
|
|
21813
|
+
"""Type checking stubs"""
|
|
21814
|
+
pass
|
|
21815
|
+
|
|
21816
|
+
def _typecheckingstub__1e1d4523d17f0641e76142be67287be5dc758d191f5eba3fa217d8c5d0170791(
|
|
21817
|
+
value: typing.Optional[builtins.str],
|
|
21818
|
+
) -> None:
|
|
21819
|
+
"""Type checking stubs"""
|
|
21820
|
+
pass
|
|
21821
|
+
|
|
21639
21822
|
def _typecheckingstub__32d0b53f74dc294b25f20f54bcdaf8477a3dfc8b505387d70f97f7febe6ae209(
|
|
21640
21823
|
value: typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.EmailConfigurationProperty]],
|
|
21641
21824
|
) -> None:
|
|
@@ -22366,6 +22549,8 @@ def _typecheckingstub__00bbdbd31eb8d7342ce9883d0851b853acf61f6b243c0aa4323c025da
|
|
|
22366
22549
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
22367
22550
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
22368
22551
|
device_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.DeviceConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
22552
|
+
email_authentication_message: typing.Optional[builtins.str] = None,
|
|
22553
|
+
email_authentication_subject: typing.Optional[builtins.str] = None,
|
|
22369
22554
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
22370
22555
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
22371
22556
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -23370,8 +23555,9 @@ def _typecheckingstub__61dda0b78f30fe868c5e696b0c3d3ee7c446cd2575608fc4036cf6dac
|
|
|
23370
23555
|
*,
|
|
23371
23556
|
client_id: builtins.str,
|
|
23372
23557
|
key_id: builtins.str,
|
|
23373
|
-
private_key: builtins.str,
|
|
23374
23558
|
team_id: builtins.str,
|
|
23559
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
23560
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
23375
23561
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
23376
23562
|
user_pool: IUserPool,
|
|
23377
23563
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -23611,8 +23797,9 @@ def _typecheckingstub__ca5d3950db19200b5bbdc4fb3e51e3c9b38fc4572683061b8e4485d0f
|
|
|
23611
23797
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23612
23798
|
client_id: builtins.str,
|
|
23613
23799
|
key_id: builtins.str,
|
|
23614
|
-
private_key: builtins.str,
|
|
23615
23800
|
team_id: builtins.str,
|
|
23801
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
23802
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
23616
23803
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
23617
23804
|
) -> None:
|
|
23618
23805
|
"""Type checking stubs"""
|