interface UserInvitationConfig
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.UserInvitationConfig |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserInvitationConfig |
![]() | software.amazon.awscdk.services.cognito.UserInvitationConfig |
![]() | aws_cdk.aws_cognito.UserInvitationConfig |
![]() | aws-cdk-lib » aws_cognito » UserInvitationConfig |
User pool configuration when administrators sign users up.
Example
new cognito.UserPool(this, 'myuserpool', {
// ...
userInvitation: {
emailSubject: 'Invite to join our awesome app!',
emailBody: 'Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}',
smsMessage: 'Hello {username}, your temporary password for our awesome app is {####}',
},
});
Properties
Name | Type | Description |
---|---|---|
email | string | The template to the email body that is sent to the user when an administrator signs them up to the user pool. |
email | string | The template to the email subject that is sent to the user when an administrator signs them up to the user pool. |
sms | string | The template to the SMS message that is sent to the user when an administrator signs them up to the user pool. |
emailBody?
Type:
string
(optional, default: 'Your username is {username} and temporary password is {####}.')
The template to the email body that is sent to the user when an administrator signs them up to the user pool.
emailSubject?
Type:
string
(optional, default: 'Your temporary password')
The template to the email subject that is sent to the user when an administrator signs them up to the user pool.
smsMessage?
Type:
string
(optional, default: 'Your username is {username} and temporary password is {####}')
The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.