Amazon Cognito リソースのタグ付け - Amazon Cognito
サポートされるリソースタグの制限コンソールを使用したタグの管理AWS CLI の例API アクション

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

Amazon Cognito リソースのタグ付け

タグは、ユーザーまたはAWSがAWSリソースに割り当てるメタデータラベルです。各タグは、キーと値から構成されます。ユーザーが割り当てるタグでは、ユーザーがキーと値を定義します。たとえば、1 つのリソースのキーを stage と定義し、値を test と定義します。

タグは、以下のことに役立ちます。

  • AWS リソースを識別および整理します。多くの AWS のサービスではタグ付けがサポートされるため、さまざまなサービスからリソースに同じタグを割り当てることができます。タグは、どのリソースが関連しているかを示すのに役立ちます。例えば、Amazon DynamoDB テーブルに割り当てるタグと同じものを Amazon Cognito ユーザープールに割り当てることができます。

  • AWS のコストを追跡します。これらのタグは、AWS Billing and Cost Management ダッシュボードで有効にできます。AWS では、コスト配分タグを使用してコストを分類し、毎月のコスト配分レポートを提供します。詳細については、AWS Billing ユーザーガイドの「コスト配分タグの使用」を参照してください。

  • リソースに割り当てられたタグに基づいて、リソースへのアクセスをコントロールします。AWS Identity and Access Management (IAM) ポリシーの条件でキーと値を指定することによってアクセスをコントロールできます。例えば、ユーザープールの更新をユーザーに許可しても、そのユーザープールに owner タグと、そのユーザーの名前の値がある場合のみに限定することができます。詳細については、IAM ユーザーガイドの「タグを使用したアクセス制御」を参照してください。

AWS Command Line Interface または Amazon Cognito API を使用して、ユーザーと ID プールの両方のタグの追加、編集、または削除を行うことができます。Amazon Cognito コンソールを使用して、ユーザープールのタグを管理することもできます。

タグの使用方法のヒントについては、AWS の回答ブログのAWS タグ付け戦略記事を参照してください。

以下のセクションでは、Amazon Cognito のタグに関する詳細が説明されています。

Amazon Cognito でサポートされるリソース

Amazon Cognito の以下のリソースがタグ付けをサポートしています。

  • ユーザープール

  • ID プール

タグの制限

Amazon Cognito リソースのタグには、以下の制限が適用されます。

  • リソースに割り当てることができるタグの最大数: 50

  • キーの最大長 – 128 文字 (Unicode)

  • 値の最大長 – 256 文字 (Unicode)

  • キーと値の有効な文字 – a～z、A～Z、0～9、スペース、および特殊文字 (_ . : / = + - @)

  • キーと値は大文字と小文字が区別されます

  • aws: をキーのプレフィックスとして使用しないでください。AWS 用に予約済みです。

Amazon Cognito コンソールを使用したタグの管理

Amazon Cognito コンソールを使用して、ユーザープールに割り当てられたタグを管理することができます。

ユーザープールにタグを追加するには

  1. [Amazon Cognito console] (Amazon Connect コンソール) に移動します。プロンプトが表示されたら、AWS 認証情報を入力します。

  2. [User Pools] (ユーザープール) を選択します。

  3. リストから既存のユーザープールを選択するか、ユーザープールを作成します。

  4. [User pool properties] (ユーザープールのプロパティ) タブを選択し、Tags (タグ) を探します。

  5. [Add tags] (タグを追加する) を選択し、最初のタグを追加します。以前このユーザープールにタグを割り当てたことがある場合は、[Manage tags] (タグの管理) を選び、[Add another] (別のタグを追加) を選択します。

  6. [Tag Key] (タグキー) と [Tag Value]] (タグ値) に値を入力します。

  7. 追加するタグごとに、[Add another tag] (別のタグを追加) を選択します。

  8. タグの追加を完了したら、[Save changes] (変更の保存) を選択します。

[Manage tags] (タグの管理) ページで、既存のタグのキーと値を編集することもできます。タグを削除するには、[Remove] (削除) を選択します。

AWS CLI の例

AWS CLI は、Amazon Cognito ユーザープールと ID プールに割り当てるタグの管理に役立つコマンドを提供します。

タグの割り当て

次のコマンドを使用して、既存のユーザープールと ID プールにタグを割り当てます。

例 tag-resource ユーザープール向けのコマンド

コマンドの cognito-idp セット内の tag-resource 使用して、ユーザープールにタグを割り当てます。

$ aws cognito-idp tag-resource \
> --resource-arn user-pool-arn \
> --tags Stage=Test

