アカウントの拡張機能の構成データを編集する

このトピックでは、特定のリージョン内のアカウントで拡張機能の構成データを編集するためのガイダンスを提供します。拡張機能には、特定のアカウントとリージョンの拡張のすべてのインスタンスに適用される設定プロパティを含めることができます。これらは、拡張機能の作成者が拡張機能の設定定義で定義します。拡張の構成定義に必要なプロパティがある場合、アカウントとリージョンで拡張を使用する前に、それらのプロパティを指定する必要があります。

拡張機能の開発時に設定定義を定義する方法の詳細については、以下のドキュメントを参照してください。

• フック設定スキーマ構文リファレンス

• 拡張のアカウントレベルの構成を定義する

動的リファレンスを使用するために必要なアクセス許可

構成データに、AWS Systems Manager または AWS Secrets Manager に格納されている値への動的参照が含まれている場合では、タイプをプロビジョニングするために使用されるロール (スタックの作成や更新など) には、その値を取得するための適切なアクセス許可が必要です。具体的には次のとおりです。

• 構成データに AWS Systems Manager Parameter Store に格納されたパラメータが含まれている場合、タイプをプロビジョニングするために使用されるユーザーまたはロールには、GetParameter を呼び出すためのアクセス許可が必要です。

• 構成データに AWS Secrets Manager に格納されたシークレットが含まれている場合、タイプをプロビジョニングするために使用されるユーザーまたはロールには、GetSecretValue を呼び出すための許可が必要です。

詳細については、「動的参照を使用して他のサービスに格納されている値を取得する」を参照してください。

拡張機能の構成データを編集する (コンソール)

このセクションの手順に従い、コンソールを使用して次の操作を実行します。

• 拡張機能の現在の構成データを表示する

• アカウントの拡張機能構成データを更新する

拡張機能の現在の構成データを表示するには

1. AWS Management Console にサインインし、AWS CloudFormation コンソール (https://console.aws.amazon.com/cloudformation) を開きます。

2. 画面上部にあるナビゲーションバーで、AWS リージョン を選択します。

3. 表示する拡張機能を見つけます。詳細については、「CloudFormation レジストリで使用可能でアクティブ化された拡張を表示する」を参照してください。

4. 拡張を選択して、拡張の詳細を表示します。

5. [extension details] (拡張の詳細) ページで、[Configuration] (構成) タブを選択します。

6. [Configuration schema] (構成スキーマ) タブを展開して、拡張に定義されている構成スキーマを確認します。

7. [Configuration] (構成) タブを展開して、この拡張に設定した現在の構成を確認します。

拡張機能の構成データを更新するには

1. 拡張の詳細ページで、[Configuration (構成)] タブから [Edit configuration (構成を編集する)] を選択します。

   または、[アクション] から、[編集] を選択し、次に [Edit configuration (構成を編集する)] を選択します。

   CloudFormation は、[Configure extension] (拡張の設定) ページを表示します。拡張の現在の構成定義スキーマを確認するには、[View configuration schema] (構成のスキーマの表示) がオンになっていることを確認してください。

2. [Configuration JSON] (構成 JSON) テキストボックスに、この拡張に設定する構成スキーマを表す JSON 文字列を入力します。[Configuration schema] (構成スキーマ) で定義されたスキーマに対して検証する必要があります

3. [Configure extension (拡張の設定)] を選択します。

拡張機能の構成データを編集する (AWS CLI)

このセクションの手順に従い、AWS CLI を使用して次の操作を実行します。

• 拡張機能の現在の構成データを表示する

• アカウントの拡張機能構成データを更新する

拡張機能の現在の構成データを表示するには

• describe-type コマンドを使用して、拡張機能の詳細情報を返します。出力の ConfigurationSchema 要素には、指定されたリージョンの拡張の現在の構成定義が含まれます。

  または、batch-describe-type-configurations コマンドを使用して、複数の拡張に関する構成データを返します。

拡張機能の構成データを更新するには

• set-type-configuration コマンドを使用して、構成データを指定します。--configuration に渡す JSON は、拡張の構成定スキーマに対して検証する必要があります。

  次の例では、set-type-configuration コマンドは --configuration オプションに対し構成データ "{"CredentialKey": "testUserCredential"}" を指定します。

  aws cloudformation set-type-configuration --type RESOURCE \
    --type-name My::Resource::Example \
    --configuration-alias default \
    --configuration "{"CredentialKey": "testUserCredential"}" \
    --region us-west-2