タグの制限コンソールでのタグの管理 AWS CLI でのタグの管理タグに基づいて X-Ray リソースへのアクセスを制御する

X-Ray のサンプリングルールとグループのタグ付け

タグは、AWS リソースを特定し、整理するのに使用できる単語または語句です。各リソースに複数のタグを追加できます。各タグには、ユーザーが定義するキーとオプションの値が含まれます。たとえば、タグキーは domain、タグ値は example.com などです。追加したタグに基づいて、リソースを検索したりフィルタ処理したりできます。タグの使用方法の詳細については、AWS 一般的なリファレンスの「タグ付け AWS リソース」を参照してください。

タグを使用して、CloudFront ディストリビューションにタグベースのアクセス許可を適用できます。。詳細については、「リソースタグを使用した AWS リソースへのアクセスの制御」を参照してください。

注記

タグエディタおよびAWSリソースグループは現在、X-Ray リソースをサポートしていません。AWS X-Ray コンソールまたは APIを使用して、タグを追加および管理します。

X-Ray コンソール、 API、 AWS CLI、 SDK、および AWS Tools for Windows PowerShell を使用してリソースにタグを適用できます。詳細については、次のドキュメントを参照してください。

X-Ray API — AWS X-RayAPI リファレンスの以下の操作を参照してください。
AWS CLI – AWS CLI コマンドリファレンス の「xray」を参照してください。
SDK – AWS ドキュメントページの該当する SDK ドキュメントを参照

注記

X-Ray リソースでタグを追加または変更できない場合、または特定のタグを持つリソースを追加できない場合は、この操作を実行する権限がない可能性があります。アクセスをリクエストするには、X-Rayの管理者許可を持つエンタープライズ内のAWS ユーザーにお問い合わせください。

タグの制限

タグには次の制限があります。

リソースあたりのタグの最大数 – 50
キーの最大長 – 128 文字 (Unicode)
値の最大長 – 256 文字 (Unicode)
キーと値の有効な値 – a～z、A～Z、0～9、スペース、特殊文字 (_ . : / = + - @)
タグのキーと値は大文字と小文字が区別されます。
aws: をキーのプレフィックスとしてを使用しないでください。AWS 用に予約済みです。

注記

システムタグを編集または削除することはできません。

コンソールでのタグの管理

X-Ray グループまたはサンプリングルールの作成時に、オプションのタグを追加できます。タグは、後でコンソールで変更または削除することもできます。

次の手順では、X-Ray コンソールでグループおよびサンプリングルールのタグを追加、編集、削除する方法について説明します。

トピック

新しいグループにタグを追加する (コンソール)
新しいサンプリングルールにタグを追加する (コンソール)
グループのタグを編集または削除する (コンソール)
サンプリングルールのタグを編集または削除する (コンソール)

新しいグループにタグを追加する (コンソール)

新しい X-Ray グループを作成するときに、オプションのタグをグループの作成ページで追加できます。

AWS Management Console にサインインし、https://console.aws.amazon.com/xray/homeでX-Ray コンソールを開きます。
ナビゲーションペインで、設定を展開し、Groupsを選択します。
[Create group] (グループの作成) を選択します。
グループの作成ページで、グループの名前とフィルタ式を指定します。これらのプロパティの詳細については、「グループの設定」を参照してください。
タグで、タグキー、およびオプションでタグ値を入力します。たとえば、Stageのタグキー、およびProductionのタグ値を入力して、このグループが生産用途であることを示します。タグを追加すると、必要に応じて別のタグを追加するための新しい行が表示されます。タグの制限については、このトピックでタグの制限を参照してください。
タグの追加が完了したら、[Create group (グループの作成)] を選択します。

新しいサンプリングルールにタグを追加する (コンソール)

新しい X-Ray のサンプリングルールを作成する際、サンプリングルールの作成ページでタグを追加することができます。

AWS Management Console にサインインし、https://console.aws.amazon.com/xray/homeで X-Ray コンソールを開きます。
ナビゲーションペインで、設定を展開し、サンプリングを選択します。
サンプリングールの作成を選択します。
サンプリングールの作成ページで、名前、優先度、制限、一致条件、および一致する属性を指定します。これらのプロパティの詳細については、「サンプリングルールの設定」を参照してください。
タグで、タグキー、およびオプションでタグ値を入力します。たとえば、Stageのタグキー、およびProductionのタグ値を入力して、このサンプリングルールが本番用途であることを示します。タグを追加すると、必要に応じて別のタグを追加するための新しい行が表示されます。タグの制限については、このトピックでタグの制限を参照してください。
タグの追加が完了したら、[サンプリングルールの作成] を選択します。

