0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

QuickSightのテンプレートからダッシュボードを作成し、CDKで管理するまでの手順を整理した

0
Posted at

背景・目的

前回、Redshift ServerlessのデータをQuickSightのSPICEにインポートし、ビジュアル作成・データ更新の反映までを一通り試しました。
その中で、QuickSightのリソース(データソース・データセット・ビジュアル)はCLIやコンソールで個別に作成しましたが、本番運用を考えると「同じ帳票レイアウトを別の環境やデータセットに展開したい」というニーズが出てきそうです。

QuickSightにはテンプレート機能があり、分析のビジュアル定義をスナップショットとして保存し、データセットを差し替えて再利用できます。今回は、前回作成した分析をテンプレート化し、同一アカウント内でダッシュボードとして展開するまでの手順を試します。

まとめ

下記に特徴をまとめます

特徴 説明
リソースの依存関係 データソース → データセット → 分析 → テンプレート → ダッシュボード
テンプレートの役割 分析のスナップショット。DataSetPlaceholderでデータセットを抽象化し、差し替え可能
バージョン管理 テンプレート・ダッシュボードともにバージョンを持つ
ダッシュボード公開 update-dashboardだけでは反映されない。update-dashboard-published-versionで明示的に切替が必要
SPICEの更新 スナップショット方式。Redshift更新後はcreate-ingestionで明示的に更新が必要
IaC対応 テンプレート・ダッシュボードはCDK(CloudFormation)で作成可能。データソース・データセットはCLIのみ
分析の位置づけ 編集モード。ビジュアルの追加・変更・削除ができる唯一のリソース
ダッシュボードの機能 閲覧専用だが、フィルタ・CSVエクスポート・PDF生成が可能

概要

QuickSightのリソース階層

リソース 役割 作成手段
データソース DB接続定義 CLI
データセット テーブル/SQL定義 + SPICE/直接クエリ CLI
分析(Analysis) 編集モード。ビジュアルの追加・変更・削除 コンソール
テンプレート(Template) 分析のスナップショット。データセットをプレースホルダーで抽象化 CDK / CLI
ダッシュボード(Dashboard) 閲覧モード。フィルタ・CSV・PDFが可能 CDK / CLI

依存関係は下記のとおり

  1. データソース
    ↓
  2. データセット
    ↓
  3. 分析
    ↓
  4. テンプレート
    ↓
  5. ダッシュボード

データソースとは

QuickSightがデータを取得する接続先の定義。接続タイプ(Redshift、S3、RDS等)、エンドポイント、認証情報(Secrets Manager ARN)、VPC接続の設定を持つ。

データセットとは

データソースから取得するテーブルやSQLクエリの定義。インポートモード(SPICE or 直接クエリ)の指定もここで行う。分析やダッシュボードが参照するデータの実体。

SPICEモードの場合、データはQuickSight側にキャッシュされる。Redshift側のデータ更新後は create-ingestion でSPICEを明示的に更新する必要がある。

分析

QuickSightの編集モード。データセットを元にグラフの追加・変更・削除、計算フィールドの定義、フィルタの設定ができる。テンプレートやダッシュボードのソースになる。

テンプレートとは

コンソールでビジュアル作成(分析) → テンプレート化 → ダッシュボードとして展開

分析のビジュアル定義(グラフの種類・レイアウト・計算フィールド等)をスナップショットとして保存したもの。データセットはプレースホルダー(DataSetPlaceholder)で抽象化されるため、別のデータセットを差し替え
てダッシュボードを作成できる。

バージョン管理があり、update-template で新バージョンが作られる。

ダッシュボード

QuickSightの閲覧モード。テンプレート+データセットの組み合わせから作成される。ビジュアルの編集はできないが、フィルタによる絞り込み、CSVエクスポート、PDF生成が可能。

実践

CDKで帳票テンプレートを作成する

前回、CDKで一部リソースを作りました。同様に、新たにテンプレートを作ります

テンプレートの作成

1.テンプレートを作成します

