(aws-cognito): lambdaConfig.customEmailSender description seems incorrect

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cognito.CfnUserPool.CustomEmailSenderProperty.html

The docs say lambdaArn and lambdaVersion are both optional. However, when I specify this in my code:

  userPool.lambdaConfig = {
    customEmailSender: {
      lambdaArn: props.cognitoEmailSender.functionArn,
    },
  };

I get this error upon deployment to CloudFormation:

1 validation error detected: Value null at 'lambdaConfig.customEmailSender.lambdaVersion' failed to satisfy constraint: Member must not be null (Service: AWSCognitoIdentityProviderService; Status Code: 400; Error Code: InvalidParameterException; Request ID: 5383d3db-671c-4fa0-b85d-c659dfc3c29a; Proxy: null)

So the Lambda version is required?

---

This is a 📕 documentation issue

[ffxsam]

@RatulSaha Sure!

  const userPool = new cognito.UserPool(stack, 'UserPool', {
    // ... params
  });

  const cognitoEmailSender = new sst.Function(stack, 'CognitoEmailSender', {
    functionName: `${stack.stackName}-cognitoEmailSender`,
    handler: 'lambda/auth/cognito-email-sender.main',
  });

  // Allow Cognito to invoke the email sender Lambda
  cognitoEmailSender.grantInvoke(
    new iam.ServicePrincipal('cognito-idp.amazonaws.com')
  );

  const kmsKey = new kms.Key(stack, 'AuthKmsKey', {
    description: 'Required by Cognito',
    removalPolicy:
      stack.stage === 'prod' ? RemovalPolicy.RETAIN : RemovalPolicy.DESTROY,
  });

  (userPool.node.defaultChild as cognito.CfnUserPool).lambdaConfig = {
    customEmailSender: {
      lambdaArn: cognitoEmailSender.functionArn,
      lambdaVersion: 'V1_0',
    },
    kmsKeyId: kmsKey.keyArn,
  };

[github-actions[bot]]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.