このコマンドには次のパラメータが含まれます。

  • resource-arn – タグを割り当てるユーザープールの Amazon リソースネーム (ARN)。ARN を調べるには、Amazon Cognito コンソールでユーザープールを選択し、[General settings] (一般設定) タブの [Pool ARN] (プール ARN) 値を表示します。

  • tags — 形式key=valueのタグのキーバリューペアです。

一度に複数のタグを割り当てるには、カンマ区切りリストで指定します。

$ aws cognito-idp tag-resource \
> --resource-arn user-pool-arn \
> --tags Stage=Test,CostCenter=80432,Owner=SysEng
例 tag-resource ID プール向けのコマンド

コマンドの cognito-identity セット内の tag-resource 使用して、ID プールにタグを割り当てます。

$ aws cognito-identity tag-resource \
> --resource-arn identity-pool-arn \
> --tags Stage=Test

このコマンドには次のパラメータが含まれます。

  • resource-arn – タグを割り当てる ID プールの Amazon リソースネーム (ARN)。ARN を調べるには、Amazon Cognito コンソールで ID プールを選択し、[Edit identity pool] (ID プールの編集) をクリックします。その後、[Identity pool ID] (ID プールの ID) で [Show ARN] (ARN の表示) をクリックします。

  • tags — 形式key=valueのタグのキーバリューペアです。

一度に複数のタグを割り当てるには、カンマ区切りリストで指定します。

$ aws cognito-identity tag-resource \
> --resource-arn identity-pool-arn \
> --tags Stage=Test,CostCenter=80432,Owner=SysEng

タグの表示

次のコマンドを使用して、ユーザープールと ID プールに割り当てたタグを表示します。

例 list-tags-for-resource ユーザープール向けのコマンド

コマンドの cognito-idp セット内の list-tags-for-resource 使用して、ユーザープールにタグを割り当てます。

$ aws cognito-idp list-tags-for-resource --resource-arn user-pool-arn
例 list-tags-for-resource ID プール向けのコマンド

コマンドの cognito-identity セット内の list-tags-for-resource 使用して、ID プールにタグを割り当てます。

$ aws cognito-identity list-tags-for-resource --resource-arn identity-pool-arn

タグの削除

以下のコマンドを使用して、ユーザープールと ID プールからタグを削除します。

例 untag-resource ユーザープール向けのコマンド

コマンドの cognito-idp セット内の untag-resource 使用して、ユーザープールにタグを割り当てます。

$ aws cognito-idp untag-resource \
> --resource-arn user-pool-arn \
> --tag-keys Stage CostCenter Owner

--tag-keysパラメータには、1 つ以上のタグキーを指定します。タグ値は含みません。キーをスペースで区切ります。

例 untag-resource ID プール向けのコマンド

コマンドの cognito-identity セット内の untag-resource 使用して、ID プールにタグを割り当てます。

$ aws cognito-identity untag-resource \
> --resource-arn identity-pool-arn \
> --tag-keys Stage CostCenter Owner

--tag-keysパラメータには、1 つ以上のタグキーを指定します。タグ値は含みません。

重要

ユーザーまたは ID プールの削除後、削除されたプールに関連するタグは、削除から最大 30 日までコンソールまたは API コールに表示できます。

リソース作成時のタグの適用

次のコマンドを使用して、ユーザープールまたは ID プールを作成するときにタグを割り当てます。

例 create-user-poolコマンドとタグ

create-user-pool コマンドを使用してユーザープールを作成するときは、--user-pool-tags パラメータと共にタグを指定できます。

$ aws cognito-idp create-user-pool \
> --pool-name user-pool-name \
> --user-pool-tags Stage=Test,CostCenter=80432,Owner=SysEng

タグのキーバリューペアは、key=value形式が必須です。複数のタグを追加する場合は、カンマで区切りを付けたリストで指定します。

例 create-identity-pool コマンドとタグ

create-identity-pool コマンドを使用して ID プールを作成するときは、--identity-pool-tags パラメータと共にタグを指定できます。

$ aws cognito-identity create-identity-pool \
> --identity-pool-name identity-pool-name \
> --allow-unauthenticated-identities \
> --identity-pool-tags Stage=Test,CostCenter=80432,Owner=SysEng

タグのキーバリューペアは、key=value形式が必須です。複数のタグを追加する場合は、カンマで区切りを付けたリストで指定します。

Amazon Cognito API を使用したタグの管理

以下のアクションを Amazon Cognito API で使用することで、ユーザープールと ID プールのタグを管理できます。

ユーザープールタグの API アクション

次の API アクションを使用して、ユーザープールのタグを割り当て、表示、削除します。

ID プールタグの API アクション

次の API アクションを使用して、ID プールのタグを割り当て、表示、削除します。