import * as cdk from 'aws-cdk-lib';
import * as quicksight from 'aws-cdk-lib/aws-quicksight';
import { Construct } from 'constructs';

export class QsTemplateStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const analysisId = this.node.getContext('analysisId');
    const dataSetId = this.node.getContext('dataSetId');

    const analysisArn = `arn:aws:quicksight:${this.region}:${this.account}:analysis/${analysisId}`;
    const dataSetArn = `arn:aws:quicksight:${this.region}:${this.account}:dataset/${dataSetId}`;

    new quicksight.CfnTemplate(this, 'QsTemplate', {
      awsAccountId: this.account,
      templateId: 'monthly-sales-template',
      name: 'Monthly Sales Template',
      sourceEntity: {
        sourceAnalysis: {
          arn: analysisArn,
          dataSetReferences: [
            {
              dataSetPlaceholder: 'sales-data',
              dataSetArn,
            },
          ],
        },
      },
    });
  }
}

テスト

1.テストコードを書きます

2.下記のコマンドでテストを実行します

npx jest test/qs-template-stack.test.ts

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        6.268 s
Ran all test suites matching test/qs-template-stack.test.ts.

デプロイ

  1. synthを実行します
npx cdk synth QsTemplateStack -c vpcId=vpc-XXXXXXXX -c XXXXXXXX -c analysisId=XXXXXXXX -c dataSetId=monthly-sales-summary

2.デプロイします。成功しました

CDK_DEFAULT_ACCOUNT=XXXXXXX CDK_DEFAULT_REGION=ap-northeast-1 \
  npx cdk deploy QsTemplateStack \
    -c vpcId=vpc-XXXXXX \
    -c redshiftSgId=sg-XXXXXX \
    -c analysisId=faadcdab-XXXXXX \
    -c dataSetId=monthly-sales-summary \
    --require-approval never

==
 ✅  QsTemplateStack

✨  Deployment time: 77.72s

3.テンプレートを確認します

aws quicksight list-templates --aws-account-id XXXXX --region ap-northeast-1 --output json
{
  "TemplateSummaryList": [
    {
      "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXXX:template/monthly-sales-template",
      "TemplateId": "monthly-sales-template",
      "Name": "Monthly Sales Template",
      "LatestVersionNumber": 1,
      "CreatedTime": "2026-04-17T09:38:30.526000+09:00",
      "LastUpdatedTime": "2026-04-17T09:38:30.526000+09:00"
    }
  ]
}

{
  "Template": {
    "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXXXX:template/monthly-sales-template",
    "Name": "Monthly Sales Template",
    "TemplateId": "monthly-sales-template",
    "CreatedTime": "2026-04-17T09:38:30.526000+09:00",
    "LastUpdatedTime": "2026-04-17T09:38:30.526000+09:00",
    "Version": {
      "VersionNumber": 1,
      "Status": "CREATION_SUCCESSFUL",
      "SourceEntityArn": "arn:aws:quicksight:ap-northeast-1:XXXXXXX:analysis/faadcdab-XXXXXXX",
      "ThemeArn": "arn:aws:quicksight::aws:theme/NITRO",
      "DataSetConfigurations": [
        {
          "Placeholder": "sales-data",
          "DataSetSchema": {
            "ColumnSchemaList": [
              { "Name": "sales_month", "DataType": "INTEGER" },
              { "Name": "category", "DataType": "STRING" },
              { "Name": "revenue", "DataType": "DECIMAL" }
            ]
          }
        }
      ],
      "Sheets": [
        {
          "SheetId": "XXXXXXX",
          "Name": "シート 1"
        }
      ]
    }
  }
}

テンプレートからダッシュボードを作成(CLI)

CLIで作成

  1. テンプレートからダッシュボードを作成します
