(aws-cognito): L2 Construct support for analytics configuration

[wladyslawczyzewski]

Describe the feature

At this moment, to configure native integration of Cognito's App Client with the Pinpoint project you can either do this from the AWS Console or use the workaround like showed below.

CDK already has the L2 construct for Cognito App Client and we need to extend this construct to allow engineers to configure the integration from the L2 construct props instead of L1 construct.

    (
      client.node.defaultChild as cognito.CfnUserPoolClient
    ).analyticsConfiguration = {
      userDataShared: true,
      applicationArn: props.analyticsAppArn,
    };

Use Case

Cognito has the native integration with Pinpoint analytics useful for operations like InitiateAuth, RespondToAuthChallenge and few others. This integration allows Cognito App Client to send the analytic events to Pinpoint without implementing this separately.

Proposed Solution

No response

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.173.2

Environment details (OS name and version, etc.)

macOS, Node v22

[khushail]

Hi @wladyslawczyzewski , thanks for opening this feature request. Yes, this is currently no available in L2 construct UserPoolClientProps -

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolClientProps.html

Here is L1 constuct pointing to User pool client for analytics configuration -

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPoolClient.html#analyticsconfiguration

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration

An L2 support would be great. Thanks for volunteering for contribution. Looking forward to your PR!

[wladyslawczyzewski]

oops, looks like we both were working on this issue @ren-yamanashi :) thanks for you contribution! closing my PR in that case.

[ren-yamanashi]

oops, looks like we both were working on this issue @ren-yamanashi :) thanks for you contribution! closing my PR in that case.

@wladyslawczyzewski

I apologize for neglecting to confirm that you are allowed to submit a PR.
Also, thank you for leaving my PR 🙏

[wladyslawczyzewski]

@ren-yamanashi thank you for your work on this! hopefully someone from maintainers team will merge it soon :)

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.