はじめに
前回この記事でQuickSightのRLSを考慮した匿名ユーザー向けの埋め込みダッシュボードの表示について説明しましたが、登録済みユーザーのダッシュボードも試したので記録として残しておきます。
前編及び後編で作成したダッシュボードやソースをもとに設定を追加していくので、実際に手を動かして確認する場合はまず前編及び後編を確認してみてください。
匿名ユーザーと登録済みユーザーの埋め込みダッシュボードの違い
前回作成した匿名ユーザーの埋め込みダッシュボードと、登録済みユーザーの埋め込みダッシュボードには次のような違いがあります。
登録済みユーザーの埋め込みダッシュボードは、
EnterpriseEditionは必須だが、セッションキャパシティープランでなくても利用できる
ダッシュボード表示時にQuickSightのReader以上のアカウントを割り当てる必要がある
セッションタグを利用した行レベルセキュリティー(RLS)は利用できないため、事前にユーザーごとのRLSを設定する必要がある
やはり一番の違いはセッションキャパシティープランでなくても利用できる点だと思います。セッションキャパシティープランを必要とする匿名ユーザーの埋め込みダッシュボードでは開いたセッション数で課金されるのに対し、登録済みユーザーの埋め込みダッシュボードでは登録されたユーザーの数で課金されます。
QuickSight 料金
このため、ダッシュボードの利用人数は少ないんだけれど特定の人が良く見るとか、一人当たりのダッシュボード表示回数はあまりないんだけれどとにかく利用者数が多いといった埋め込みダッシュボードの表示パターンをもとにQuickSightの契約プランを検討する必要があります。
また、いつRLSを割り当てるかも重要な観点です。登録済みユーザーの埋め込みダッシュボードではセッションタグが利用できないため、RLSは事前に登録しておく必要があります。匿名ダッシュボードのようにダッシュボードURL発行時に割り当てるRLSを制御できない点も注意が必要です。
グループの追加
匿名ユーザーの埋め込みダッシュボードの場合、作成したダッシュボードはユーザーかグループに対して事前に共有しておく必要があります。ユーザーごとにダッシュボードを共有するとユーザー登録が煩雑になるため、ダッシュボードをグループに共有しそのグループにユーザーを登録してあげたほうが運用しやすいと思います。グループはUIからは追加できないのでAWS CLIから登録する必要があります。
aws quicksight create-group --aws-account-id $awsAccountId --namespace default --group-name SampleDashboard
{
"Status": 201,
"Group": {
"Arn": "arn:aws:quicksight:ap-northeast-1:xxxxxxxxxxxx:group/default/SampleDashboard",
"GroupName": "SampleDashboard",
"PrincipalId": "group/d-xxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
ダッシュボードをグループに公開
埋め込みたいダッシュボードを先ほど作成したグループに割り当てていきます。ここはUIからやったほうが分かりやすいのでUIで操作します。
ダッシュボードの共有メニューから
共有したいグループを検索して共有ボタンをクリックします。
ダッシュボードアクセスの管理ボタンをクリックすると、現在共有されているユーザー、もしくはグループの一覧を確認できます。
登録済みユーザーの埋め込みダッシュボードの表示
それではダッシュボードを表示していきましょう。
まずはダッシュボードを表示するためのユーザーを登録し、先ほどダッシュボードを公開したグループに所属させます。
ユーザーの登録やグループへの参加はあらかじめCLIから設定しておいてもよいのですが、アプリ側でダッシュボードURLの作成時にQuickSightのユーザーを登録してグループに参加させたほうが運用が楽になるケースが多いと思うので、ここからはアプリ側で実装していきます。
前回使った画面に登録済みユーザーでダッシュボードを表示するためのボタンを一つ配置しておきます。
Index.cshtml
@page
@model IndexModel
@{
ViewData["Title"] = "Home page";
}
<div class="text-center">
<form method="post">
<div><select asp-for="SelectedDashboard" asp-items="Model.DashboardList" name="dashboard" id="dashboard"></select></div>
<div><input type="submit" value="表示(User)" asp-page-handler="ViewDashboardForUser"/></div>
<div><input type="submit" value="表示(Admin)" asp-page-handler="ViewDashboardForAdmin"/></div>
+ <div><input type="submit" value="表示(test1ユーザー)" asp-page-handler="ViewDashboardForTest1User"/></div>
</form>
@if (!string.IsNullOrEmpty(Model.EmbedDashboardUrl))
{
<div style="width: 100%">
<iframe style="width: 100%; height: 600px" src="@Model.EmbedDashboardUrl"></iframe>
</div>
}
</div>
このボタンを押されたときに実施するのは次の3つです。
1.ユーザーを取得（いなかったら登録）
2.ユーザーをグループに追加
3.埋め込みダッシュボードのURLを取得してページのEmbedDashboardUrlプロパティーに設定
ここでは固定でtest1@example.comというユーザーをQuickSightのユーザーとして作成していますが、実際はアプリ側で認証したユーザーのメールアドレスなどを使うことになると思います（アプリ側ではここで現在のユーザーが埋め込みダッシュボードを表示できるかのチェックを行ってもよいですね）。
Index.cshtml.cs
public async Task OnPostViewDashboardForTest1User(string dashboard)
{
const string userName = "test1@example.com";
// STSからAWSのアカウントIDを取得し
var account = await _amazonSecurityTokenService.GetCallerIdentityAsync(new GetCallerIdentityRequest());
await LoadDashBoardsAsync(account.Account);
// 1.ユーザーを取得（いなかったら登録）
var quickSightUserArn = await GetUserArnAsync(account.Account, "default", userName);
if (string.IsNullOrEmpty(quickSightUserArn))
{
quickSightUserArn = await RegisterUserAsync(account.Account, "default", userName, UserRole.READER);
}
// 2.ユーザーをグループに追加
await _amazonQuickSight.CreateGroupMembershipAsync(
new CreateGroupMembershipRequest
{
AwsAccountId = account.Account,
GroupName = "SampleDashboard",
Namespace = "default",
MemberName = userName
});
// 3.埋め込みダッシュボードのURLを取得
var response = await _amazonQuickSight.GenerateEmbedUrlForRegisteredUserAsync(new GenerateEmbedUrlForRegisteredUserRequest
{
AwsAccountId = account.Account,
ExperienceConfiguration = new RegisteredUserEmbeddingExperienceConfiguration
{
Dashboard = new RegisteredUserDashboardEmbeddingConfiguration
{
InitialDashboardId = dashboard,
}
},
UserArn = quickSightUserArn,
SessionLifetimeInMinutes = 15,
});
EmbedDashboardUrl = response.EmbedUrl;
}
ユーザーの存在を確認するにはユーザー一覧を取得するAPI(ListUserAsync)を呼んでもいいのですが、ユーザーでフィルターするインターフェイスが無いので全ユーザーをロードしてしまいます。ここではユーザーが存在するかはユーザーの詳細表示API（DescribeUserAsync）を呼び出して、ResourceNotFoundExceptionが発生したかどうかで判断しています。
public async Task<string> GetUserArnAsync(string awsAccountId, string @namespace, string userName)
{
try
{
var user = await _amazonQuickSight.DescribeUserAsync(new DescribeUserRequest
{
AwsAccountId = awsAccountId,
Namespace = @namespace,
UserName = userName
});
return user.User.Arn;
}
catch (ResourceNotFoundException)
{
return null;
}
}
public async Task<string> RegisterUserAsync(string awsAccountId, string @namespace, string userName, UserRole userRole)
{
var registerUserResponse = await _amazonQuickSight.RegisterUserAsync(new RegisterUserRequest
{
AwsAccountId = awsAccountId,
Namespace = @namespace,
IdentityType = IdentityType.QUICKSIGHT,
Email = userName,
UserName = userName,
UserRole = userRole
});
return registerUserResponse.User.Arn;
}
さっそく実行してあげましょう。ローカルで実行する場合はngrokでブリッジしQuickSightにドメインを登録するのを忘れないでください。
... おや？
あっ！肝心なRLSを追加するのを忘れていましたね。
RLSをCSVで設定している場合、新しいファイルをアップロードして更新する必要があるので新しいデータセットからデータセットを追加していきます。
今回はもとからいるqsadmin1に加え、今回アプリ側で利用するtest1@example.comユーザーを追加します。
bi_sample_dashboard_permission.csv
UserName,role
qsadmin1,"user,admin"
test1@example.com,user
無事表示されましたね！
まとめ
匿名ユーザーを利用するか登録済みユーザーを利用するかはダッシュボードの組み込み要件で決定する
あらかじめグループを作成し、ダッシュボードをグループに対して共有する
QuickSightユーザーはダッシュボードURL取得時に確認し、いなかったら登録してダッシュボードを共有したグループに所属させる
↧