aws quicksight create-dashboard \
  --aws-account-id XXXXX \
  --dashboard-id monthly-sales-dashboard \
  --name "Monthly Sales Dashboard" \
  --source-entity '{
    "SourceTemplate": {
      "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXX:template/monthly-sales-template",
      "DataSetReferences": [
        {
          "DataSetPlaceholder": "sales-data",
          "DataSetArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dataset/monthly-sales-summary"
        }
      ]
    }
  }' \
  --permissions '[{
    "Principal": "arn:aws:quicksight:ap-northeast-1:XXXXX:user/default/admin/XXXXXXXX",
    "Actions": [
      "quicksight:DescribeDashboard",
      "quicksight:ListDashboardVersions",
      "quicksight:UpdateDashboardPermissions",
      "quicksight:QueryDashboard",
      "quicksight:UpdateDashboard",
      "quicksight:DeleteDashboard",
      "quicksight:UpdateDashboardPublishedVersion",
      "quicksight:DescribeDashboardPermissions"
    ]
  }]' \
  --region ap-northeast-1 \
  --output json

---

{
  "Status": 202,
  "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dashboard/monthly-sales-dashboard",
  "VersionArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dashboard/monthly-sales-dashboard/version/1",
  "DashboardId": "monthly-sales-dashboard",
  "CreationStatus": "CREATION_IN_PROGRESS"
}

2.結果を確認します

aws quicksight describe-dashboard \
   --aws-account-id XXXXXXXXX \
   --dashboard-id monthly-sales-dashboard \
   --region ap-northeast-1 \
   --output json

---
{
  "Dashboard": {
    "DashboardId": "monthly-sales-dashboard",
    "Name": "Monthly Sales Dashboard",
    "CreatedTime": "2026-04-17T09:47:59.386000+09:00",
    "LastPublishedTime": "2026-04-17T09:47:59.386000+09:00",
    "Version": {
      "VersionNumber": 1,
      "Status": "CREATION_SUCCESSFUL",
      "Errors": [],
      "SourceEntityArn": "arn:aws:quicksight:ap-northeast-1:XXXXXX:template/monthly-sales-template/version/1",
      "DataSetArns": [
        "arn:aws:quicksight:ap-northeast-1:XXXXXX:dataset/monthly-sales-summary"
      ],
      "ThemeArn": "arn:aws:quicksight::aws:theme/NITRO",
      "Sheets": [
        {
          "SheetId": "XXXXXX",
          "Name": "シート 1"
        }
      ]
    }
  }
}

QuickSightから確認

  1. QuickSightにアクセスします
  2. ナビゲーションペインでダッシュボードをクリックします
  3. 表示されました。クリックします
    image.png
  4. 見えました

image.png

ダッシュボードの操作

フィルターの追加

  1. 画面右上のフィルターを選択
  2. フィルターを追加をクリックします
    image.png
  3. categoryを追加します
  4. Electronicsを選択し、「適用」をクリックします
    image.png
  5. 絞り込まれました
    image.png

CSVエクスポート

  1. CSVへエクスポートを選択します
    image.png
  2. 確認します。Electronicsに絞り込まれて出力されました
% cat ~/XXXX/Category_and_Sales_m_1776389026750.csv     
"category","sales_month","revenue (SUM)"
"Electronics",202604,18888887
"Electronics",202603,3525000
"Electronics",202602,3300000
"Electronics",202601,3075000
% 

PDF作成

  1. PDFを生成をクリックします
    image.png

  2. ダウンロードをクリックします

  3. 確認します。見えました
    image.png

分析を編集 → テンプレートを更新 → ダッシュボードの更新を試す

分析でビジュアルを変更した後、ダッシュボードに反映するには3ステップ必要です。

  1. update-template — 分析の最新状態をテンプレートに取り込む
  2. update-dashboard — テンプレートからダッシュボードの新バージョンを作成
  3. update-dashboard-published-version — 公開バージョンを切り替える

分析の最新状態をテンプレートに取り込む

  1. QuickSightの分析をクリックします

  2. Monthly Sales Summary analysisを開きます

  3. 表示されました
    image.png

  4. 棒グラフからドーナツグラフに変更しました
    image.png

テンプレートからダッシュボードの新バージョンを作成

テンプレートを更新する

1.下記のコマンドでテンプレートに反映します。(Version2にしています)

