UserInvitationConfig¶

class aws_cdk.aws_cognito.UserInvitationConfig(*, email_body=None, email_subject=None, sms_message=None)¶

Bases: object

User pool configuration when administrators sign users up.

Parameters

email_body (Optional[str]) – The template to the email body that is sent to the user when an administrator signs them up to the user pool. Default: ‘Your username is {username} and temporary password is {####}.’
email_subject (Optional[str]) – The template to the email subject that is sent to the user when an administrator signs them up to the user pool. Default: ‘Your temporary password’
sms_message (Optional[str]) – The template to the SMS message that is sent to the user when an administrator signs them up to the user pool. Default: ‘Your username is {username} and temporary password is {####}’

ExampleMetadata

infused

Example:

cognito.UserPool(self, "myuserpool",
    # ...
    user_invitation=cognito.UserInvitationConfig(
        email_subject="Invite to join our awesome app!",
        email_body="Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}",
        sms_message="Hello {username}, your temporary password for our awesome app is {####}"
    )
)

Attributes

email_body¶

The template to the email body that is sent to the user when an administrator signs them up to the user pool.

Default: ‘Your username is {username} and temporary password is {####}.’
Return type: Optional[str]

email_subject¶

The template to the email subject that is sent to the user when an administrator signs them up to the user pool.

Default: ‘Your temporary password’
Return type: Optional[str]

sms_message¶

The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

Default: ‘Your username is {username} and temporary password is {####}’
Return type: Optional[str]