Is it possible to include the logo file using the cloud formation template in the user pool client (AWS::Cognito::UserPoolUICustomizationAttachment)?

Question

I want to include a logo file in the AWS::Cognito::UserPoolUICustomizationAttachment template how can I do that?

I tried creating an image URL ImageFile: URL of the image but it is not working
I tried converting the Image URL into BASE64 ImageFile: Base64-encoded binary data object but it is not working
I am expecting that I need to upload my logo file for AWS::Cognito::UserPoolUICustomizationAttachment by using the YAML template

this is the error that we are getting during cloud formation template upload ---- Property validation failure:
[Encountered unsupported properties in {/}: [ImageFile]]

Answer

Hi,

It's not possible. According to the documentation https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html

```
Setting a logo image isn't supported from AWS CloudFormation. Use the Amazon Cognito SetUICustomization API operation to set the image.
```

Answer

Hi vallukoti,

One thing you could do, requires some more plumbing, is have a Lambda which is called during stack creation [1]. What this Lambda does is call the set_ui_customization function of Cognito's user pool [2].

[1] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/walkthrough-custom-resources-lambda-lookup-amiids.html

[2]https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/set_ui_customization.html

Hope this helps!

Cheers,
Andrei

Is it possible to include the logo file using the cloud formation template in the user pool client (AWS::Cognito::UserPoolUICustomizationAttachment)?

Relevant content