Skip to content

Commit 2d0c1d0

Browse files
authored
docs(cognito): update selfSignUpEnabled documentation (#27872)
Removes reference to non-existing `selfSignUp` attribute and adjusts formatting. Closes #27829. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 4bd3b05 commit 2d0c1d0

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

packages/aws-cdk-lib/aws-cognito/lib/user-pool.ts

+18-10
Original file line numberDiff line numberDiff line change
@@ -518,34 +518,39 @@ export enum AdvancedSecurityMode {
518518
*/
519519
export interface UserPoolProps {
520520
/**
521-
* Name of the user pool
521+
* Name of the user pool.
522522
*
523-
* @default - automatically generated name by CloudFormation at deploy time
523+
* @default - automatically generated name by CloudFormation at deploy time.
524524
*/
525525
readonly userPoolName?: string;
526526

527527
/**
528-
* Whether self sign up should be enabled. This can be further configured via the `selfSignUp` property.
529-
* @default false
528+
* Whether self sign-up should be enabled.
529+
* To configure self sign-up configuration use the `userVerification` property.
530+
*
531+
* @default - false
530532
*/
531533
readonly selfSignUpEnabled?: boolean;
532534

533535
/**
534536
* Configuration around users signing themselves up to the user pool.
535537
* Enable or disable self sign-up via the `selfSignUpEnabled` property.
536-
* @default - see defaults in UserVerificationConfig
538+
*
539+
* @default - see defaults in UserVerificationConfig.
537540
*/
538541
readonly userVerification?: UserVerificationConfig;
539542

540543
/**
541544
* Configuration around admins signing up users into a user pool.
542-
* @default - see defaults in UserInvitationConfig
545+
*
546+
* @default - see defaults in UserInvitationConfig.
543547
*/
544548
readonly userInvitation?: UserInvitationConfig;
545549

546550
/**
547551
* The IAM role that Cognito will assume while sending SMS messages.
548-
* @default - a new IAM role is created
552+
*
553+
* @default - a new IAM role is created.
549554
*/
550555
readonly smsRole?: IRole;
551556

@@ -554,21 +559,24 @@ export interface UserPoolProps {
554559
* Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
555560
*
556561
* This property will be ignored if `smsRole` is not specified.
557-
* @default - No external id will be configured
562+
*
563+
* @default - No external id will be configured.
558564
*/
559565
readonly smsRoleExternalId?: string;
560566

561567
/**
562-
* The region to integrate with SNS to send SMS messages
568+
* The region to integrate with SNS to send SMS messages.
569+
*
570+
* This property will do nothing if SMS configuration is not configured.
563571
*
564-
* This property will do nothing if SMS configuration is not configured
565572
* @default - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
566573
*/
567574
readonly snsRegion?: string;
568575

569576
/**
570577
* Setting this would explicitly enable or disable SMS role creation.
571578
* When left unspecified, CDK will determine based on other properties if a role is needed or not.
579+
*
572580
* @default - CDK will determine based on other properties of the user pool if an SMS role should be created or not.
573581
*/
574582
readonly enableSmsRole?: boolean;

0 commit comments

Comments
 (0)