これは AWS CDK v2 開発者ガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

AWS CDK ライブラリの使用状況データのレポート作成を設定する

CDK ライブラリの使用状況データのレポート作成とは

AWS Cloud Development Kit (AWS CDK) アプリケーションは、AWS CDK がどのように使用されているかのインサイトを取得するために、使用状況データを収集してレポートするように設定されています。CDK チームは、このデータを使用して以下を実行します。

収集される使用状況データとは

CDK によって収集されるアプリケーション使用状況データには、2 つのカテゴリがあります。

一般的な使用状況データの収集

CDK は、CDK アプリケーションから次のタイプの一般的な使用状況データを収集します。

追加の使用状況データの収集

CDK バージョン 2.178.0 以降、次の追加の使用状況データを含めるように、使用状況データの収集が拡張されました。

一意に作成するプロパティキーと値の場合、オブジェクト全体が改正されます。例えば、 InlineApiDefinition を使用して OpenAPI 仕様を定義し、 RestApi コンストラクトに渡すと、InlineApiDefinition オブジェクト全体が改正されます。

利点や潜在的な懸念など、追加の使用状況データ収集の詳細については、「aws-cdk リポジトリ」の「CDK 追加のメタデータの収集 (機能フラグの下) #33198」の説明を参照してください。

CDK がアプリケーション使用状況データを収集する方法

合成時に、CDK はアプリケーションから使用状況データを収集し、 AWS::CDK::Metadata リソース内に保存します。以下は、合成された AWS CloudFormation テンプレートでのこの例です。

CDKMetadata:
  Type: "AWS::CDK::Metadata"
  Properties:
    Analytics: "v2:deflate64:H4sIAND9SGAAAzXKSw5AMBAA0L1b2PdzBYnEAdio3RglglY60zQi7u6TWL/XKmNUlxeQSOKwaPTBqrNhwEWU3hGHiCzK0dWWfAxoL/Fd8mvk+QkS/0X6BdjnCdgmOOQKWz+AqqLDt2Y3YMnLYWwAAAA="

Analytics プロパティは、スタック内のコンストラクトのリストを gzip圧縮し、base64 エンコードして、プレフィックスエンコードしたものです。

使用状況データのレポート作成をオプトアウトまたはオプトインする方法

一般的な使用状況データのレポート作成および追加の使用状況データのレポート作成をオプトアウトまたはオプトインするオプションは、最初にアプリを作成するために使用した CDK バージョンによって異なります。

デフォルトでは、CDK アプリケーションは次のように使用状況データのレポート作成に自動的にオプトインするように設定されています。

すべての使用状況データのレポート作成からオプトアウトする

すべての使用状況データのレポート作成からオプトアウトするには、AWS Cloud Development Kit (AWS CDK) コマンドラインインターフェイス (CLI) を使用するか、プロジェクトの cdk.json ファイルを設定します。

追加の使用状況データのレポート作成のみからオプトアウトする

CDK アプリが 2.178.0 より前の CDK バージョンで作成された場合、一般的な使用状況データのレポート作成にオプトインされていても、追加の使用状況データのレポート作成から自動的にオプトアウトされます。追加の使用状況データのレポート作成からオプトアウトするには何もする必要はありません。

CDK アプリが CDK バージョン 2.178.0 以降で作成された場合は、すべての使用状況データのレポート作成からオプトアウトする必要があります。追加の使用状況データのレポート作成のみからオプトアウトすることはできません。

使用状況データのレポート作成にオプトインする

CDK アプリが CDK バージョン 2.178.0 以降で作成された場合は、versionReporting を true に設定することで、すべての使用状況データのレポート作成にオプトインできます。これが CDK アプリのデフォルトの動作です。

CDK アプリが 2.178.0 より前の CDK バージョンで作成された場合は、versionReporting を true に設定して一般的な使用状況データのレポート作成にオプトインできます。追加の使用状況データのレポート作成にオプトインするには、機能フラグを有効にする必要があります。

例

CDK アプリケーションから収集された一般的および追加の使用状況データ

次は、CDK アプリの例です。

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

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Create an S3 bucket (L2 construct)
    const myBucket = new s3.Bucket(this, 'MyBucket', {
      bucketName: 'my-cdk-example-bucket', // String type
      versioned: true,                    // Boolean type
      removalPolicy: cdk.RemovalPolicy.DESTROY, // ENUM type
      lifecycleRules: [{                  // Array of object type
        expirationDate: new Date('2019-10-01'),
        objectSizeLessThan: 600,
        objectSizeGreaterThan: 500,
      }],
    });

    // Use a method of the L2 construct to define additional properties
    myBucket.addLifecycleRule({
      id: 'ExpireOldObjects',
      enabled: true, // Boolean
      expiration: cdk.Duration.days(90), // Expire objects after 90 days
    });
  }
}

// Define the CDK app and stack
const app = new cdk.App();
new MyStack(app, 'MyStack');
app.synth();

合成時に、使用状況データが収集、圧縮され、 AWS::CDK::Metadata リソースに保存されます。

2.178.0 より前の CDK バージョンで収集された一般的な使用状況データの例を次に示します。

{
    "fqn": "aws-cdk-lib.aws-s3.Bucket",
    "version": "v2.170.0"
}

CDK バージョン 2.178.0 で導入された追加の使用状況データを含む、収集された使用状況データの例を次に示します。

{
    "fqn": "aws-cdk-lib.aws_s3.Bucket",
    "version": "2.170.0",
    "metadata": [
        {
            "type": "aws:cdk:analytics:construct",
            "data": {
                "bucketName": "*",
                "versioned": true,
                "removalPolicy": "cdk.RemovalPolicy.DESTROY",
                "lifecycleRules": [
                    {
                        "expirationDate": "*",
                        "objectSizeLessThan": "*",
                        "objectSizeGreaterThan": "*"
                    }
                ]
            }
        },
        {
            "type": "aws:cdk:analytics:method",
            "data": {
                "name": "addLifecycleRule",
                "prop": {
                    "id": "*",
                    "enabled": true,
                    "expiration": "*",
                }
            }
        }
    ]
}