aws quicksight update-template \
  --aws-account-id XXXXX \
  --template-id monthly-sales-template \
  --source-entity '{
    "SourceAnalysis": {
      "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXX:analysis/faadcdab-XXXXX",
      "DataSetReferences": [
        {
          "DataSetPlaceholder": "sales-data",
          "DataSetArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dataset/monthly-sales-summary"
        }
      ]
    }
  }' \
  --region ap-northeast-1 \
  --output json


json
{
  "Status": 202,
  "TemplateId": "monthly-sales-template",
  "VersionArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:template/monthly-sales-template/version/2",
  "CreationStatus": "CREATION_IN_PROGRESS"
}

ダッシュボードを更新する

  1. ダッシュボードを更新します。この時点ではまだ公開されていません
aws quicksight update-dashboard \
  --aws-account-id XXXXX \
  --dashboard-id monthly-sales-dashboard \
  --name "Monthly Sales Dashboard" \
  --source-entity '{
    "SourceTemplate": {
      "Arn": "arn:aws:quicksight:ap-northeast-1:XXXXX:template/monthly-sales-template",
      "DataSetReferences": [
        {
          "DataSetPlaceholder": "sales-data",
          "DataSetArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dataset/monthly-sales-summary"
        }
      ]
    }
  }' \
  --region ap-northeast-1 \
  --output json


json
{
  "Status": 202,
  "DashboardId": "monthly-sales-dashboard",
  "VersionArn": "arn:aws:quicksight:ap-northeast-1:XXXXX:dashboard/monthly-sales-dashboard/version/2",
  "CreationStatus": "CREATION_IN_PROGRESS"
}

公開バージョンを切り替える

  1. update-dashboard だけでは閲覧者に見えるバージョンは変わりません。明示的に公開バージョンを切り替えます
aws quicksight update-dashboard-published-version \
  --aws-account-id XXXXXX \
  --dashboard-id monthly-sales-dashboard \
  --version-number 2 \
  --region ap-northeast-1 \
  --output json

json
{
  "Status": 200,
  "DashboardId": "monthly-sales-dashboard"
}

ダッシュボードの確認

  1. ナビゲーションペインでダッシュボードをクリックします
  2. ドーナツグラフに変わっていました
    image.png

テンプレートからダッシュボードを作成(CDK)

上記では、CLIで実行したのですが、CDKでもやってみます

実装とテスト

1.CDKで作成します

import * as cdk from 'aws-cdk-lib';
import * as quicksight from 'aws-cdk-lib/aws-quicksight';
import { Construct } from 'constructs';

export class QsDashboardStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const templateId = this.node.getContext('templateId');
    const dataSetId = this.node.getContext('dataSetId');
    const qsUserArn = this.node.getContext('qsUserArn');

    const templateArn = `arn:aws:quicksight:${this.region}:${this.account}:template/${templateId}`;
    const dataSetArn = `arn:aws:quicksight:${this.region}:${this.account}:dataset/${dataSetId}`;

    new quicksight.CfnDashboard(this, 'QsDashboard', {
      awsAccountId: this.account,
      dashboardId: 'monthly-sales-dashboard-cdk',
      name: 'Monthly Sales Dashboard (CDK)',
      sourceEntity: {
        sourceTemplate: {
          arn: templateArn,
          dataSetReferences: [
            {
              dataSetPlaceholder: 'sales-data',
              dataSetArn,
            },
          ],
        },
      },
      permissions: [
        {
          principal: qsUserArn,
          actions: [
            'quicksight:DescribeDashboard',
            'quicksight:ListDashboardVersions',
            'quicksight:UpdateDashboardPermissions',
            'quicksight:QueryDashboard',
            'quicksight:UpdateDashboard',
            'quicksight:DeleteDashboard',
            'quicksight:UpdateDashboardPublishedVersion',
            'quicksight:DescribeDashboardPermissions',
          ],
        },
      ],
    });
  }
}

2.テストコードを作成します

import { Template } from 'aws-cdk-lib/assertions';
import * as cdk from 'aws-cdk-lib';
import { QsDashboardStack } from '../lib/qs-dashboard-stack';

