AWS Batch リソースのタグ付け - AWS Batch

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

AWS Batch リソースのタグ付け

AWS Batch リソースを管理しやすくするために、タグ形式で各リソースに独自のメタデータを割り当てることができます。このトピックでは、タグとその作成方法について説明します。

タグの基本

タグとは、AWS リソースに付けるラベルです。タグはそれぞれ、1 つのキーとオプションの 1 つので構成されており、どちらもお客様側が定義します。

タグを使用すると、 AWS リソースを目的、所有者、環境などで分類できます。同じ型のリソースが多い場合に、割り当てたタグに基づいて特定のリソースをすばやく識別できます。たとえば、AWS Batch サービスに一連のタグを定義して、各サービスの所有者とスタックレベルを追跡できます。リソースタイプごとに一貫した一連のタグキーを考案することをお勧めします。

タグは自動的にはリソースに割り当てられません。タグを追加したら、いつでもタグキーと値は編集でき、タグはリソースからいつでも削除できます。リソースを削除すると、リソースのタグも削除されます。

タグには、AWS Batch に関連する意味はなく、完全に文字列として解釈されます。タグの値を空の文字列に設定することはできますが、タグの値を null に設定することはできません。特定のリソースについて既存のタグと同じキーを持つタグを追加した場合、以前の値は新しい値によって上書きされます。

AWS Management Console、AWS CLI、および AWS Batch API を使用してタグを操作できます。

AWS Identity and Access Management (IAM) を使用している場合は、タグを作成、編集、削除する許可を持つ AWS アカウントのユーザーを制御できます。

 リソースのタグ付け

新規または既存のAWS Batch コンピューティング環境、ジョブ、ジョブ定義、ジョブキュー、スケジューリングポリシーのタグをつけることができます。

AWS Batch コンソールを使用している場合、新規リソースには作成時にタグを適用でき、既存のリソースには関連するリソースページの Tags] (タグ) タブを使用していつでもタグを適用できます。

AWS Batch API、AWS CLI、または AWS SDK を使用している場合、関連する API アクションの tags パラメータを使用して新規リソースにタグを適用でき、TagResource API アクションを使用して既存のリソースにタグを適用できます。詳細については、TagResourceを参照してください。

リソース作成アクションによっては、リソースの作成時にリソースのタグを指定できます。リソースの作成時にタグを適用できない場合、リソースの作成プロセスは失敗します。これにより、作成時にタグ付けするリソースが、指定したタグで作成されるか、まったく作成されないことが確認されます。作成時にリソースにタグを付ける場合、リソースの作成後にカスタムのタグ付けスクリプトを実行する必要はありません。

次の表では、タグ付け可能な AWS Batch リソースと、作成時にタグ付け可能なリソースについて説明します。

AWS Batch リソースのタグ付けのサポート
リソース タグをサポート タグの伝播をサポート 作成時のタグ付けをサポート (AWS Batch API、AWS CLI、AWS SDK)

AWS Batch コンピューティング環境

Yes

いいえ。 コンピューティング環境タグは、他のリソースには伝播されません。リソースのタグは、CreateComputeEnvironment API オペレーションで渡される computeResources オブジェクトの tags メンバーで指定されます。

Yes

AWS Batch ジョブ

はい

Yes

Yes

AWS Batchジョブ定義

Yes

いいえ

Yes

AWS Batchジョブキュー

Yes

いいえ

Yes

AWS Batchスケジューリングポリシー

Yes

いいえ

Yes

タグの制限

タグには以下のような基本制限があります。

  • リソースあたりのタグの最大数 - 50 件

  • タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。

  • キーの最大長 - UTF-8 の 128 Unicode 文字

  • 値の最大長 - UTF-8 の 256 Unicode 文字

  • 複数の AWS サービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスでも許可される文字に制限が適用されることがあるのでご注意ください。一般的に使用が許可される文字は、UTF-8 で表現できる文字、数字、スペース、および +、-、=、.、_、:、/、@。

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

  • aws:AWS:、またはその大文字または小文字の組み合わせを、キーまたは値のプレフィックスとして使用しないでください。これらの文字列は AWS による使用のために予約されています。このプレフィックスが含まれるタグのキーや値を編集したり削除することはできません。このプレフィックスを持つタグは、リソースあたりのタグ数の制限時には計算されません。

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

AWS Batch コンソールを使って、新規または既存のコンピューティング環境、ジョブ、ジョブ定義、ジョブキューに関連するタグを管理することができます。

作成時に個々のリソースにタグを追加する

タグは、AWS Batchコンピューティング環境、ジョブ、ジョブ定義、ジョブキュー、およびスケジューリングポリシーの作成時に追加することができます。

個々のリソースでのタグの追加と削除

AWS Batch では、クラスターに関連付けられたタグをリソースのページから直接追加または削除できます。

個々のリソースのタグを追加または削除するには
  1. https://console.aws.amazon.com/batch/ で AWS Batch コンソールを開きます。

  2. ナビゲーションバーから、使用するリージョンを選択します。

  3. ナビゲーションペインでリソースタイプ (例: ジョブキュー) を選択します。

  4. 特定のリソースを選択し、Edit tags] (タグの編集) を選択します。

  5. 必要に応じてタグを追加または削除します。

    • タグを追加するには — リストの末尾にある空のテキストボックスにキーと値を指定します。

    • タグを削除するには — タグの横にある Delete icon ボタンを選択します。

  6. 追加または削除するタグごとにこのプロセスを繰り返し、Edit tags] (タグの編集) を選択して終了します。

CLI または API でのタグの操作

リソースのタグの追加、更新、リスト表示、および削除には、次の AWS CLI コマンドまたは AWS Batch API オペレーションを使用します。

AWS Batch リソースのタグ付けのサポート
タスク API アクション AWS CLI AWS Tools for Windows PowerShell

1 つ以上のタグを追加、または上書きします。

TagResource

タグリソース

追加-BATResourceTag

1 つ以上のタグを削除します。

UntagResource

タグなしリソース

削除-BATResourceTag

リソースのタグを一覧表示します

ListTagsForResource

list-tags-for-resource

Get-BATResourceTag

以下の例では、AWS CLIを使用して、リソースに対してタグ付けまたはタグ削除する方法を示しています。

例 1: 既存のリソースにタグ付けする

次のコマンドでは、既存のリソースにタグ付けします。

aws batch tag-resource --resource-arn resource_ARN --tags team=devs
例 2: 既存のリソースからタグを削除する

次のコマンドでは、既存のリソースからタグを削除します。

aws batch untag-resource --resource-arn resource_ARN --tag-keys tag_key
例 3: リソースのタグのリスト取得

次のコマンドは、既存のリソースに関連付けられているタグのリストを取得します。

aws batch list-tags-for-resource --resource-arn resource_ARN

一部のリソース作成アクションでは、リソースの作成時にタグを指定できます。以下のアクションでは、作成時のタグ付けがサポートされます。

タスク API アクション AWS CLI AWS Tools for Windows PowerShell

コンピューティング環境の作成

CreateComputeEnvironment

create-compute-environment

New-BATComputeEnvironment

ジョブキューの作成

CreateJobQueue

create-job-queue

New-BATJobQueue

スケジューリングポリシーの作成

CreateSchedulingPolicy

create-scheduling-policy

New-BATSchedulingPolicy

ジョブ定義を登録する

RegisterJobDefinition

register-job-definition

Register-BATJobDefinition

ジョブを送信する

SubmitJob

submit-job

Submit-BATJob