グループのタグを編集または削除する (コンソール)

X-Ray グループのタグをグループの編集ページで変更または削除できます。

AWS Management Console にサインインし、https://console.aws.amazon.com/xray/homeでX-Ray コンソールを開きます。
ナビゲーションペインで、設定を展開し、Groupsを選択します。
Groups テーブルで、グループの名前を選択します。
グループの編集ページ、タグで、タグキーと値を編集します。重複するタグキーを使用することはできません。タグ値はオプションです。必要に応じて値を削除できます。グループの編集ページでの他のプロパティの詳細については、「グループの設定」を参照してください。タグの制限については、このトピックでタグの制限を参照してください。
タグを削除するには、タグの右側にあるXを選択します。
タグの編集または削除を完了したら、[グループの更新] を選択します。

サンプリングルールのタグを編集または削除する (コンソール)

X-Ray サンプリングルールのタグをサンプリングルールの編集ページで変更または削除できます。

AWS Management Console にサインインし、https://console.aws.amazon.com/xray/homeでX-Ray コンソールを開きます。
ナビゲーションペインで、設定を展開し、サンプリングを選択します。
サンプリングルールテーブルで、サンプリングルールの名前を選択します。
タグで、タグキーと値を編集します。重複するタグキーを使用することはできません。タグ値はオプションです。必要に応じて値を削除できます。サンプリングルールの編集ページでの他のプロパティの詳細については、「サンプリングルールの設定」を参照してください。タグの制限については、このトピックでタグの制限を参照してください。
タグを削除するには、タグの右側にあるXを選択します。
タグの編集または削除を完了したら、[サンプリングルールの更新] を選択します。

AWS CLI でのタグの管理

X-Ray グループまたはサンプリングルールの作成時に、タグを追加できます。AWS CLI を使用して、タグを作成および管理することもできます。既存のグループやサンプリングルールのタグを更新するには、AWS X-Rayコンソール、またはTagResourceやUntagResourceのAPIを使用します。

トピック

新しい X-Ray グループまたはサンプリングルールにタグを追加する (CLI)
既存のリソースにタグを追加する (CLI)
リソースのタグを一覧表示する (CLI)
リソースのタグを削除する (CLI)

新しい X-Ray グループまたはサンプリングルールにタグを追加する (CLI)

新しい X-Ray グループまたはサンプリングルールの作成時にオプションのタグを追加するには、次のいずれかのコマンドを使用します。

新しいグループにタグを追加するには、以下のコマンドを実行し、group_nameをグループ名に、mydomain.comをサービスのエンドポイントに、key_nameをタグキーに、オプションで、値をタグ値に置き換えてください。グループの作成方法の詳細については、「グループ」を参照してください。


aws xray create-group \
   --group-name "group_name" \
   --filter-expression "service(\"mydomain.com\") {fault OR error}" \
   --tags [{"Key": "key_name","Value": "value"},{"Key": "key_name","Value": "value"}]

次に例を示します。


aws xray create-group \
   --group-name "AdminGroup" \
   --filter-expression "service(\"mydomain.com\") {fault OR error}" \
   --tags [{"Key": "Stage","Value": "Prod"},{"Key": "Department","Value": "QA"}]

新しいサンプリングルールにタグを追加するには、以下のコマンドを実行し、key_nameをタグキーに、オプションで、値をタグ値に置き換えてください。このコマンドは、--sampling-rule パラメータの値をJSON ファイルとして指定します。サンプリングルールの作成方法の詳細については、「サンプリングルール」を参照してください。


aws xray create-sampling-rule \
   --cli-input-json file://file_name.json

--cli-input-json パラメーターで指定された JSON ファイルfile_name.jsonの内容は以下の通りです。


{
    "SamplingRule": {
        "RuleName": "rule_name",
        "RuleARN": "string",
        "ResourceARN": "string",
        "Priority": integer,
        "FixedRate": double,
        "ReservoirSize": integer,
        "ServiceName": "string",
        "ServiceType": "string",
        "Host": "string",
        "HTTPMethod": "string",
        "URLPath": "string",
        "Version": integer,
        "Attributes": {"attribute_name": "value","attribute_name": "value"...}
    }
    "Tags": [
           {
               "Key":"key_name",
               "Value":"value"
           },
           {
               "Key":"key_name",
               "Value":"value"
           }
          ]
}

