aws-cdk-lib 2.157.0__py3-none-any.whl → 2.159.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +52 -20
- aws_cdk/_jsii/__init__.py +17 -2
- aws_cdk/_jsii/{aws-cdk-lib@2.157.0.jsii.tgz → aws-cdk-lib@2.159.0.jsii.tgz} +0 -0
- aws_cdk/alexa_ask/__init__.py +16 -1
- aws_cdk/assertions/__init__.py +16 -1
- aws_cdk/aws_accessanalyzer/__init__.py +16 -1
- aws_cdk/aws_acmpca/__init__.py +16 -1
- aws_cdk/aws_amazonmq/__init__.py +16 -1
- aws_cdk/aws_amplify/__init__.py +38 -9
- aws_cdk/aws_amplifyuibuilder/__init__.py +16 -1
- aws_cdk/aws_apigateway/__init__.py +16 -1
- aws_cdk/aws_apigatewayv2/__init__.py +46 -1
- aws_cdk/aws_apigatewayv2_authorizers/__init__.py +16 -1
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +16 -1
- aws_cdk/aws_appconfig/__init__.py +19 -4
- aws_cdk/aws_appflow/__init__.py +16 -1
- aws_cdk/aws_appintegrations/__init__.py +16 -1
- aws_cdk/aws_applicationautoscaling/__init__.py +16 -1
- aws_cdk/aws_applicationinsights/__init__.py +560 -5
- aws_cdk/aws_applicationsignals/__init__.py +186 -143
- aws_cdk/aws_appmesh/__init__.py +16 -1
- aws_cdk/aws_apprunner/__init__.py +16 -1
- aws_cdk/aws_appstream/__init__.py +16 -1
- aws_cdk/aws_appsync/__init__.py +16 -1
- aws_cdk/aws_apptest/__init__.py +16 -1
- aws_cdk/aws_aps/__init__.py +16 -1
- aws_cdk/aws_arczonalshift/__init__.py +16 -1
- aws_cdk/aws_athena/__init__.py +31 -16
- aws_cdk/aws_auditmanager/__init__.py +21 -6
- aws_cdk/aws_autoscaling/__init__.py +16 -1
- aws_cdk/aws_autoscaling_common/__init__.py +16 -1
- aws_cdk/aws_autoscaling_hooktargets/__init__.py +16 -1
- aws_cdk/aws_autoscalingplans/__init__.py +16 -1
- aws_cdk/aws_b2bi/__init__.py +16 -1
- aws_cdk/aws_backup/__init__.py +16 -1
- aws_cdk/aws_backupgateway/__init__.py +16 -1
- aws_cdk/aws_batch/__init__.py +16 -1
- aws_cdk/aws_bcmdataexports/__init__.py +16 -1
- aws_cdk/aws_bedrock/__init__.py +23 -8
- aws_cdk/aws_billingconductor/__init__.py +16 -1
- aws_cdk/aws_budgets/__init__.py +16 -1
- aws_cdk/aws_cassandra/__init__.py +16 -1
- aws_cdk/aws_ce/__init__.py +16 -1
- aws_cdk/aws_certificatemanager/__init__.py +16 -1
- aws_cdk/aws_chatbot/__init__.py +16 -1
- aws_cdk/aws_cleanrooms/__init__.py +16 -1
- aws_cdk/aws_cleanroomsml/__init__.py +16 -1
- aws_cdk/aws_cloud9/__init__.py +16 -1
- aws_cdk/aws_cloudformation/__init__.py +16 -1
- aws_cdk/aws_cloudfront/__init__.py +16 -1
- aws_cdk/aws_cloudfront/experimental/__init__.py +16 -1
- aws_cdk/aws_cloudfront_origins/__init__.py +16 -1
- aws_cdk/aws_cloudtrail/__init__.py +16 -1
- aws_cdk/aws_cloudwatch/__init__.py +16 -1
- aws_cdk/aws_cloudwatch_actions/__init__.py +16 -1
- aws_cdk/aws_codeartifact/__init__.py +16 -1
- aws_cdk/aws_codebuild/__init__.py +55 -19
- aws_cdk/aws_codecommit/__init__.py +16 -1
- aws_cdk/aws_codeconnections/__init__.py +17 -2
- aws_cdk/aws_codedeploy/__init__.py +16 -1
- aws_cdk/aws_codeguruprofiler/__init__.py +16 -1
- aws_cdk/aws_codegurureviewer/__init__.py +16 -1
- aws_cdk/aws_codepipeline/__init__.py +16 -1
- aws_cdk/aws_codepipeline_actions/__init__.py +16 -1
- aws_cdk/aws_codestar/__init__.py +16 -1
- aws_cdk/aws_codestarconnections/__init__.py +16 -1
- aws_cdk/aws_codestarnotifications/__init__.py +16 -1
- aws_cdk/aws_cognito/__init__.py +406 -204
- aws_cdk/aws_comprehend/__init__.py +16 -1
- aws_cdk/aws_config/__init__.py +16 -1
- aws_cdk/aws_connect/__init__.py +1695 -153
- aws_cdk/aws_connectcampaigns/__init__.py +16 -1
- aws_cdk/aws_controltower/__init__.py +16 -1
- aws_cdk/aws_cur/__init__.py +16 -1
- aws_cdk/aws_customerprofiles/__init__.py +16 -1
- aws_cdk/aws_databrew/__init__.py +16 -1
- aws_cdk/aws_datapipeline/__init__.py +16 -1
- aws_cdk/aws_datasync/__init__.py +16 -1
- aws_cdk/aws_datazone/__init__.py +681 -41
- aws_cdk/aws_dax/__init__.py +16 -1
- aws_cdk/aws_deadline/__init__.py +16 -1
- aws_cdk/aws_detective/__init__.py +16 -1
- aws_cdk/aws_devicefarm/__init__.py +16 -1
- aws_cdk/aws_devopsguru/__init__.py +16 -1
- aws_cdk/aws_directoryservice/__init__.py +16 -1
- aws_cdk/aws_dlm/__init__.py +16 -1
- aws_cdk/aws_dms/__init__.py +16 -1
- aws_cdk/aws_docdb/__init__.py +22 -2
- aws_cdk/aws_docdbelastic/__init__.py +16 -1
- aws_cdk/aws_dynamodb/__init__.py +21 -6
- aws_cdk/aws_ec2/__init__.py +137 -37
- aws_cdk/aws_ecr/__init__.py +30 -7
- aws_cdk/aws_ecr_assets/__init__.py +16 -1
- aws_cdk/aws_ecs/__init__.py +36 -21
- aws_cdk/aws_ecs_patterns/__init__.py +16 -1
- aws_cdk/aws_efs/__init__.py +16 -1
- aws_cdk/aws_eks/__init__.py +16 -1
- aws_cdk/aws_elasticache/__init__.py +16 -1
- aws_cdk/aws_elasticbeanstalk/__init__.py +16 -1
- aws_cdk/aws_elasticloadbalancing/__init__.py +16 -1
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +183 -21
- aws_cdk/aws_elasticloadbalancingv2_actions/__init__.py +16 -1
- aws_cdk/aws_elasticloadbalancingv2_targets/__init__.py +16 -1
- aws_cdk/aws_elasticsearch/__init__.py +16 -1
- aws_cdk/aws_emr/__init__.py +24 -9
- aws_cdk/aws_emrcontainers/__init__.py +16 -1
- aws_cdk/aws_emrserverless/__init__.py +16 -1
- aws_cdk/aws_entityresolution/__init__.py +16 -1
- aws_cdk/aws_events/__init__.py +35 -18
- aws_cdk/aws_events_targets/__init__.py +181 -86
- aws_cdk/aws_eventschemas/__init__.py +16 -1
- aws_cdk/aws_evidently/__init__.py +16 -1
- aws_cdk/aws_finspace/__init__.py +16 -1
- aws_cdk/aws_fis/__init__.py +16 -1
- aws_cdk/aws_fms/__init__.py +75 -1
- aws_cdk/aws_forecast/__init__.py +16 -1
- aws_cdk/aws_frauddetector/__init__.py +16 -1
- aws_cdk/aws_fsx/__init__.py +19 -4
- aws_cdk/aws_gamelift/__init__.py +56 -53
- aws_cdk/aws_globalaccelerator/__init__.py +38 -30
- aws_cdk/aws_globalaccelerator_endpoints/__init__.py +16 -1
- aws_cdk/aws_glue/__init__.py +16 -1
- aws_cdk/aws_grafana/__init__.py +16 -1
- aws_cdk/aws_greengrass/__init__.py +16 -1
- aws_cdk/aws_greengrassv2/__init__.py +16 -1
- aws_cdk/aws_groundstation/__init__.py +16 -1
- aws_cdk/aws_guardduty/__init__.py +16 -1
- aws_cdk/aws_healthimaging/__init__.py +16 -1
- aws_cdk/aws_healthlake/__init__.py +16 -1
- aws_cdk/aws_iam/__init__.py +38 -21
- aws_cdk/aws_identitystore/__init__.py +16 -1
- aws_cdk/aws_imagebuilder/__init__.py +16 -1
- aws_cdk/aws_inspector/__init__.py +16 -1
- aws_cdk/aws_inspectorv2/__init__.py +16 -1
- aws_cdk/aws_internetmonitor/__init__.py +16 -1
- aws_cdk/aws_iot/__init__.py +16 -1
- aws_cdk/aws_iot1click/__init__.py +16 -1
- aws_cdk/aws_iotanalytics/__init__.py +16 -1
- aws_cdk/aws_iotcoredeviceadvisor/__init__.py +16 -1
- aws_cdk/aws_iotevents/__init__.py +16 -1
- aws_cdk/aws_iotfleethub/__init__.py +16 -1
- aws_cdk/aws_iotfleetwise/__init__.py +435 -1
- aws_cdk/aws_iotsitewise/__init__.py +106 -2
- aws_cdk/aws_iotthingsgraph/__init__.py +16 -1
- aws_cdk/aws_iottwinmaker/__init__.py +16 -1
- aws_cdk/aws_iotwireless/__init__.py +221 -1
- aws_cdk/aws_ivs/__init__.py +16 -1
- aws_cdk/aws_ivschat/__init__.py +16 -1
- aws_cdk/aws_kafkaconnect/__init__.py +16 -1
- aws_cdk/aws_kendra/__init__.py +16 -1
- aws_cdk/aws_kendraranking/__init__.py +16 -1
- aws_cdk/aws_kinesis/__init__.py +16 -1
- aws_cdk/aws_kinesisanalytics/__init__.py +16 -1
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +16 -1
- aws_cdk/aws_kinesisfirehose/__init__.py +16 -1
- aws_cdk/aws_kinesisvideo/__init__.py +16 -1
- aws_cdk/aws_kms/__init__.py +16 -1
- aws_cdk/aws_lakeformation/__init__.py +16 -1
- aws_cdk/aws_lambda/__init__.py +145 -17
- aws_cdk/aws_lambda_destinations/__init__.py +16 -1
- aws_cdk/aws_lambda_event_sources/__init__.py +16 -1
- aws_cdk/aws_lambda_nodejs/__init__.py +16 -1
- aws_cdk/aws_launchwizard/__init__.py +16 -1
- aws_cdk/aws_lex/__init__.py +31 -2
- aws_cdk/aws_licensemanager/__init__.py +16 -1
- aws_cdk/aws_lightsail/__init__.py +16 -1
- aws_cdk/aws_location/__init__.py +16 -1
- aws_cdk/aws_logs/__init__.py +17 -2
- aws_cdk/aws_logs_destinations/__init__.py +16 -1
- aws_cdk/aws_lookoutequipment/__init__.py +16 -1
- aws_cdk/aws_lookoutmetrics/__init__.py +16 -1
- aws_cdk/aws_lookoutvision/__init__.py +16 -1
- aws_cdk/aws_m2/__init__.py +16 -1
- aws_cdk/aws_macie/__init__.py +16 -1
- aws_cdk/aws_managedblockchain/__init__.py +16 -1
- aws_cdk/aws_mediaconnect/__init__.py +127 -1
- aws_cdk/aws_mediaconvert/__init__.py +16 -1
- aws_cdk/aws_medialive/__init__.py +8004 -3263
- aws_cdk/aws_mediapackage/__init__.py +16 -1
- aws_cdk/aws_mediapackagev2/__init__.py +16 -1
- aws_cdk/aws_mediastore/__init__.py +16 -1
- aws_cdk/aws_mediatailor/__init__.py +16 -1
- aws_cdk/aws_memorydb/__init__.py +16 -1
- aws_cdk/aws_msk/__init__.py +303 -480
- aws_cdk/aws_mwaa/__init__.py +16 -1
- aws_cdk/aws_neptune/__init__.py +16 -1
- aws_cdk/aws_neptunegraph/__init__.py +16 -1
- aws_cdk/aws_networkfirewall/__init__.py +16 -1
- aws_cdk/aws_networkmanager/__init__.py +16 -1
- aws_cdk/aws_nimblestudio/__init__.py +16 -1
- aws_cdk/aws_oam/__init__.py +16 -1
- aws_cdk/aws_omics/__init__.py +16 -1
- aws_cdk/aws_opensearchserverless/__init__.py +16 -1
- aws_cdk/aws_opensearchservice/__init__.py +22 -1
- aws_cdk/aws_opsworks/__init__.py +16 -1
- aws_cdk/aws_opsworkscm/__init__.py +16 -1
- aws_cdk/aws_organizations/__init__.py +16 -1
- aws_cdk/aws_osis/__init__.py +16 -1
- aws_cdk/aws_panorama/__init__.py +16 -1
- aws_cdk/aws_paymentcryptography/__init__.py +16 -1
- aws_cdk/aws_pcaconnectorad/__init__.py +16 -1
- aws_cdk/aws_pcaconnectorscep/__init__.py +85 -31
- aws_cdk/aws_personalize/__init__.py +16 -1
- aws_cdk/aws_pinpoint/__init__.py +16 -1
- aws_cdk/aws_pinpointemail/__init__.py +16 -1
- aws_cdk/aws_pipes/__init__.py +65 -1
- aws_cdk/aws_proton/__init__.py +16 -1
- aws_cdk/aws_qbusiness/__init__.py +27 -15
- aws_cdk/aws_qldb/__init__.py +16 -1
- aws_cdk/aws_quicksight/__init__.py +654 -100
- aws_cdk/aws_ram/__init__.py +16 -1
- aws_cdk/aws_rds/__init__.py +78 -32
- aws_cdk/aws_redshift/__init__.py +16 -1
- aws_cdk/aws_redshiftserverless/__init__.py +16 -1
- aws_cdk/aws_refactorspaces/__init__.py +16 -1
- aws_cdk/aws_rekognition/__init__.py +16 -1
- aws_cdk/aws_resiliencehub/__init__.py +16 -1
- aws_cdk/aws_resourceexplorer2/__init__.py +16 -1
- aws_cdk/aws_resourcegroups/__init__.py +16 -1
- aws_cdk/aws_robomaker/__init__.py +16 -1
- aws_cdk/aws_rolesanywhere/__init__.py +16 -1
- aws_cdk/aws_route53/__init__.py +16 -1
- aws_cdk/aws_route53_patterns/__init__.py +16 -1
- aws_cdk/aws_route53_targets/__init__.py +16 -1
- aws_cdk/aws_route53profiles/__init__.py +16 -1
- aws_cdk/aws_route53recoverycontrol/__init__.py +16 -1
- aws_cdk/aws_route53recoveryreadiness/__init__.py +16 -1
- aws_cdk/aws_route53resolver/__init__.py +16 -1
- aws_cdk/aws_rum/__init__.py +16 -1
- aws_cdk/aws_s3/__init__.py +231 -34
- aws_cdk/aws_s3_assets/__init__.py +16 -1
- aws_cdk/aws_s3_deployment/__init__.py +16 -1
- aws_cdk/aws_s3_notifications/__init__.py +16 -1
- aws_cdk/aws_s3express/__init__.py +16 -1
- aws_cdk/aws_s3objectlambda/__init__.py +18 -3
- aws_cdk/aws_s3outposts/__init__.py +16 -1
- aws_cdk/aws_sagemaker/__init__.py +888 -59
- aws_cdk/aws_sam/__init__.py +16 -1
- aws_cdk/aws_scheduler/__init__.py +16 -1
- aws_cdk/aws_sdb/__init__.py +16 -1
- aws_cdk/aws_secretsmanager/__init__.py +38 -9
- aws_cdk/aws_securityhub/__init__.py +277 -20
- aws_cdk/aws_securitylake/__init__.py +343 -8
- aws_cdk/aws_servicecatalog/__init__.py +16 -1
- aws_cdk/aws_servicecatalogappregistry/__init__.py +16 -1
- aws_cdk/aws_servicediscovery/__init__.py +21 -6
- aws_cdk/aws_ses/__init__.py +16 -1
- aws_cdk/aws_ses_actions/__init__.py +16 -1
- aws_cdk/aws_shield/__init__.py +16 -1
- aws_cdk/aws_signer/__init__.py +16 -1
- aws_cdk/aws_simspaceweaver/__init__.py +16 -1
- aws_cdk/aws_sns/__init__.py +16 -9
- aws_cdk/aws_sns_subscriptions/__init__.py +16 -1
- aws_cdk/aws_sqs/__init__.py +16 -1
- aws_cdk/aws_ssm/__init__.py +36 -13
- aws_cdk/aws_ssmcontacts/__init__.py +16 -1
- aws_cdk/aws_ssmincidents/__init__.py +16 -1
- aws_cdk/aws_ssmquicksetup/__init__.py +16 -1
- aws_cdk/aws_sso/__init__.py +16 -1
- aws_cdk/aws_stepfunctions/__init__.py +16 -1
- aws_cdk/aws_stepfunctions_tasks/__init__.py +52 -1
- aws_cdk/aws_supportapp/__init__.py +16 -1
- aws_cdk/aws_synthetics/__init__.py +16 -1
- aws_cdk/aws_systemsmanagersap/__init__.py +16 -1
- aws_cdk/aws_timestream/__init__.py +16 -1
- aws_cdk/aws_transfer/__init__.py +16 -1
- aws_cdk/aws_verifiedpermissions/__init__.py +16 -1
- aws_cdk/aws_voiceid/__init__.py +16 -1
- aws_cdk/aws_vpclattice/__init__.py +16 -1
- aws_cdk/aws_waf/__init__.py +16 -1
- aws_cdk/aws_wafregional/__init__.py +16 -1
- aws_cdk/aws_wafv2/__init__.py +16 -1
- aws_cdk/aws_wisdom/__init__.py +16 -1
- aws_cdk/aws_workspaces/__init__.py +16 -1
- aws_cdk/aws_workspacesthinclient/__init__.py +16 -1
- aws_cdk/aws_workspacesweb/__init__.py +16 -1
- aws_cdk/aws_xray/__init__.py +16 -1
- aws_cdk/cloud_assembly_schema/__init__.py +16 -1
- aws_cdk/cloudformation_include/__init__.py +16 -1
- aws_cdk/custom_resources/__init__.py +16 -1
- aws_cdk/cx_api/__init__.py +35 -1
- aws_cdk/lambda_layer_awscli/__init__.py +16 -1
- aws_cdk/lambda_layer_kubectl/__init__.py +16 -1
- aws_cdk/lambda_layer_node_proxy_agent/__init__.py +16 -1
- aws_cdk/pipelines/__init__.py +16 -1
- aws_cdk/region_info/__init__.py +16 -1
- aws_cdk/triggers/__init__.py +16 -1
- {aws_cdk_lib-2.157.0.dist-info → aws_cdk_lib-2.159.0.dist-info}/METADATA +5 -5
- {aws_cdk_lib-2.157.0.dist-info → aws_cdk_lib-2.159.0.dist-info}/NOTICE +27 -8
- aws_cdk_lib-2.159.0.dist-info/RECORD +294 -0
- aws_cdk_lib-2.157.0.dist-info/RECORD +0 -294
- {aws_cdk_lib-2.157.0.dist-info → aws_cdk_lib-2.159.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.157.0.dist-info → aws_cdk_lib-2.159.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.157.0.dist-info → aws_cdk_lib-2.159.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -1004,7 +1004,22 @@ import jsii
|
|
|
1004
1004
|
import publication
|
|
1005
1005
|
import typing_extensions
|
|
1006
1006
|
|
|
1007
|
-
|
|
1007
|
+
import typeguard
|
|
1008
|
+
from importlib.metadata import version as _metadata_package_version
|
|
1009
|
+
TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
|
|
1010
|
+
|
|
1011
|
+
def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
|
|
1012
|
+
if TYPEGUARD_MAJOR_VERSION <= 2:
|
|
1013
|
+
return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
|
|
1014
|
+
else:
|
|
1015
|
+
if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
|
|
1016
|
+
pass
|
|
1017
|
+
else:
|
|
1018
|
+
if TYPEGUARD_MAJOR_VERSION == 3:
|
|
1019
|
+
typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
|
|
1020
|
+
typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
|
|
1021
|
+
else:
|
|
1022
|
+
typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
|
|
1008
1023
|
|
|
1009
1024
|
from .._jsii import *
|
|
1010
1025
|
|
|
@@ -3350,7 +3365,7 @@ class CfnLogDeliveryConfiguration(
|
|
|
3350
3365
|
metaclass=jsii.JSIIMeta,
|
|
3351
3366
|
jsii_type="aws-cdk-lib.aws_cognito.CfnLogDeliveryConfiguration",
|
|
3352
3367
|
):
|
|
3353
|
-
'''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.
|
|
3354
3369
|
|
|
3355
3370
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html
|
|
3356
3371
|
:cloudformationResource: AWS::Cognito::LogDeliveryConfiguration
|
|
@@ -3494,6 +3509,8 @@ class CfnLogDeliveryConfiguration(
|
|
|
3494
3509
|
) -> None:
|
|
3495
3510
|
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3496
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
|
+
|
|
3497
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>`_ .
|
|
3498
3515
|
|
|
3499
3516
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html
|
|
@@ -3612,9 +3629,11 @@ class CfnLogDeliveryConfiguration(
|
|
|
3612
3629
|
log_level: typing.Optional[builtins.str] = None,
|
|
3613
3630
|
s3_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnLogDeliveryConfiguration.S3ConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3614
3631
|
) -> None:
|
|
3615
|
-
'''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>`_ .
|
|
3616
3635
|
|
|
3617
|
-
: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>`_ .
|
|
3618
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`` .
|
|
3619
3638
|
:param firehose_configuration: Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.
|
|
3620
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`` .
|
|
@@ -3668,6 +3687,8 @@ class CfnLogDeliveryConfiguration(
|
|
|
3668
3687
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLogDeliveryConfiguration.CloudWatchLogsConfigurationProperty"]]:
|
|
3669
3688
|
'''Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
|
|
3670
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
|
+
|
|
3671
3692
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration
|
|
3672
3693
|
'''
|
|
3673
3694
|
result = self._values.get("cloud_watch_logs_configuration")
|
|
@@ -3921,6 +3942,8 @@ class CfnUserPool(
|
|
|
3921
3942
|
challenge_required_on_new_device=False,
|
|
3922
3943
|
device_only_remembered_on_user_prompt=False
|
|
3923
3944
|
),
|
|
3945
|
+
email_authentication_message="emailAuthenticationMessage",
|
|
3946
|
+
email_authentication_subject="emailAuthenticationSubject",
|
|
3924
3947
|
email_configuration=cognito.CfnUserPool.EmailConfigurationProperty(
|
|
3925
3948
|
configuration_set="configurationSet",
|
|
3926
3949
|
email_sending_account="emailSendingAccount",
|
|
@@ -4027,6 +4050,8 @@ class CfnUserPool(
|
|
|
4027
4050
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
4028
4051
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
4029
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,
|
|
4030
4055
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.EmailConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4031
4056
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
4032
4057
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -4050,18 +4075,20 @@ class CfnUserPool(
|
|
|
4050
4075
|
:param scope: Scope in which this resource is defined.
|
|
4051
4076
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4052
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.
|
|
4053
|
-
: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>`_ .
|
|
4054
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.
|
|
4055
4080
|
:param auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* .
|
|
4056
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.
|
|
4057
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:
|
|
4058
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.
|
|
4059
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>`_ .
|
|
4060
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>`_ .
|
|
4061
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``
|
|
4062
|
-
: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.
|
|
4063
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.
|
|
4064
|
-
: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>`_ .
|
|
4065
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.
|
|
4066
4093
|
:param sms_authentication_message: A string representing the SMS authentication message.
|
|
4067
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 .
|
|
@@ -4072,7 +4099,7 @@ class CfnUserPool(
|
|
|
4072
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>`_ .
|
|
4073
4100
|
:param user_pool_name: A string used to name the user pool.
|
|
4074
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.
|
|
4075
|
-
: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.
|
|
4076
4103
|
'''
|
|
4077
4104
|
if __debug__:
|
|
4078
4105
|
type_hints = typing.get_type_hints(_typecheckingstub__32d20f28e2758f9a461380e2ed5d06233baf0f45541047ba837f26ebc37ee551)
|
|
@@ -4085,6 +4112,8 @@ class CfnUserPool(
|
|
|
4085
4112
|
auto_verified_attributes=auto_verified_attributes,
|
|
4086
4113
|
deletion_protection=deletion_protection,
|
|
4087
4114
|
device_configuration=device_configuration,
|
|
4115
|
+
email_authentication_message=email_authentication_message,
|
|
4116
|
+
email_authentication_subject=email_authentication_subject,
|
|
4088
4117
|
email_configuration=email_configuration,
|
|
4089
4118
|
email_verification_message=email_verification_message,
|
|
4090
4119
|
email_verification_subject=email_verification_subject,
|
|
@@ -4207,7 +4236,7 @@ class CfnUserPool(
|
|
|
4207
4236
|
def admin_create_user_config(
|
|
4208
4237
|
self,
|
|
4209
4238
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.AdminCreateUserConfigProperty"]]:
|
|
4210
|
-
'''The
|
|
4239
|
+
'''The settings for administrator creation of users in a user pool.'''
|
|
4211
4240
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.AdminCreateUserConfigProperty"]], jsii.get(self, "adminCreateUserConfig"))
|
|
4212
4241
|
|
|
4213
4242
|
@admin_create_user_config.setter
|
|
@@ -4286,6 +4315,36 @@ class CfnUserPool(
|
|
|
4286
4315
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
4287
4316
|
jsii.set(self, "deviceConfiguration", value) # pyright: ignore[reportArgumentType]
|
|
4288
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
|
+
|
|
4289
4348
|
@builtins.property
|
|
4290
4349
|
@jsii.member(jsii_name="emailConfiguration")
|
|
4291
4350
|
def email_configuration(
|
|
@@ -4348,7 +4407,7 @@ class CfnUserPool(
|
|
|
4348
4407
|
def lambda_config(
|
|
4349
4408
|
self,
|
|
4350
4409
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.LambdaConfigProperty"]]:
|
|
4351
|
-
'''
|
|
4410
|
+
'''A collection of user pool Lambda triggers.'''
|
|
4352
4411
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.LambdaConfigProperty"]], jsii.get(self, "lambdaConfig"))
|
|
4353
4412
|
|
|
4354
4413
|
@lambda_config.setter
|
|
@@ -4382,7 +4441,10 @@ class CfnUserPool(
|
|
|
4382
4441
|
def policies(
|
|
4383
4442
|
self,
|
|
4384
4443
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]]:
|
|
4385
|
-
'''
|
|
4444
|
+
'''A list of user pool policies.
|
|
4445
|
+
|
|
4446
|
+
Contains the policy that sets password-complexity requirements.
|
|
4447
|
+
'''
|
|
4386
4448
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PoliciesProperty"]], jsii.get(self, "policies"))
|
|
4387
4449
|
|
|
4388
4450
|
@policies.setter
|
|
@@ -4561,7 +4623,7 @@ class CfnUserPool(
|
|
|
4561
4623
|
def verification_message_template(
|
|
4562
4624
|
self,
|
|
4563
4625
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.VerificationMessageTemplateProperty"]]:
|
|
4564
|
-
'''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.'''
|
|
4565
4627
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.VerificationMessageTemplateProperty"]], jsii.get(self, "verificationMessageTemplate"))
|
|
4566
4628
|
|
|
4567
4629
|
@verification_message_template.setter
|
|
@@ -4655,9 +4717,9 @@ class CfnUserPool(
|
|
|
4655
4717
|
) -> None:
|
|
4656
4718
|
'''The configuration for ``AdminCreateUser`` requests.
|
|
4657
4719
|
|
|
4658
|
-
: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.
|
|
4659
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>`_ .
|
|
4660
|
-
: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.
|
|
4661
4723
|
|
|
4662
4724
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html
|
|
4663
4725
|
:exampleMetadata: fixture=_generated
|
|
@@ -4695,9 +4757,9 @@ class CfnUserPool(
|
|
|
4695
4757
|
def allow_admin_create_user_only(
|
|
4696
4758
|
self,
|
|
4697
4759
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4698
|
-
'''
|
|
4760
|
+
'''The setting for allowing self-service sign-up.
|
|
4699
4761
|
|
|
4700
|
-
|
|
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.
|
|
4701
4763
|
|
|
4702
4764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly
|
|
4703
4765
|
'''
|
|
@@ -4719,12 +4781,13 @@ class CfnUserPool(
|
|
|
4719
4781
|
|
|
4720
4782
|
@builtins.property
|
|
4721
4783
|
def unused_account_validity_days(self) -> typing.Optional[jsii.Number]:
|
|
4722
|
-
'''
|
|
4784
|
+
'''This parameter is no longer in use.
|
|
4723
4785
|
|
|
4724
|
-
|
|
4725
|
-
.. 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`` .
|
|
4726
4787
|
|
|
4727
|
-
|
|
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.
|
|
4728
4791
|
|
|
4729
4792
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays
|
|
4730
4793
|
'''
|
|
@@ -4963,6 +5026,8 @@ class CfnUserPool(
|
|
|
4963
5026
|
|
|
4964
5027
|
When you provide a value for any property of ``DeviceConfiguration`` , you activate the device remembering for the user pool.
|
|
4965
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
|
+
|
|
4966
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.
|
|
4967
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.
|
|
4968
5033
|
|
|
@@ -5197,7 +5262,7 @@ class CfnUserPool(
|
|
|
5197
5262
|
email_subject: typing.Optional[builtins.str] = None,
|
|
5198
5263
|
sms_message: typing.Optional[builtins.str] = None,
|
|
5199
5264
|
) -> None:
|
|
5200
|
-
'''The
|
|
5265
|
+
'''The template for the welcome message to new users.
|
|
5201
5266
|
|
|
5202
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>`_ .
|
|
5203
5268
|
|
|
@@ -5314,22 +5379,26 @@ class CfnUserPool(
|
|
|
5314
5379
|
user_migration: typing.Optional[builtins.str] = None,
|
|
5315
5380
|
verify_auth_challenge_response: typing.Optional[builtins.str] = None,
|
|
5316
5381
|
) -> None:
|
|
5317
|
-
'''
|
|
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.
|
|
5318
5385
|
|
|
5319
|
-
|
|
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>`_ .
|
|
5320
5389
|
:param custom_email_sender: A custom email sender AWS Lambda trigger.
|
|
5321
|
-
: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.
|
|
5322
5391
|
:param custom_sms_sender: A custom SMS sender AWS Lambda trigger.
|
|
5323
|
-
: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>`_ .
|
|
5324
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`` .
|
|
5325
|
-
:param post_authentication:
|
|
5326
|
-
:param post_confirmation:
|
|
5327
|
-
:param pre_authentication:
|
|
5328
|
-
:param pre_sign_up:
|
|
5329
|
-
:param pre_token_generation: The
|
|
5330
|
-
: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`` .
|
|
5331
|
-
:param user_migration: The user
|
|
5332
|
-
: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>`_ .
|
|
5333
5402
|
|
|
5334
5403
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html
|
|
5335
5404
|
:exampleMetadata: fixture=_generated
|
|
@@ -5414,7 +5483,7 @@ class CfnUserPool(
|
|
|
5414
5483
|
|
|
5415
5484
|
@builtins.property
|
|
5416
5485
|
def create_auth_challenge(self) -> typing.Optional[builtins.str]:
|
|
5417
|
-
'''
|
|
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>`_ .
|
|
5418
5487
|
|
|
5419
5488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge
|
|
5420
5489
|
'''
|
|
@@ -5434,7 +5503,9 @@ class CfnUserPool(
|
|
|
5434
5503
|
|
|
5435
5504
|
@builtins.property
|
|
5436
5505
|
def custom_message(self) -> typing.Optional[builtins.str]:
|
|
5437
|
-
'''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.
|
|
5438
5509
|
|
|
5439
5510
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage
|
|
5440
5511
|
'''
|
|
@@ -5454,7 +5525,7 @@ class CfnUserPool(
|
|
|
5454
5525
|
|
|
5455
5526
|
@builtins.property
|
|
5456
5527
|
def define_auth_challenge(self) -> typing.Optional[builtins.str]:
|
|
5457
|
-
'''
|
|
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>`_ .
|
|
5458
5529
|
|
|
5459
5530
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge
|
|
5460
5531
|
'''
|
|
@@ -5474,7 +5545,7 @@ class CfnUserPool(
|
|
|
5474
5545
|
|
|
5475
5546
|
@builtins.property
|
|
5476
5547
|
def post_authentication(self) -> typing.Optional[builtins.str]:
|
|
5477
|
-
'''
|
|
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.
|
|
5478
5549
|
|
|
5479
5550
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication
|
|
5480
5551
|
'''
|
|
@@ -5483,7 +5554,7 @@ class CfnUserPool(
|
|
|
5483
5554
|
|
|
5484
5555
|
@builtins.property
|
|
5485
5556
|
def post_confirmation(self) -> typing.Optional[builtins.str]:
|
|
5486
|
-
'''
|
|
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.
|
|
5487
5558
|
|
|
5488
5559
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation
|
|
5489
5560
|
'''
|
|
@@ -5492,7 +5563,7 @@ class CfnUserPool(
|
|
|
5492
5563
|
|
|
5493
5564
|
@builtins.property
|
|
5494
5565
|
def pre_authentication(self) -> typing.Optional[builtins.str]:
|
|
5495
|
-
'''
|
|
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.
|
|
5496
5567
|
|
|
5497
5568
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication
|
|
5498
5569
|
'''
|
|
@@ -5501,7 +5572,7 @@ class CfnUserPool(
|
|
|
5501
5572
|
|
|
5502
5573
|
@builtins.property
|
|
5503
5574
|
def pre_sign_up(self) -> typing.Optional[builtins.str]:
|
|
5504
|
-
'''
|
|
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.
|
|
5505
5576
|
|
|
5506
5577
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup
|
|
5507
5578
|
'''
|
|
@@ -5510,12 +5581,10 @@ class CfnUserPool(
|
|
|
5510
5581
|
|
|
5511
5582
|
@builtins.property
|
|
5512
5583
|
def pre_token_generation(self) -> typing.Optional[builtins.str]:
|
|
5513
|
-
'''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.
|
|
5514
5585
|
|
|
5515
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`` .
|
|
5516
5587
|
|
|
5517
|
-
You can set ``
|
|
5518
|
-
|
|
5519
5588
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration
|
|
5520
5589
|
'''
|
|
5521
5590
|
result = self._values.get("pre_token_generation")
|
|
@@ -5525,9 +5594,7 @@ class CfnUserPool(
|
|
|
5525
5594
|
def pre_token_generation_config(
|
|
5526
5595
|
self,
|
|
5527
5596
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PreTokenGenerationConfigProperty"]]:
|
|
5528
|
-
'''The detailed configuration of a pre token generation trigger.
|
|
5529
|
-
|
|
5530
|
-
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`` .
|
|
5531
5598
|
|
|
5532
5599
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengenerationconfig
|
|
5533
5600
|
'''
|
|
@@ -5536,7 +5603,7 @@ class CfnUserPool(
|
|
|
5536
5603
|
|
|
5537
5604
|
@builtins.property
|
|
5538
5605
|
def user_migration(self) -> typing.Optional[builtins.str]:
|
|
5539
|
-
'''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.
|
|
5540
5607
|
|
|
5541
5608
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration
|
|
5542
5609
|
'''
|
|
@@ -5545,7 +5612,7 @@ class CfnUserPool(
|
|
|
5545
5612
|
|
|
5546
5613
|
@builtins.property
|
|
5547
5614
|
def verify_auth_challenge_response(self) -> typing.Optional[builtins.str]:
|
|
5548
|
-
'''
|
|
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>`_ .
|
|
5549
5616
|
|
|
5550
5617
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse
|
|
5551
5618
|
'''
|
|
@@ -5575,7 +5642,9 @@ class CfnUserPool(
|
|
|
5575
5642
|
max_value: typing.Optional[builtins.str] = None,
|
|
5576
5643
|
min_value: typing.Optional[builtins.str] = None,
|
|
5577
5644
|
) -> None:
|
|
5578
|
-
'''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>`_
|
|
5579
5648
|
|
|
5580
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.
|
|
5581
5650
|
:param min_value: The minimum value of an attribute that is of the number data type.
|
|
@@ -5660,14 +5729,16 @@ class CfnUserPool(
|
|
|
5660
5729
|
require_uppercase: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
5661
5730
|
temporary_password_validity_days: typing.Optional[jsii.Number] = None,
|
|
5662
5731
|
) -> None:
|
|
5663
|
-
'''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>`_ .
|
|
5664
5735
|
|
|
5665
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.
|
|
5666
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.
|
|
5667
|
-
:param require_lowercase:
|
|
5668
|
-
:param require_numbers:
|
|
5669
|
-
:param require_symbols:
|
|
5670
|
-
: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.
|
|
5671
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.
|
|
5672
5743
|
|
|
5673
5744
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html
|
|
@@ -5742,7 +5813,7 @@ class CfnUserPool(
|
|
|
5742
5813
|
def require_lowercase(
|
|
5743
5814
|
self,
|
|
5744
5815
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5745
|
-
'''
|
|
5816
|
+
'''The requirement in a password policy that users must include at least one lowercase letter in their password.
|
|
5746
5817
|
|
|
5747
5818
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase
|
|
5748
5819
|
'''
|
|
@@ -5753,7 +5824,7 @@ class CfnUserPool(
|
|
|
5753
5824
|
def require_numbers(
|
|
5754
5825
|
self,
|
|
5755
5826
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5756
|
-
'''
|
|
5827
|
+
'''The requirement in a password policy that users must include at least one number in their password.
|
|
5757
5828
|
|
|
5758
5829
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers
|
|
5759
5830
|
'''
|
|
@@ -5764,7 +5835,7 @@ class CfnUserPool(
|
|
|
5764
5835
|
def require_symbols(
|
|
5765
5836
|
self,
|
|
5766
5837
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5767
|
-
'''
|
|
5838
|
+
'''The requirement in a password policy that users must include at least one symbol in their password.
|
|
5768
5839
|
|
|
5769
5840
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols
|
|
5770
5841
|
'''
|
|
@@ -5775,7 +5846,7 @@ class CfnUserPool(
|
|
|
5775
5846
|
def require_uppercase(
|
|
5776
5847
|
self,
|
|
5777
5848
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5778
|
-
'''
|
|
5849
|
+
'''The requirement in a password policy that users must include at least one uppercase letter in their password.
|
|
5779
5850
|
|
|
5780
5851
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase
|
|
5781
5852
|
'''
|
|
@@ -5818,9 +5889,11 @@ class CfnUserPool(
|
|
|
5818
5889
|
*,
|
|
5819
5890
|
password_policy: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPool.PasswordPolicyProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5820
5891
|
) -> None:
|
|
5821
|
-
'''
|
|
5892
|
+
'''A list of user pool policies. Contains the policy that sets password-complexity requirements.
|
|
5822
5893
|
|
|
5823
|
-
|
|
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.
|
|
5824
5897
|
|
|
5825
5898
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html
|
|
5826
5899
|
:exampleMetadata: fixture=_generated
|
|
@@ -5854,7 +5927,7 @@ class CfnUserPool(
|
|
|
5854
5927
|
def password_policy(
|
|
5855
5928
|
self,
|
|
5856
5929
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPool.PasswordPolicyProperty"]]:
|
|
5857
|
-
'''The password policy.
|
|
5930
|
+
'''The password policy settings for a user pool, including complexity, history, and length requirements.
|
|
5858
5931
|
|
|
5859
5932
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-passwordpolicy
|
|
5860
5933
|
'''
|
|
@@ -5886,6 +5959,8 @@ class CfnUserPool(
|
|
|
5886
5959
|
) -> None:
|
|
5887
5960
|
'''The properties of a pre token generation Lambda trigger.
|
|
5888
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
|
+
|
|
5889
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`` .
|
|
5890
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.
|
|
5891
5966
|
|
|
@@ -6045,7 +6120,9 @@ class CfnUserPool(
|
|
|
6045
6120
|
|
|
6046
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>`_ .
|
|
6047
6122
|
|
|
6048
|
-
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>`_ .
|
|
6049
6126
|
|
|
6050
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"`` .
|
|
6051
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.
|
|
@@ -6317,7 +6394,7 @@ class CfnUserPool(
|
|
|
6317
6394
|
``StringAttributeConstraints`` is a subproperty of the `SchemaAttribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html>`_ property type.
|
|
6318
6395
|
|
|
6319
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.
|
|
6320
|
-
:param min_length: The minimum length.
|
|
6397
|
+
:param min_length: The minimum length of a string attribute value.
|
|
6321
6398
|
|
|
6322
6399
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html
|
|
6323
6400
|
:exampleMetadata: fixture=_generated
|
|
@@ -6356,7 +6433,7 @@ class CfnUserPool(
|
|
|
6356
6433
|
|
|
6357
6434
|
@builtins.property
|
|
6358
6435
|
def min_length(self) -> typing.Optional[builtins.str]:
|
|
6359
|
-
'''The minimum length.
|
|
6436
|
+
'''The minimum length of a string attribute value.
|
|
6360
6437
|
|
|
6361
6438
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength
|
|
6362
6439
|
'''
|
|
@@ -6465,6 +6542,8 @@ class CfnUserPool(
|
|
|
6465
6542
|
|
|
6466
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>`_ .
|
|
6467
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
|
+
|
|
6468
6547
|
:param advanced_security_additional_flows:
|
|
6469
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.
|
|
6470
6549
|
|
|
@@ -6537,7 +6616,7 @@ class CfnUserPool(
|
|
|
6537
6616
|
) -> None:
|
|
6538
6617
|
'''The ``UsernameConfiguration`` property type specifies case sensitivity on the username input for the selected sign-in option.
|
|
6539
6618
|
|
|
6540
|
-
: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.
|
|
6541
6620
|
|
|
6542
6621
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html
|
|
6543
6622
|
:exampleMetadata: fixture=_generated
|
|
@@ -6569,8 +6648,8 @@ class CfnUserPool(
|
|
|
6569
6648
|
|
|
6570
6649
|
Valid values include:
|
|
6571
6650
|
|
|
6572
|
-
- **
|
|
6573
|
-
- **
|
|
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.
|
|
6574
6653
|
|
|
6575
6654
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html#cfn-cognito-userpool-usernameconfiguration-casesensitive
|
|
6576
6655
|
'''
|
|
@@ -6611,9 +6690,11 @@ class CfnUserPool(
|
|
|
6611
6690
|
email_subject_by_link: typing.Optional[builtins.str] = None,
|
|
6612
6691
|
sms_message: typing.Optional[builtins.str] = None,
|
|
6613
6692
|
) -> None:
|
|
6614
|
-
'''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.
|
|
6615
6694
|
|
|
6616
|
-
|
|
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 ``{####}`` .
|
|
6617
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.
|
|
6618
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.
|
|
6619
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.
|
|
@@ -6662,7 +6743,9 @@ class CfnUserPool(
|
|
|
6662
6743
|
|
|
6663
6744
|
@builtins.property
|
|
6664
6745
|
def default_email_option(self) -> typing.Optional[builtins.str]:
|
|
6665
|
-
'''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 ``{####}`` .
|
|
6666
6749
|
|
|
6667
6750
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-defaultemailoption
|
|
6668
6751
|
'''
|
|
@@ -6859,7 +6942,7 @@ class CfnUserPoolClient(
|
|
|
6859
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.
|
|
6860
6943
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
6861
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.
|
|
6862
|
-
: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.
|
|
6863
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.
|
|
6864
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`` .
|
|
6865
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.
|
|
@@ -7220,7 +7303,7 @@ class CfnUserPoolClient(
|
|
|
7220
7303
|
@builtins.property
|
|
7221
7304
|
@jsii.member(jsii_name="readAttributes")
|
|
7222
7305
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7223
|
-
'''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.'''
|
|
7224
7307
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "readAttributes"))
|
|
7225
7308
|
|
|
7226
7309
|
@read_attributes.setter
|
|
@@ -7319,16 +7402,18 @@ class CfnUserPoolClient(
|
|
|
7319
7402
|
role_arn: typing.Optional[builtins.str] = None,
|
|
7320
7403
|
user_data_shared: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
7321
7404
|
) -> None:
|
|
7322
|
-
'''The Amazon Pinpoint analytics configuration
|
|
7405
|
+
'''The settings for Amazon Pinpoint analytics configuration.
|
|
7323
7406
|
|
|
7324
|
-
|
|
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>`_ .
|
|
7325
7410
|
|
|
7326
|
-
|
|
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>`_ .
|
|
7327
7412
|
|
|
7328
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.
|
|
7329
|
-
:param application_id:
|
|
7330
|
-
:param external_id: The external ID.
|
|
7331
|
-
: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.
|
|
7332
7417
|
:param user_data_shared: If ``UserDataShared`` is ``true`` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
|
|
7333
7418
|
|
|
7334
7419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html
|
|
@@ -7380,7 +7465,7 @@ class CfnUserPoolClient(
|
|
|
7380
7465
|
|
|
7381
7466
|
@builtins.property
|
|
7382
7467
|
def application_id(self) -> typing.Optional[builtins.str]:
|
|
7383
|
-
'''
|
|
7468
|
+
'''Your Amazon Pinpoint project ID.
|
|
7384
7469
|
|
|
7385
7470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid
|
|
7386
7471
|
'''
|
|
@@ -7389,7 +7474,7 @@ class CfnUserPoolClient(
|
|
|
7389
7474
|
|
|
7390
7475
|
@builtins.property
|
|
7391
7476
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
7392
|
-
'''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.
|
|
7393
7478
|
|
|
7394
7479
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-externalid
|
|
7395
7480
|
'''
|
|
@@ -7398,7 +7483,7 @@ class CfnUserPoolClient(
|
|
|
7398
7483
|
|
|
7399
7484
|
@builtins.property
|
|
7400
7485
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
7401
|
-
'''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.
|
|
7402
7487
|
|
|
7403
7488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn
|
|
7404
7489
|
'''
|
|
@@ -7448,9 +7533,9 @@ class CfnUserPoolClient(
|
|
|
7448
7533
|
|
|
7449
7534
|
The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
|
|
7450
7535
|
|
|
7451
|
-
:param access_token: A time unit
|
|
7452
|
-
:param id_token: A time unit
|
|
7453
|
-
: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.
|
|
7454
7539
|
|
|
7455
7540
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html
|
|
7456
7541
|
:exampleMetadata: fixture=_generated
|
|
@@ -7482,9 +7567,9 @@ class CfnUserPoolClient(
|
|
|
7482
7567
|
|
|
7483
7568
|
@builtins.property
|
|
7484
7569
|
def access_token(self) -> typing.Optional[builtins.str]:
|
|
7485
|
-
'''A time unit
|
|
7570
|
+
'''A time unit for the value that you set in the ``AccessTokenValidity`` parameter.
|
|
7486
7571
|
|
|
7487
|
-
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.
|
|
7488
7573
|
|
|
7489
7574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-accesstoken
|
|
7490
7575
|
'''
|
|
@@ -7493,9 +7578,9 @@ class CfnUserPoolClient(
|
|
|
7493
7578
|
|
|
7494
7579
|
@builtins.property
|
|
7495
7580
|
def id_token(self) -> typing.Optional[builtins.str]:
|
|
7496
|
-
'''A time unit
|
|
7581
|
+
'''A time unit for the value that you set in the ``IdTokenValidity`` parameter.
|
|
7497
7582
|
|
|
7498
|
-
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.
|
|
7499
7584
|
|
|
7500
7585
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-idtoken
|
|
7501
7586
|
'''
|
|
@@ -7504,9 +7589,9 @@ class CfnUserPoolClient(
|
|
|
7504
7589
|
|
|
7505
7590
|
@builtins.property
|
|
7506
7591
|
def refresh_token(self) -> typing.Optional[builtins.str]:
|
|
7507
|
-
'''A time unit
|
|
7592
|
+
'''A time unit for the value that you set in the ``RefreshTokenValidity`` parameter.
|
|
7508
7593
|
|
|
7509
|
-
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.
|
|
7510
7595
|
|
|
7511
7596
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-refreshtoken
|
|
7512
7597
|
'''
|
|
@@ -7599,7 +7684,7 @@ class CfnUserPoolClientProps:
|
|
|
7599
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.
|
|
7600
7685
|
:param logout_ur_ls: A list of allowed logout URLs for the IdPs.
|
|
7601
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.
|
|
7602
|
-
: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.
|
|
7603
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.
|
|
7604
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`` .
|
|
7605
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.
|
|
@@ -7970,11 +8055,11 @@ class CfnUserPoolClientProps:
|
|
|
7970
8055
|
|
|
7971
8056
|
@builtins.property
|
|
7972
8057
|
def read_attributes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7973
|
-
'''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.
|
|
7974
8059
|
|
|
7975
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.
|
|
7976
8061
|
|
|
7977
|
-
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.
|
|
7978
8063
|
|
|
7979
8064
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes
|
|
7980
8065
|
'''
|
|
@@ -8214,7 +8299,9 @@ class CfnUserPoolDomain(
|
|
|
8214
8299
|
*,
|
|
8215
8300
|
certificate_arn: typing.Optional[builtins.str] = None,
|
|
8216
8301
|
) -> None:
|
|
8217
|
-
'''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>`_ .
|
|
8218
8305
|
|
|
8219
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.
|
|
8220
8307
|
|
|
@@ -9046,6 +9133,8 @@ class CfnUserPoolIdentityProviderProps:
|
|
|
9046
9133
|
"auto_verified_attributes": "autoVerifiedAttributes",
|
|
9047
9134
|
"deletion_protection": "deletionProtection",
|
|
9048
9135
|
"device_configuration": "deviceConfiguration",
|
|
9136
|
+
"email_authentication_message": "emailAuthenticationMessage",
|
|
9137
|
+
"email_authentication_subject": "emailAuthenticationSubject",
|
|
9049
9138
|
"email_configuration": "emailConfiguration",
|
|
9050
9139
|
"email_verification_message": "emailVerificationMessage",
|
|
9051
9140
|
"email_verification_subject": "emailVerificationSubject",
|
|
@@ -9076,6 +9165,8 @@ class CfnUserPoolProps:
|
|
|
9076
9165
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
9077
9166
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
9078
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,
|
|
9079
9170
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
9080
9171
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
9081
9172
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -9098,18 +9189,20 @@ class CfnUserPoolProps:
|
|
|
9098
9189
|
'''Properties for defining a ``CfnUserPool``.
|
|
9099
9190
|
|
|
9100
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.
|
|
9101
|
-
: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>`_ .
|
|
9102
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.
|
|
9103
9194
|
:param auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* .
|
|
9104
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.
|
|
9105
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:
|
|
9106
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.
|
|
9107
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>`_ .
|
|
9108
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>`_ .
|
|
9109
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``
|
|
9110
|
-
: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.
|
|
9111
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.
|
|
9112
|
-
: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>`_ .
|
|
9113
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.
|
|
9114
9207
|
:param sms_authentication_message: A string representing the SMS authentication message.
|
|
9115
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 .
|
|
@@ -9120,7 +9213,7 @@ class CfnUserPoolProps:
|
|
|
9120
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>`_ .
|
|
9121
9214
|
:param user_pool_name: A string used to name the user pool.
|
|
9122
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.
|
|
9123
|
-
: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.
|
|
9124
9217
|
|
|
9125
9218
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html
|
|
9126
9219
|
:exampleMetadata: fixture=_generated
|
|
@@ -9156,6 +9249,8 @@ class CfnUserPoolProps:
|
|
|
9156
9249
|
challenge_required_on_new_device=False,
|
|
9157
9250
|
device_only_remembered_on_user_prompt=False
|
|
9158
9251
|
),
|
|
9252
|
+
email_authentication_message="emailAuthenticationMessage",
|
|
9253
|
+
email_authentication_subject="emailAuthenticationSubject",
|
|
9159
9254
|
email_configuration=cognito.CfnUserPool.EmailConfigurationProperty(
|
|
9160
9255
|
configuration_set="configurationSet",
|
|
9161
9256
|
email_sending_account="emailSendingAccount",
|
|
@@ -9258,6 +9353,8 @@ class CfnUserPoolProps:
|
|
|
9258
9353
|
check_type(argname="argument auto_verified_attributes", value=auto_verified_attributes, expected_type=type_hints["auto_verified_attributes"])
|
|
9259
9354
|
check_type(argname="argument deletion_protection", value=deletion_protection, expected_type=type_hints["deletion_protection"])
|
|
9260
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"])
|
|
9261
9358
|
check_type(argname="argument email_configuration", value=email_configuration, expected_type=type_hints["email_configuration"])
|
|
9262
9359
|
check_type(argname="argument email_verification_message", value=email_verification_message, expected_type=type_hints["email_verification_message"])
|
|
9263
9360
|
check_type(argname="argument email_verification_subject", value=email_verification_subject, expected_type=type_hints["email_verification_subject"])
|
|
@@ -9289,6 +9386,10 @@ class CfnUserPoolProps:
|
|
|
9289
9386
|
self._values["deletion_protection"] = deletion_protection
|
|
9290
9387
|
if device_configuration is not None:
|
|
9291
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
|
|
9292
9393
|
if email_configuration is not None:
|
|
9293
9394
|
self._values["email_configuration"] = email_configuration
|
|
9294
9395
|
if email_verification_message is not None:
|
|
@@ -9343,7 +9444,11 @@ class CfnUserPoolProps:
|
|
|
9343
9444
|
def admin_create_user_config(
|
|
9344
9445
|
self,
|
|
9345
9446
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.AdminCreateUserConfigProperty]]:
|
|
9346
|
-
'''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>`_ .
|
|
9347
9452
|
|
|
9348
9453
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
|
|
9349
9454
|
'''
|
|
@@ -9404,6 +9509,22 @@ class CfnUserPoolProps:
|
|
|
9404
9509
|
result = self._values.get("device_configuration")
|
|
9405
9510
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.DeviceConfigurationProperty]], result)
|
|
9406
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
|
+
|
|
9407
9528
|
@builtins.property
|
|
9408
9529
|
def email_configuration(
|
|
9409
9530
|
self,
|
|
@@ -9459,15 +9580,9 @@ class CfnUserPoolProps:
|
|
|
9459
9580
|
def lambda_config(
|
|
9460
9581
|
self,
|
|
9461
9582
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.LambdaConfigProperty]]:
|
|
9462
|
-
'''
|
|
9583
|
+
'''A collection of user pool Lambda triggers.
|
|
9463
9584
|
|
|
9464
|
-
|
|
9465
|
-
|
|
9466
|
-
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.
|
|
9467
|
-
|
|
9468
|
-
For more information on using the Lambda API to add permission, see `AddPermission <https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html>`_ .
|
|
9469
|
-
|
|
9470
|
-
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.
|
|
9471
9586
|
|
|
9472
9587
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig
|
|
9473
9588
|
'''
|
|
@@ -9491,7 +9606,9 @@ class CfnUserPoolProps:
|
|
|
9491
9606
|
def policies(
|
|
9492
9607
|
self,
|
|
9493
9608
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.PoliciesProperty]]:
|
|
9494
|
-
'''
|
|
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>`_ .
|
|
9495
9612
|
|
|
9496
9613
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
|
|
9497
9614
|
'''
|
|
@@ -9626,7 +9743,9 @@ class CfnUserPoolProps:
|
|
|
9626
9743
|
def verification_message_template(
|
|
9627
9744
|
self,
|
|
9628
9745
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.VerificationMessageTemplateProperty]]:
|
|
9629
|
-
'''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.
|
|
9630
9749
|
|
|
9631
9750
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate
|
|
9632
9751
|
'''
|
|
@@ -9815,10 +9934,14 @@ class CfnUserPoolResourceServer(
|
|
|
9815
9934
|
scope_description: builtins.str,
|
|
9816
9935
|
scope_name: builtins.str,
|
|
9817
9936
|
) -> None:
|
|
9818
|
-
'''
|
|
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>`_ .
|
|
9819
9940
|
|
|
9820
|
-
|
|
9821
|
-
|
|
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`` .
|
|
9822
9945
|
|
|
9823
9946
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html
|
|
9824
9947
|
:exampleMetadata: fixture=_generated
|
|
@@ -9845,7 +9968,7 @@ class CfnUserPoolResourceServer(
|
|
|
9845
9968
|
|
|
9846
9969
|
@builtins.property
|
|
9847
9970
|
def scope_description(self) -> builtins.str:
|
|
9848
|
-
'''A description of
|
|
9971
|
+
'''A friendly description of a custom scope.
|
|
9849
9972
|
|
|
9850
9973
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription
|
|
9851
9974
|
'''
|
|
@@ -9857,6 +9980,8 @@ class CfnUserPoolResourceServer(
|
|
|
9857
9980
|
def scope_name(self) -> builtins.str:
|
|
9858
9981
|
'''The name of the scope.
|
|
9859
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
|
+
|
|
9860
9985
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename
|
|
9861
9986
|
'''
|
|
9862
9987
|
result = self._values.get("scope_name")
|
|
@@ -10094,10 +10219,10 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10094
10219
|
:param scope: Scope in which this resource is defined.
|
|
10095
10220
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
10096
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`` ).
|
|
10097
|
-
:param user_pool_id: The user pool
|
|
10098
|
-
:param account_takeover_risk_configuration: The
|
|
10099
|
-
:param compromised_credentials_risk_configuration:
|
|
10100
|
-
: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.
|
|
10101
10226
|
'''
|
|
10102
10227
|
if __debug__:
|
|
10103
10228
|
type_hints = typing.get_type_hints(_typecheckingstub__e3245a667ca916eabc555ef843b4a36bfcb47060fa353bd730066a76dcad5a96)
|
|
@@ -10164,7 +10289,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10164
10289
|
@builtins.property
|
|
10165
10290
|
@jsii.member(jsii_name="userPoolId")
|
|
10166
10291
|
def user_pool_id(self) -> builtins.str:
|
|
10167
|
-
'''The user pool
|
|
10292
|
+
'''The ID of the user pool that has the risk configuration applied.'''
|
|
10168
10293
|
return typing.cast(builtins.str, jsii.get(self, "userPoolId"))
|
|
10169
10294
|
|
|
10170
10295
|
@user_pool_id.setter
|
|
@@ -10179,7 +10304,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10179
10304
|
def account_takeover_risk_configuration(
|
|
10180
10305
|
self,
|
|
10181
10306
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]]:
|
|
10182
|
-
'''The
|
|
10307
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.'''
|
|
10183
10308
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty"]], jsii.get(self, "accountTakeoverRiskConfiguration"))
|
|
10184
10309
|
|
|
10185
10310
|
@account_takeover_risk_configuration.setter
|
|
@@ -10197,7 +10322,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10197
10322
|
def compromised_credentials_risk_configuration(
|
|
10198
10323
|
self,
|
|
10199
10324
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]]:
|
|
10200
|
-
'''
|
|
10325
|
+
'''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.'''
|
|
10201
10326
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty"]], jsii.get(self, "compromisedCredentialsRiskConfiguration"))
|
|
10202
10327
|
|
|
10203
10328
|
@compromised_credentials_risk_configuration.setter
|
|
@@ -10215,7 +10340,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10215
10340
|
def risk_exception_configuration(
|
|
10216
10341
|
self,
|
|
10217
10342
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty"]]:
|
|
10218
|
-
'''
|
|
10343
|
+
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.'''
|
|
10219
10344
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty"]], jsii.get(self, "riskExceptionConfiguration"))
|
|
10220
10345
|
|
|
10221
10346
|
@risk_exception_configuration.setter
|
|
@@ -10240,10 +10365,14 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10240
10365
|
event_action: builtins.str,
|
|
10241
10366
|
notify: typing.Union[builtins.bool, _IResolvable_da3f097b],
|
|
10242
10367
|
) -> None:
|
|
10243
|
-
'''
|
|
10368
|
+
'''The automated response to a risk level for adaptive authentication in full-function, or ``ENFORCED`` , mode.
|
|
10244
10369
|
|
|
10245
|
-
|
|
10246
|
-
|
|
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.
|
|
10247
10376
|
|
|
10248
10377
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html
|
|
10249
10378
|
:exampleMetadata: fixture=_generated
|
|
@@ -10270,12 +10399,14 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10270
10399
|
|
|
10271
10400
|
@builtins.property
|
|
10272
10401
|
def event_action(self) -> builtins.str:
|
|
10273
|
-
'''The action to take
|
|
10402
|
+
'''The action to take for the attempted account takeover action for the associated risk level.
|
|
10274
10403
|
|
|
10275
|
-
|
|
10276
|
-
|
|
10277
|
-
- ``
|
|
10278
|
-
- ``
|
|
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.
|
|
10279
10410
|
|
|
10280
10411
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction
|
|
10281
10412
|
'''
|
|
@@ -10285,7 +10416,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10285
10416
|
|
|
10286
10417
|
@builtins.property
|
|
10287
10418
|
def notify(self) -> typing.Union[builtins.bool, _IResolvable_da3f097b]:
|
|
10288
|
-
'''
|
|
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.
|
|
10289
10420
|
|
|
10290
10421
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify
|
|
10291
10422
|
'''
|
|
@@ -10321,11 +10452,13 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10321
10452
|
low_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10322
10453
|
medium_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10323
10454
|
) -> None:
|
|
10324
|
-
'''
|
|
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>`_ .
|
|
10325
10458
|
|
|
10326
|
-
:param high_action:
|
|
10327
|
-
:param low_action:
|
|
10328
|
-
: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.
|
|
10329
10462
|
|
|
10330
10463
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html
|
|
10331
10464
|
:exampleMetadata: fixture=_generated
|
|
@@ -10368,7 +10501,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10368
10501
|
def high_action(
|
|
10369
10502
|
self,
|
|
10370
10503
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10371
|
-
'''
|
|
10504
|
+
'''The action that you assign to a high-risk assessment by advanced security features.
|
|
10372
10505
|
|
|
10373
10506
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction
|
|
10374
10507
|
'''
|
|
@@ -10379,7 +10512,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10379
10512
|
def low_action(
|
|
10380
10513
|
self,
|
|
10381
10514
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10382
|
-
'''
|
|
10515
|
+
'''The action that you assign to a low-risk assessment by advanced security features.
|
|
10383
10516
|
|
|
10384
10517
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction
|
|
10385
10518
|
'''
|
|
@@ -10390,7 +10523,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10390
10523
|
def medium_action(
|
|
10391
10524
|
self,
|
|
10392
10525
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty"]]:
|
|
10393
|
-
'''
|
|
10526
|
+
'''The action that you assign to a medium-risk assessment by advanced security features.
|
|
10394
10527
|
|
|
10395
10528
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction
|
|
10396
10529
|
'''
|
|
@@ -10423,10 +10556,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10423
10556
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
10424
10557
|
notify_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10425
10558
|
) -> None:
|
|
10426
|
-
'''
|
|
10559
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
10427
10560
|
|
|
10428
|
-
|
|
10429
|
-
|
|
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.
|
|
10430
10565
|
|
|
10431
10566
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html
|
|
10432
10567
|
:exampleMetadata: fixture=_generated
|
|
@@ -10498,7 +10633,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10498
10633
|
def actions(
|
|
10499
10634
|
self,
|
|
10500
10635
|
) -> typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty"]:
|
|
10501
|
-
'''
|
|
10636
|
+
'''A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
|
|
10502
10637
|
|
|
10503
10638
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions
|
|
10504
10639
|
'''
|
|
@@ -10510,7 +10645,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10510
10645
|
def notify_configuration(
|
|
10511
10646
|
self,
|
|
10512
10647
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty"]]:
|
|
10513
|
-
'''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.
|
|
10514
10651
|
|
|
10515
10652
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration
|
|
10516
10653
|
'''
|
|
@@ -10535,9 +10672,11 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10535
10672
|
)
|
|
10536
10673
|
class CompromisedCredentialsActionsTypeProperty:
|
|
10537
10674
|
def __init__(self, *, event_action: builtins.str) -> None:
|
|
10538
|
-
'''
|
|
10675
|
+
'''Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function ``ENFORCED`` mode.
|
|
10539
10676
|
|
|
10540
|
-
|
|
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.
|
|
10541
10680
|
|
|
10542
10681
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html
|
|
10543
10682
|
:exampleMetadata: fixture=_generated
|
|
@@ -10561,7 +10700,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10561
10700
|
|
|
10562
10701
|
@builtins.property
|
|
10563
10702
|
def event_action(self) -> builtins.str:
|
|
10564
|
-
'''The
|
|
10703
|
+
'''The action that Amazon Cognito takes when it detects compromised credentials.
|
|
10565
10704
|
|
|
10566
10705
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction
|
|
10567
10706
|
'''
|
|
@@ -10592,10 +10731,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10592
10731
|
actions: typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
10593
10732
|
event_filter: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10594
10733
|
) -> None:
|
|
10595
|
-
'''
|
|
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>`_ .
|
|
10596
10737
|
|
|
10597
|
-
:param actions:
|
|
10598
|
-
: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.
|
|
10599
10740
|
|
|
10600
10741
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html
|
|
10601
10742
|
:exampleMetadata: fixture=_generated
|
|
@@ -10629,7 +10770,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10629
10770
|
def actions(
|
|
10630
10771
|
self,
|
|
10631
10772
|
) -> typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty"]:
|
|
10632
|
-
'''
|
|
10773
|
+
'''Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
|
|
10633
10774
|
|
|
10634
10775
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions
|
|
10635
10776
|
'''
|
|
@@ -10639,9 +10780,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10639
10780
|
|
|
10640
10781
|
@builtins.property
|
|
10641
10782
|
def event_filter(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10642
|
-
'''
|
|
10783
|
+
'''Settings for the sign-in activity where you want to configure compromised-credentials actions.
|
|
10643
10784
|
|
|
10644
|
-
|
|
10785
|
+
Defaults to all events.
|
|
10645
10786
|
|
|
10646
10787
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter
|
|
10647
10788
|
'''
|
|
@@ -10682,14 +10823,16 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10682
10823
|
no_action_email: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
10683
10824
|
reply_to: typing.Optional[builtins.str] = None,
|
|
10684
10825
|
) -> None:
|
|
10685
|
-
'''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>`_ .
|
|
10686
10829
|
|
|
10687
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.
|
|
10688
|
-
:param block_email:
|
|
10689
|
-
:param from_: The email address that
|
|
10690
|
-
:param mfa_email: The
|
|
10691
|
-
:param no_action_email: The email
|
|
10692
|
-
: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.
|
|
10693
10836
|
|
|
10694
10837
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html
|
|
10695
10838
|
:exampleMetadata: fixture=_generated
|
|
@@ -10767,7 +10910,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10767
10910
|
def block_email(
|
|
10768
10911
|
self,
|
|
10769
10912
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10770
|
-
'''
|
|
10913
|
+
'''The template for the email message that your user pool sends when a detected risk event is blocked.
|
|
10771
10914
|
|
|
10772
10915
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail
|
|
10773
10916
|
'''
|
|
@@ -10776,7 +10919,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10776
10919
|
|
|
10777
10920
|
@builtins.property
|
|
10778
10921
|
def from_(self) -> typing.Optional[builtins.str]:
|
|
10779
|
-
'''The email address that
|
|
10922
|
+
'''The email address that sends the email message.
|
|
10780
10923
|
|
|
10781
10924
|
The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
|
|
10782
10925
|
|
|
@@ -10789,7 +10932,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10789
10932
|
def mfa_email(
|
|
10790
10933
|
self,
|
|
10791
10934
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10792
|
-
'''The
|
|
10935
|
+
'''The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
|
|
10793
10936
|
|
|
10794
10937
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail
|
|
10795
10938
|
'''
|
|
@@ -10800,7 +10943,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10800
10943
|
def no_action_email(
|
|
10801
10944
|
self,
|
|
10802
10945
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty"]]:
|
|
10803
|
-
'''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.
|
|
10804
10947
|
|
|
10805
10948
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail
|
|
10806
10949
|
'''
|
|
@@ -10809,7 +10952,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10809
10952
|
|
|
10810
10953
|
@builtins.property
|
|
10811
10954
|
def reply_to(self) -> typing.Optional[builtins.str]:
|
|
10812
|
-
'''The
|
|
10955
|
+
'''The reply-to email address of an email template.
|
|
10813
10956
|
|
|
10814
10957
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto
|
|
10815
10958
|
'''
|
|
@@ -10844,11 +10987,13 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10844
10987
|
html_body: typing.Optional[builtins.str] = None,
|
|
10845
10988
|
text_body: typing.Optional[builtins.str] = None,
|
|
10846
10989
|
) -> None:
|
|
10847
|
-
'''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>`_ .
|
|
10848
10993
|
|
|
10849
|
-
:param subject: The email
|
|
10850
|
-
:param html_body: The email HTML
|
|
10851
|
-
: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.
|
|
10852
10997
|
|
|
10853
10998
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html
|
|
10854
10999
|
:exampleMetadata: fixture=_generated
|
|
@@ -10882,7 +11027,7 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10882
11027
|
|
|
10883
11028
|
@builtins.property
|
|
10884
11029
|
def subject(self) -> builtins.str:
|
|
10885
|
-
'''The email
|
|
11030
|
+
'''The subject of the threat protection email notification.
|
|
10886
11031
|
|
|
10887
11032
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject
|
|
10888
11033
|
'''
|
|
@@ -10892,7 +11037,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10892
11037
|
|
|
10893
11038
|
@builtins.property
|
|
10894
11039
|
def html_body(self) -> typing.Optional[builtins.str]:
|
|
10895
|
-
'''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.
|
|
10896
11043
|
|
|
10897
11044
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody
|
|
10898
11045
|
'''
|
|
@@ -10901,7 +11048,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10901
11048
|
|
|
10902
11049
|
@builtins.property
|
|
10903
11050
|
def text_body(self) -> typing.Optional[builtins.str]:
|
|
10904
|
-
'''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.
|
|
10905
11054
|
|
|
10906
11055
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody
|
|
10907
11056
|
'''
|
|
@@ -10934,10 +11083,12 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10934
11083
|
blocked_ip_range_list: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10935
11084
|
skipped_ip_range_list: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
10936
11085
|
) -> None:
|
|
10937
|
-
'''
|
|
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>`_ .
|
|
10938
11089
|
|
|
10939
|
-
:param blocked_ip_range_list: Overrides the risk decision
|
|
10940
|
-
: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.
|
|
10941
11092
|
|
|
10942
11093
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html
|
|
10943
11094
|
:exampleMetadata: fixture=_generated
|
|
@@ -10965,9 +11116,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10965
11116
|
|
|
10966
11117
|
@builtins.property
|
|
10967
11118
|
def blocked_ip_range_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10968
|
-
'''
|
|
11119
|
+
'''An always-block IP address list.
|
|
10969
11120
|
|
|
10970
|
-
|
|
11121
|
+
Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
|
|
10971
11122
|
|
|
10972
11123
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist
|
|
10973
11124
|
'''
|
|
@@ -10976,9 +11127,9 @@ class CfnUserPoolRiskConfigurationAttachment(
|
|
|
10976
11127
|
|
|
10977
11128
|
@builtins.property
|
|
10978
11129
|
def skipped_ip_range_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
10979
|
-
'''
|
|
11130
|
+
'''An always-allow IP address list.
|
|
10980
11131
|
|
|
10981
|
-
|
|
11132
|
+
Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
|
|
10982
11133
|
|
|
10983
11134
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist
|
|
10984
11135
|
'''
|
|
@@ -11021,10 +11172,10 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11021
11172
|
'''Properties for defining a ``CfnUserPoolRiskConfigurationAttachment``.
|
|
11022
11173
|
|
|
11023
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`` ).
|
|
11024
|
-
:param user_pool_id: The user pool
|
|
11025
|
-
:param account_takeover_risk_configuration: The
|
|
11026
|
-
:param compromised_credentials_risk_configuration:
|
|
11027
|
-
: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.
|
|
11028
11179
|
|
|
11029
11180
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html
|
|
11030
11181
|
:exampleMetadata: fixture=_generated
|
|
@@ -11132,7 +11283,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11132
11283
|
|
|
11133
11284
|
@builtins.property
|
|
11134
11285
|
def user_pool_id(self) -> builtins.str:
|
|
11135
|
-
'''The user pool
|
|
11286
|
+
'''The ID of the user pool that has the risk configuration applied.
|
|
11136
11287
|
|
|
11137
11288
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid
|
|
11138
11289
|
'''
|
|
@@ -11144,7 +11295,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11144
11295
|
def account_takeover_risk_configuration(
|
|
11145
11296
|
self,
|
|
11146
11297
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty]]:
|
|
11147
|
-
'''The
|
|
11298
|
+
'''The settings for automated responses and notification templates for adaptive authentication with advanced security features.
|
|
11148
11299
|
|
|
11149
11300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration
|
|
11150
11301
|
'''
|
|
@@ -11155,7 +11306,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11155
11306
|
def compromised_credentials_risk_configuration(
|
|
11156
11307
|
self,
|
|
11157
11308
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty]]:
|
|
11158
|
-
'''
|
|
11309
|
+
'''Settings for compromised-credentials actions and authentication types with advanced security features in full-function ``ENFORCED`` mode.
|
|
11159
11310
|
|
|
11160
11311
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration
|
|
11161
11312
|
'''
|
|
@@ -11166,7 +11317,7 @@ class CfnUserPoolRiskConfigurationAttachmentProps:
|
|
|
11166
11317
|
def risk_exception_configuration(
|
|
11167
11318
|
self,
|
|
11168
11319
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty]]:
|
|
11169
|
-
'''
|
|
11320
|
+
'''Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
|
|
11170
11321
|
|
|
11171
11322
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration
|
|
11172
11323
|
'''
|
|
@@ -11668,7 +11819,9 @@ class CfnUserPoolUser(
|
|
|
11668
11819
|
name: typing.Optional[builtins.str] = None,
|
|
11669
11820
|
value: typing.Optional[builtins.str] = None,
|
|
11670
11821
|
) -> None:
|
|
11671
|
-
'''
|
|
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>`_ .
|
|
11672
11825
|
|
|
11673
11826
|
:param name: The name of the attribute.
|
|
11674
11827
|
:param value: The value of the attribute.
|
|
@@ -17725,15 +17878,16 @@ class UserPoolIdentityProviderApple(
|
|
|
17725
17878
|
|
|
17726
17879
|
# The code below shows an example of how to instantiate this type.
|
|
17727
17880
|
# The values are placeholders you should change.
|
|
17881
|
+
import aws_cdk as cdk
|
|
17728
17882
|
from aws_cdk import aws_cognito as cognito
|
|
17729
17883
|
|
|
17730
17884
|
# provider_attribute: cognito.ProviderAttribute
|
|
17885
|
+
# secret_value: cdk.SecretValue
|
|
17731
17886
|
# user_pool: cognito.UserPool
|
|
17732
17887
|
|
|
17733
17888
|
user_pool_identity_provider_apple = cognito.UserPoolIdentityProviderApple(self, "MyUserPoolIdentityProviderApple",
|
|
17734
17889
|
client_id="clientId",
|
|
17735
17890
|
key_id="keyId",
|
|
17736
|
-
private_key="privateKey",
|
|
17737
17891
|
team_id="teamId",
|
|
17738
17892
|
user_pool=user_pool,
|
|
17739
17893
|
|
|
@@ -17760,6 +17914,8 @@ class UserPoolIdentityProviderApple(
|
|
|
17760
17914
|
timezone=provider_attribute,
|
|
17761
17915
|
website=provider_attribute
|
|
17762
17916
|
),
|
|
17917
|
+
private_key="privateKey",
|
|
17918
|
+
private_key_value=secret_value,
|
|
17763
17919
|
scopes=["scopes"]
|
|
17764
17920
|
)
|
|
17765
17921
|
'''
|
|
@@ -17771,8 +17927,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17771
17927
|
*,
|
|
17772
17928
|
client_id: builtins.str,
|
|
17773
17929
|
key_id: builtins.str,
|
|
17774
|
-
private_key: builtins.str,
|
|
17775
17930
|
team_id: builtins.str,
|
|
17931
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
17932
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
17776
17933
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
17777
17934
|
user_pool: IUserPool,
|
|
17778
17935
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -17782,8 +17939,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17782
17939
|
:param id: -
|
|
17783
17940
|
:param client_id: The client id recognized by Apple APIs.
|
|
17784
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.
|
|
17785
|
-
:param private_key: The privateKey content for Apple APIs to authenticate the client.
|
|
17786
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
|
|
17787
17945
|
:param scopes: The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]
|
|
17788
17946
|
:param user_pool: The user pool to which this construct provides identities.
|
|
17789
17947
|
:param attribute_mapping: Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping
|
|
@@ -17795,8 +17953,9 @@ class UserPoolIdentityProviderApple(
|
|
|
17795
17953
|
props = UserPoolIdentityProviderAppleProps(
|
|
17796
17954
|
client_id=client_id,
|
|
17797
17955
|
key_id=key_id,
|
|
17798
|
-
private_key=private_key,
|
|
17799
17956
|
team_id=team_id,
|
|
17957
|
+
private_key=private_key,
|
|
17958
|
+
private_key_value=private_key_value,
|
|
17800
17959
|
scopes=scopes,
|
|
17801
17960
|
user_pool=user_pool,
|
|
17802
17961
|
attribute_mapping=attribute_mapping,
|
|
@@ -20324,8 +20483,9 @@ class UserPoolIdentityProviderAmazonProps(UserPoolIdentityProviderProps):
|
|
|
20324
20483
|
"attribute_mapping": "attributeMapping",
|
|
20325
20484
|
"client_id": "clientId",
|
|
20326
20485
|
"key_id": "keyId",
|
|
20327
|
-
"private_key": "privateKey",
|
|
20328
20486
|
"team_id": "teamId",
|
|
20487
|
+
"private_key": "privateKey",
|
|
20488
|
+
"private_key_value": "privateKeyValue",
|
|
20329
20489
|
"scopes": "scopes",
|
|
20330
20490
|
},
|
|
20331
20491
|
)
|
|
@@ -20337,8 +20497,9 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20337
20497
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20338
20498
|
client_id: builtins.str,
|
|
20339
20499
|
key_id: builtins.str,
|
|
20340
|
-
private_key: builtins.str,
|
|
20341
20500
|
team_id: builtins.str,
|
|
20501
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
20502
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
20342
20503
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
20343
20504
|
) -> None:
|
|
20344
20505
|
'''Properties to initialize UserPoolAppleIdentityProvider.
|
|
@@ -20347,8 +20508,9 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20347
20508
|
:param attribute_mapping: Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping
|
|
20348
20509
|
:param client_id: The client id recognized by Apple APIs.
|
|
20349
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.
|
|
20350
|
-
:param private_key: The privateKey content for Apple APIs to authenticate the client.
|
|
20351
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
|
|
20352
20514
|
:param scopes: The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]
|
|
20353
20515
|
|
|
20354
20516
|
:exampleMetadata: fixture=_generated
|
|
@@ -20357,15 +20519,16 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20357
20519
|
|
|
20358
20520
|
# The code below shows an example of how to instantiate this type.
|
|
20359
20521
|
# The values are placeholders you should change.
|
|
20522
|
+
import aws_cdk as cdk
|
|
20360
20523
|
from aws_cdk import aws_cognito as cognito
|
|
20361
20524
|
|
|
20362
20525
|
# provider_attribute: cognito.ProviderAttribute
|
|
20526
|
+
# secret_value: cdk.SecretValue
|
|
20363
20527
|
# user_pool: cognito.UserPool
|
|
20364
20528
|
|
|
20365
20529
|
user_pool_identity_provider_apple_props = cognito.UserPoolIdentityProviderAppleProps(
|
|
20366
20530
|
client_id="clientId",
|
|
20367
20531
|
key_id="keyId",
|
|
20368
|
-
private_key="privateKey",
|
|
20369
20532
|
team_id="teamId",
|
|
20370
20533
|
user_pool=user_pool,
|
|
20371
20534
|
|
|
@@ -20392,6 +20555,8 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20392
20555
|
timezone=provider_attribute,
|
|
20393
20556
|
website=provider_attribute
|
|
20394
20557
|
),
|
|
20558
|
+
private_key="privateKey",
|
|
20559
|
+
private_key_value=secret_value,
|
|
20395
20560
|
scopes=["scopes"]
|
|
20396
20561
|
)
|
|
20397
20562
|
'''
|
|
@@ -20403,18 +20568,22 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20403
20568
|
check_type(argname="argument attribute_mapping", value=attribute_mapping, expected_type=type_hints["attribute_mapping"])
|
|
20404
20569
|
check_type(argname="argument client_id", value=client_id, expected_type=type_hints["client_id"])
|
|
20405
20570
|
check_type(argname="argument key_id", value=key_id, expected_type=type_hints["key_id"])
|
|
20406
|
-
check_type(argname="argument private_key", value=private_key, expected_type=type_hints["private_key"])
|
|
20407
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"])
|
|
20408
20574
|
check_type(argname="argument scopes", value=scopes, expected_type=type_hints["scopes"])
|
|
20409
20575
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
20410
20576
|
"user_pool": user_pool,
|
|
20411
20577
|
"client_id": client_id,
|
|
20412
20578
|
"key_id": key_id,
|
|
20413
|
-
"private_key": private_key,
|
|
20414
20579
|
"team_id": team_id,
|
|
20415
20580
|
}
|
|
20416
20581
|
if attribute_mapping is not None:
|
|
20417
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
|
|
20418
20587
|
if scopes is not None:
|
|
20419
20588
|
self._values["scopes"] = scopes
|
|
20420
20589
|
|
|
@@ -20451,13 +20620,6 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20451
20620
|
assert result is not None, "Required property 'key_id' is missing"
|
|
20452
20621
|
return typing.cast(builtins.str, result)
|
|
20453
20622
|
|
|
20454
|
-
@builtins.property
|
|
20455
|
-
def private_key(self) -> builtins.str:
|
|
20456
|
-
'''The privateKey content for Apple APIs to authenticate the client.'''
|
|
20457
|
-
result = self._values.get("private_key")
|
|
20458
|
-
assert result is not None, "Required property 'private_key' is missing"
|
|
20459
|
-
return typing.cast(builtins.str, result)
|
|
20460
|
-
|
|
20461
20623
|
@builtins.property
|
|
20462
20624
|
def team_id(self) -> builtins.str:
|
|
20463
20625
|
'''The teamId for Apple APIs to authenticate the client.'''
|
|
@@ -20465,6 +20627,28 @@ class UserPoolIdentityProviderAppleProps(UserPoolIdentityProviderProps):
|
|
|
20465
20627
|
assert result is not None, "Required property 'team_id' is missing"
|
|
20466
20628
|
return typing.cast(builtins.str, result)
|
|
20467
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
|
+
|
|
20468
20652
|
@builtins.property
|
|
20469
20653
|
def scopes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
20470
20654
|
'''The list of apple permissions to obtain for getting access to the apple profile.
|
|
@@ -21551,6 +21735,8 @@ def _typecheckingstub__32d20f28e2758f9a461380e2ed5d06233baf0f45541047ba837f26ebc
|
|
|
21551
21735
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
21552
21736
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
21553
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,
|
|
21554
21740
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
21555
21741
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
21556
21742
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -21621,6 +21807,18 @@ def _typecheckingstub__7eb821a70b459056b6d26722d06f8b948b315111a936804d8aba0e7ff
|
|
|
21621
21807
|
"""Type checking stubs"""
|
|
21622
21808
|
pass
|
|
21623
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
|
+
|
|
21624
21822
|
def _typecheckingstub__32d0b53f74dc294b25f20f54bcdaf8477a3dfc8b505387d70f97f7febe6ae209(
|
|
21625
21823
|
value: typing.Optional[typing.Union[_IResolvable_da3f097b, CfnUserPool.EmailConfigurationProperty]],
|
|
21626
21824
|
) -> None:
|
|
@@ -22351,6 +22549,8 @@ def _typecheckingstub__00bbdbd31eb8d7342ce9883d0851b853acf61f6b243c0aa4323c025da
|
|
|
22351
22549
|
auto_verified_attributes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
22352
22550
|
deletion_protection: typing.Optional[builtins.str] = None,
|
|
22353
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,
|
|
22354
22554
|
email_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnUserPool.EmailConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
22355
22555
|
email_verification_message: typing.Optional[builtins.str] = None,
|
|
22356
22556
|
email_verification_subject: typing.Optional[builtins.str] = None,
|
|
@@ -23355,8 +23555,9 @@ def _typecheckingstub__61dda0b78f30fe868c5e696b0c3d3ee7c446cd2575608fc4036cf6dac
|
|
|
23355
23555
|
*,
|
|
23356
23556
|
client_id: builtins.str,
|
|
23357
23557
|
key_id: builtins.str,
|
|
23358
|
-
private_key: builtins.str,
|
|
23359
23558
|
team_id: builtins.str,
|
|
23559
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
23560
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
23360
23561
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
23361
23562
|
user_pool: IUserPool,
|
|
23362
23563
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -23596,8 +23797,9 @@ def _typecheckingstub__ca5d3950db19200b5bbdc4fb3e51e3c9b38fc4572683061b8e4485d0f
|
|
|
23596
23797
|
attribute_mapping: typing.Optional[typing.Union[AttributeMapping, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23597
23798
|
client_id: builtins.str,
|
|
23598
23799
|
key_id: builtins.str,
|
|
23599
|
-
private_key: builtins.str,
|
|
23600
23800
|
team_id: builtins.str,
|
|
23801
|
+
private_key: typing.Optional[builtins.str] = None,
|
|
23802
|
+
private_key_value: typing.Optional[_SecretValue_3dd0ddae] = None,
|
|
23601
23803
|
scopes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
23602
23804
|
) -> None:
|
|
23603
23805
|
"""Type checking stubs"""
|