AWS::Cognito::UserPoolClient AnalyticsConfiguration - AWS CloudFormation

AWS::Cognito::UserPoolClient AnalyticsConfiguration

ユーザープールのメトリクスを収集するための Amazon Pinpoint 分析設定。

注記

Pinpoint が利用できないリージョンでは、Cognito ユーザープールは us-east-1 の Amazon Pinpoint プロジェクトへのイベントの送信のみをサポートします。Pinpoint を使用できるリージョンでは、Cognito ユーザープールは、同じリージョン内の Amazon Pinpoint プロジェクトへのイベントの送信をサポートします。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "ApplicationId" : String, "ExternalId" : String, "RoleArn" : String, "UserDataShared" : Boolean }

YAML

ApplicationId: String ExternalId: String RoleArn: String UserDataShared: Boolean

プロパティ

ApplicationId

Amazon Pinpoint アプリケーションのアプリケーション ID。

必須: いいえ

タイプ: 文字列

パターン: ^[0-9a-fA-F]+$

Update requires: No interruption

ExternalId

外部 ID。

必須: いいえ

タイプ: 文字列

最小: 2

最大: 1224

パターン: [\w+=,.@:\/-]*

Update requires: No interruption

RoleArn

Amazon Cognito が Amazon Pinpoint 分析にイベントを発行することを許可する IAM ロールの ARN。

必須: いいえ

タイプ: 文字列

最小: 20

最大: 2048

パターン: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Update requires: No interruption

UserDataShared

UserDataSharedtrue の場合、Amazon Cognito は Amazon Pinpoint 分析に発行するイベントにユーザーデータを含めます。

必須: いいえ

タイプ: ブール値

Update requires: No interruption