const app = new cdk.App({
  context: {
    templateId: 'test-template-id',
    dataSetId: 'test-dataset-id',
    qsUserArn: 'arn:aws:quicksight:ap-northeast-1:123456789012:user/default/admin/test-user',
  },
});
const stack = new QsDashboardStack(app, 'TestStack', {
  env: { account: '123456789012', region: 'ap-northeast-1' },
});
const template = Template.fromStack(stack);

test('QuickSightダッシュボードが作成される', () => {
  template.hasResourceProperties('AWS::QuickSight::Dashboard', {
    DashboardId: 'monthly-sales-dashboard-cdk',
    SourceEntity: {
      SourceTemplate: {
        Arn: 'arn:aws:quicksight:ap-northeast-1:123456789012:template/test-template-id',
        DataSetReferences: [
          {
            DataSetPlaceholder: 'sales-data',
            DataSetArn: 'arn:aws:quicksight:ap-northeast-1:123456789012:dataset/test-dataset-id',
          },
        ],
      },
    },
  });
});

3.テストします

npx jest test/qs-dashboard-stack.test.ts 

---
Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        6.408 s
Ran all test suites matching test/qs-dashboard-stack.test.ts.

デプロイ

  1. synthを実行します
CDK_DEFAULT_ACCOUNT=XXXXX CDK_DEFAULT_REGION=ap-northeast-1 npx cdk synth QsDashboardStack -c vpcId=vpc-XXXXX -c redshiftSgId=sg-XXXXX -c analysisId=faadcdab-XXXXX -c dataSetId=monthly-sales-summary -c templateId=monthly-sales-template -c qsUserArn=arn:aws:quicksight:ap-northeast-1:XXXXX:user/default/admin/XXXXXXX

2.デプロイします。成功しました

cd /XXXXXX/qs-rehearsal/infra

CDK_DEFAULT_ACCOUNT=XXXXX CDK_DEFAULT_REGION=ap-northeast-1 \
  npx cdk deploy QsDashboardStack \
    -c vpcId=vpc-XXXXX \
    -c redshiftSgId=sg-XXXXX \
    -c analysisId=faadcdab-XXXXX \
    -c dataSetId=monthly-sales-summary \
    -c templateId=monthly-sales-template \
    -c qsUserArn=arn:aws:quicksight:ap-northeast-1:XXXXX:user/XXXXX \
    --require-approval never

✨  Deployment time: 72.61s

確認

  1. 作成されたか確認します
aws quicksight describe-dashboard --aws-account-id XXXXXXX --dashboard-id monthly-sales-dashboard-cdk --region ap-northeast-1 --output json

{
  "Dashboard": {
    "DashboardId": "monthly-sales-dashboard-cdk",
    "Name": "Monthly Sales Dashboard (CDK)",
    "Version": {
      "VersionNumber": 1,
      "Status": "CREATION_SUCCESSFUL",
      "Errors": [],
      "SourceEntityArn": "arn:aws:quicksight:ap-northeast-1:XXXXXX:template/monthly-sales-template/version/2",
      "DataSetArns": [
        "arn:aws:quicksight:ap-northeast-1:XXXXXX:dataset/monthly-sales-summary"
      ],
      "ThemeArn": "arn:aws:quicksight::aws:theme/NITRO",
      "Sheets": [
        {
          "SheetId": "XX",
          "Name": "シート 1"
        }
      ]
    },
    "CreatedTime": "2026-04-17T10:52:19.208000+09:00",
    "LastPublishedTime": "2026-04-17T10:52:19.208000+09:00"
  }
}

2.QuickSightでダッシュボードをクリックします
3. ダッシュボードが増えていました
image.png
4. CDK版をクリックします。想定通り見えました
image.png

考察

今回、QuickSightのテンプレート機能を利用し、前回作成した分析をテンプレート化し、同一アカウント内でダッシュボードとして展開するまでの手順を試しました。
テンプレート自体は、CDKで管理でき比較的簡単に進めることができました。今後は他の機能についても継続して試す予定です。

参考

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?