AWS CDK 使用状況データレポートを設定する

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

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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 Collecting Additional Metadata (under feature flag) #33198 discussion」を参照してください。

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 アプリケーションは次のように使用状況データレポートに自動的にオプトインするように設定されています。

すべての使用状況データレポートをオプトアウトする

すべての使用状況データレポートをオプトアウトするには、 コマンドラインインターフェイス (CLI) AWS Cloud Development Kit (AWS CDK) を使用するか、プロジェクトの 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": "*",
                } 
            } 
        } 
    ] 
}