リソースの特定

すべてのリソースタイプには、プライマリ識別子として定義されるプロパティがあります。このプロパティの値は、特定の AWS アカウント および 内のそのタイプのリソースごとに一意である必要があります AWS リージョン。例えば、多くのリソースタイプには、そのタイプのリソースごとに一意でなければならない Name プロパティがあります。場合によっては、プライマリ識別子は、複数のプロパティの組み合わせ (これらが組み合わさって一意の識別子になる) として定義されます。このプライマリ識別子をリソースタイプと組み合わせて使用することで、update-resource や delete-resource などのリソースオペレーションを実行するリソースを正確に指定できます。

また、リソースタイプの中には、そのタイプのリソースを一意に識別するためにも使用できるセカンダリ識別子を定義するものもあります。

どのリソースプロパティ (またはプロパティの組み合わせ) がリソースタイプのプライマリ識別子であるかを判断するには、リソースタイプスキーマの primaryIdentifier 属性を参照してください。このスキーマには、定義されているセカンダリ識別子も含まれています。詳細については、「リソースタイプのスキーマの表示」を参照してください。

リソースのプライマリ識別子の取得

特定のリソースの識別子の値は、Cloud Control API コマンドを使用して確認できます。以下の各コマンドは、指定されたリソースのプライマリ識別子が含まれる ProgressEvent オブジェクトを返します。

• cancel-resource-request

• create-resource

• get-resource-request-status

• list-resource-requests

リソースのプライマリ識別子の使用

Cloud Control API コマンドを使用する場合、リソーススキーマでリソースタイプに定義されているプライマリ識別子または任意のセカンダリ識別子を指定することができます。識別子は 1 つだけ指定できます。プライマリ識別子は文字列または JSON として指定できます。セカンダリ識別子は JSON として指定する必要があります。

複合プライマリ識別子 (つまり、連結された複数のリソースプロパティで構成されたもの) の場合、プライマリ識別子を文字列として指定するには、プロパティ値を | で区切り、プライマリ識別子の定義で指定されている順序でリストします。

例えば、 リソースのプライマリ識別子は次のように定義されます。

"primaryIdentifier": [ "/properties/DatabaseName", "/properties/TableName" ]

そのため、 リソースのプライマリ識別子を文字列として指定するには、次の形式を使用します。

DatabaseName|TableName

例えば、データベース名が MyDatabase で、テーブル名が MyTable のデータベースであれば、MyDatabase|MyTable と指定します。

JSON として指定された複合識別子の場合は、次の例に示すように、プロパティの順序を考慮する必要はありません。

{
  "TableName": "MyTable",
  "DatabaseName": "MyDatabase"
}

リソース識別子の詳細については、「 コマンドラインインターフェイスのユーザー移動」の「拡張開発」の「プライマリ識別子」を参照してください。 CloudFormation