コマンドの例を次に示します。


aws xray create-sampling-rule \
   --cli-input-json file://9000-base-scorekeep.json

--cli-input-json パラメーターで指定されたサンプル 9000-base-scorekeep.json ファイルの内容は以下の通りです。


{
    "SamplingRule": {
        "RuleName": "base-scorekeep",
        "ResourceARN": "*",
        "Priority": 9000,
        "FixedRate": 0.1,
        "ReservoirSize": 5,
        "ServiceName": "Scorekeep",
        "ServiceType": "*",
        "Host": "*",
        "HTTPMethod": "*",
        "URLPath": "*",
        "Version": 1
    }
    "Tags": [
           {
               "Key":"Stage",
               "Value":"Prod"
           },
           {
               "Key":"Department",
               "Value":"QA"
           }
          ]
}

既存のリソースにタグを追加する (CLI)

tag-resourceコマンドを実行して既存の X-Ray グループまたはサンプリングルールにタグを追加するこの方法は、update-group や update-sampling-rule を実行してタグを追加するよりも簡単な場合があります。

グループまたはサンプリングルールにタグを追加するには、次のコマンドを実行し、ARN をリソースの ARN に置き換え、追加したいタグのキーとオプションの値を指定します。


aws xray tag-resource \
   --resource-arn "ARN" \
   --tag-keys [{"Key":"key_name","Value":"value"}, {"Key":"key_name","Value":"value"}]

次に例を示します。


aws xray tag-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/AdminGroup" \
   --tag-keys [{"Key": "Stage","Value": "Prod"},{"Key": "Department","Value": "QA"}]

リソースのタグを一覧表示する (CLI)

list-tags-for-resourceコマンドを実行して、X-Ray グループまたはサンプリングルールのタグを一覧表示できます。

グループまたはサンプリングルールに関連付けられているタグを一覧表示するには、次のコマンドを実行し、ARN をリソースの ARN に置き換えます。


aws xray list-tags-for-resource \
   --resource-arn "ARN"

次に例を示します。


aws xray list-tags-for-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/AdminGroup"

リソースのタグを削除する (CLI)

untag-resourceコマンドを実行して、X-Ray グループまたはサンプリングルールからタグを削除できます。

グループまたはサンプリングルールからタグを削除するには、次のコマンドを実行し、ARN をリソースの ARN に置き換え、削除したいタグのキーを指定します。

untag-resourceコマンドでタグ全体のみを削除できます。タグ値を削除するには、X-Ray コンソールを使用するか、タグを削除し、同じキーで異なる値または空の値で新しいタグを追加します。


aws xray untag-resource \
   --resource-arn "ARN" \
   --tag-keys ["key_name","key_name"]

次に例を示します。


aws xray untag-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/group_name" \
   --tag-keys ["Stage","Department"]

タグに基づいて X-Ray リソースへのアクセスを制御する

X-Ray グループまたはサンプリングルールにタグをアタッチしたり、リクエストでタグを X-Ray に渡すことができます。タグに基づいてアクセスを管理するには、xray:ResourceTag/key-name、aws:RequestTag/key-name、または aws:TagKeys の条件キーを使用して、ポリシーの [Condition element] (条件要素) でタグ情報を提供します。これらの条件キーの詳細については、「AWS リソースタグを使用してリソースへのアクセスを制御」を参照してください。

リソースのタグに基づいてリソースへのアクセスを制限するためのアイデンティティベースのポリシーの例を表示するには、「タグに基づいて X-Ray グループおよびサンプリングルールへのアクセスを管理する」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CloudFormation での X-Ray リソースの作成

サンプルアプリケーション

X-Ray のサンプリングルールとグループのタグ付け

注記

注記

トピック

タグの制限

注記

コンソールでのタグの管理

トピック

新しい グループにタグを追加する (コンソール)

新しいサンプリングルールにタグを追加する (コンソール)

グループのタグを編集または削除する (コンソール)

サンプリングルールのタグを編集または削除する (コンソール)

AWS CLI でのタグの管理

トピック

新しい X-Ray グループまたはサンプリングルールにタグを追加する (CLI)

既存のリソースにタグを追加する (CLI)

リソースのタグを一覧表示する (CLI)

リソースのタグを削除する (CLI)

タグに基づいて X-Ray リソースへのアクセスを制御する

新しいグループにタグを追加する (コンソール)