CloudFormation Serverless InviteMessageTemplate Configuration

Question

From what I can tell, there is not a configuration specified in the Cognito User Pool specification that configures the Invitation Message Email. The 'Verification Message' can be configured here and whilst there is a document and field InviteMessageTemplate ref that suggests it would work for this, it doesn't actually appear to do so. Configuring this value results in an error:

Error:
UPDATE_FAILED: CognitoUserPool (AWS::Cognito::UserPool)
Properties validation failed for resource CognitoUserPool with message:
[#: extraneous key [InviteMessageTemplate] is not permitted]

Cloud formation will wipe out the existing template without being able to configure this value. Why isn't this value supported despite being in the documentation? How else can the invite message be configured through CloudFormation/Serverless deployments?

```
Error:
UPDATE_FAILED: CognitoUserPool (AWS::Cognito::UserPool)
Properties validation failed for resource CognitoUserPool with message:
[#: extraneous key [InviteMessageTemplate] is not permitted]
```

Cloud formation will wipe out the existing template without being able to configure this value. Why isn't this value supported despite being in the documentation? How else can the invite message be configured through CloudFormation/Serverless deployments?

nmcclainsimpsonReasint · Accepted Answer

It's not clear given these documents that the InviteMessage is nested under [AdminCreateUserConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html)

CloudFormation Serverless InviteMessageTemplate Configuration

Relevant content