Amazon DataZone を使用してエンタープライズデータメッシュを構築する AWS CDKAWS CloudFormation

リポジトリのクローン作成

リポジトリのクローンを作成するには、ローカル開発環境 (Linux または macOS) で次のコマンドを実行します。

git clone https://github.com/aws-samples/data-mesh-datazone-cdk-cloudformation

環境の作成

Python 仮想環境を作成するには、次のコマンドを実行します。

 python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt

アカウントをブートストラップする

を使用して中央ガバナンスアカウントをブートストラップするには AWS CDK、次のコマンドを実行します。

cdk bootstrap aws://<GOVERNANCE_ACCOUNT_ID>/<AWS_REGION>

にサインインし AWS マネジメントコンソール、中央ガバナンスアカウントコンソールを開き、 AWS CDK 実行ロールの Amazon リソースネーム (ARN) を取得します。

DzDataMeshMemberStackSet.yaml ファイルのコンストラクト

DzDataMeshMemberStackSet.yaml ファイルをコンストラクトするには、リポジトリのルートディレクトリから次の bash スクリプトを開始します。

./lib/scripts/create_dz_data_mesh_member_stack_set.sh

テンプレートの作成を確認

CloudFormation テンプレートファイルが のlib/cfn-templates/DzDataMeshMemberStackSet.yaml場所に作成されていることを確認します。

設定ファイルの変更

config/Config.ts ファイルで、次のパラメータを変更します。

DZ_APPLICATION_NAME - Name of the application.
DZ_STAGE_NAME - Name of the stage. 
DZ_DOMAIN_NAME - Name of the Amazon DataZone domain
DZ_DOMAIN_DESCRIPTION - Description of the Amazon DataZone domain
DZ_DOMAIN_TAG - Tag of the Amazon DataZone domain
DZ_ADMIN_PROJECT_NAME - Name of the Amazon DataZone project for administrators
DZ_ADMIN_PROJECT_DESCRIPTION - Description of the Amazon DataZone project for administrators
CDK_EXEC_ROLE_ARN - ARN of the cdk execution role
DZ_ADMIN_ROLE_ARN - ARN of the administrator role

残りのパラメータは空のままにします。

Amazon DataZone 用語集の設定を更新

lib/utils/glossary_config.json ファイルで Amazon DataZone 用語集の設定を更新するには、次の設定例を使用します。

{
    "GlossaryName": "PII Data",
    "GlossaryDescription": "If data source contains PII attributes",
    "GlossaryTerms": [{
            "Name": "Yes",
            "ShortDescription": "Yes",
            "LongDescription": "Yes Glossary Term"
        },
        {
            "Name": "No",
            "ShortDescription": "No",
            "LongDescription": "No Glossary Term"
        }
    ]
}

Amazon DataZone メタデータフォームの設定を更新

lib/utils/metadata_form_config.json file で Amazon DataZone メタデータフォームの設定を更新するには、次の設定例を使用します。

{
    "FormName": "ScheduleDataRefresh",
    "FormDescription": "Form for data refresh schedule",
    "FormSmithyModel": "@amazon.datazone#displayname(defaultName: \"Data Refresh Schedule\")\nstructure ScheduleDataRefresh {\n    @documentation(\"Schedule of Data Refresh\")\n    @required\n    @amazon.datazone#searchable\n    @amazon.datazone#displayname(defaultName: \"Data Refresh Schedule\")\n    data_refresh_schedule: String\n}"
}

AWS 認証情報をエクスポートします。

管理者権限を持つ IAM ロールの開発環境に AWS 認証情報をエクスポートするには、次の形式を使用します。

export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
export AWS_SESSION_TOKEN=

テンプレートの合成

CloudFormation テンプレートを合成するには、次のコマンドを実行します。

npx cdk synth

ソリューションのデプロイ

ソリューションをデプロイするには、次のコマンドを実行します。

npx cdk deploy --all

テンプレートのデプロイ

次の入力パラメータを使用して、メンバーアカウントの lib/cfn-templates/DzDataMeshCfnStackSetExecutionRole.yaml にある CloudFormation テンプレートをデプロイします。

ARN の更新

メンバーアカウントの CloudFormation StackSet 実行ロール ARNs のリストを更新するには、次のコードを使用します。

DZ_MEMBER_STACK_SET_EXEC_ROLE_LIST  - List of Stack set execution role arns for the member accounts.

合成とデプロイ

CloudFormation テンプレートを合成してソリューションをデプロイするには、次のコマンドを実行します。

npx cdk synth
npx cdk deploy --all

メンバーアカウントの関連付け

メンバーアカウントを中央ガバナンスアカウントに関連付けるには、次の手順を実行します。

パラメータの更新

config/Config.ts の設定ファイルでメンバーアカウント固有のパラメータを更新するには、次の形式を使用します。

export const DZ_MEMBER_ACCOUNT_CONFIG: memberAccountConfig = {
  '123456789012' : {
    PROJECT_NAME: 'TEST-PROJECT-123456789012',
    PROJECT_DESCRIPTION: 'TEST-PROJECT-123456789012',
    PROJECT_EMAIL: 'user@xyz.com'
  }
}

テンプレートを合成してデプロイ

CloudFormation テンプレートを合成してソリューションをデプロイするには、次のコマンドを実行します。

npx cdk synth
npx cdk deploy --all

メンバーアカウントの追加

データソリューションで追加のメンバーアカウントを作成して設定するには、これまでの手順をメンバーアカウントごとに繰り返します。

このソリューションでは、データプロデューサーとコンシューマーは区別されません。

メンバーアカウントの関連付けを解除

アカウントの関連付けを解除するには、次の手順を実行します。

スタックインスタンスの削除

CloudFormation スタックインスタンスを削除するには、次の手順を実行します。

すべてのリソースを破棄

リソースを破棄するには、ローカル開発環境 (Linux または macOS) で次の手順を実行します。