Skip to content

Commit

Permalink
docs(cognito): update selfSignUpEnabled documentation (#27872)
Browse files Browse the repository at this point in the history
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*
  • Loading branch information
lpizzinidev committed Nov 7, 2023
1 parent 4bd3b05 commit 2d0c1d0
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions packages/aws-cdk-lib/aws-cognito/lib/user-pool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -518,34 +518,39 @@ export enum AdvancedSecurityMode {
*/
export interface UserPoolProps {
/**
* Name of the user pool
* Name of the user pool.
*
* @default - automatically generated name by CloudFormation at deploy time
* @default - automatically generated name by CloudFormation at deploy time.
*/
readonly userPoolName?: string;

/**
* Whether self sign up should be enabled. This can be further configured via the `selfSignUp` property.
* @default false
* Whether self sign-up should be enabled.
* To configure self sign-up configuration use the `userVerification` property.
*
* @default - false
*/
readonly selfSignUpEnabled?: boolean;

/**
* Configuration around users signing themselves up to the user pool.
* Enable or disable self sign-up via the `selfSignUpEnabled` property.
* @default - see defaults in UserVerificationConfig
*
* @default - see defaults in UserVerificationConfig.
*/
readonly userVerification?: UserVerificationConfig;

/**
* Configuration around admins signing up users into a user pool.
* @default - see defaults in UserInvitationConfig
*
* @default - see defaults in UserInvitationConfig.
*/
readonly userInvitation?: UserInvitationConfig;

/**
* The IAM role that Cognito will assume while sending SMS messages.
* @default - a new IAM role is created
*
* @default - a new IAM role is created.
*/
readonly smsRole?: IRole;

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

/**
* The region to integrate with SNS to send SMS messages
* The region to integrate with SNS to send SMS messages.
*
* This property will do nothing if SMS configuration is not configured.
*
* This property will do nothing if SMS configuration is not configured
* @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
*/
readonly snsRegion?: string;

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

0 comments on commit 2d0c1d0

Please sign in to comment.