AWS OpsWorks for Chef Automate リソースのタグの使用

重要

なぜなら、AWS OpsWorks Chef Automate はもはや新規顧客を受け入れていないからです。2024 年 5 月 5 日までは、既存のお客様には影響はありません。その時点でサービスは利用できなくなります。既存のお客様は、 Chef SaaS または代替ソリューションに移行することをお勧めします。詳細については、「AWS OpsWorks Chef Automate のサポート終了に関するよくある質問」を参照してください。

タグとは、AWS リソースを識別および整理するためのメタデータとして使用される単語やフレーズのことです。AWS OpsWorks for Chef Automate では、リソースに最大 50 個のユーザー適用タグを含めることができます。各タグはキーと 1 つのオプションの値で構成されます。AWS OpsWorks for Chef Automate で以下のリソースにタグを適用できます。

• AWS OpsWorks for Chef Automate サーバー

• AWS OpsWorks for Chef Automate サーバーのバックアップ

AWS リソースのタグは、コストの追跡や、リソースへのアクセスのコントロール、タスクを自動化するためのリソースのグループ化、目的やライフサイクルステージ別のリソースの整理に役立ちます。タグのメリットの詳細については、AWS Billing and Cost ManagementユーザーガイドのAWS タグ付け戦略 AWS Answers とコスト配分タグの使用 を参照してください。

タグを使用して AWS OpsWorks for Chef Automate サーバーまたはバックアップへのアクセスをコントロールするには、AWS Identity and Access Management (IAM) でポリシーステートメントを作成または編集します。詳細については、AWS Identity and Access Managementユーザーガイド の「Controlling Access to AWS Resources Using Resource Tags」(リソースタグを使用した リソースへのアクセスの制御) を参照してください。

AWS OpsWorks for Chef Automate サーバーにタグを適用すると、タグはサーバーのバックアップ、バックアップを保存する Amazon S3 バケット、サーバーの Amazon EC2 インスタンス、AWS Secrets Manager に保存されているサーバーのシークレット、サーバーが使用する Elastic IP アドレスにも適用されます。タグは、AWS CloudFormation がサーバーを作成するために使用する AWS OpsWorks スタックには伝播されません。

AWS OpsWorks for Chef Automate でのタグの仕組み

このリリースでは、AWS OpsWorks[CM API] (CM の API) または AWS Management Console を使用してタグを追加および管理できます。AWS OpsWorksまた、CM は、サーバーに追加したタグをそのサーバーに関連付けられている AWS リソース (Secrets Managerの EC2 インスタンス、 Elastic IP アドレス、セキュリティグループ、S3 バケット、バックアップなど) に追加しようとします。以下の表では、AWS OpsWorks for Chef Automate でタグを追加および管理する方法の概要を示しています。

アクション	使用するもの
新しい AWS OpsWorks for Chef Automate サーバーまたは手動で作成するバックアップにタグを追加します。	[Create Chef Automate server (Chef Automate サーバーの作成)] を選択し、[Configure advanced settings (詳細設定の設定)] ページでタグを追加します。 既存のサーバーの [Create backup] (バックアップの作成) ページで [Backups] (バックアップ) を選択し、[Create a backup of your Chef Automate 2 server] (Chef Automate 2 サーバーのバックアップの作成) ページでタグを追加します。 CreateServer または CreateBackup コマンドに Tags パラメータを追加します。
リソースのタグを表示します。	サーバーの詳細ページで、ナビゲーションペインで [Tags (タグ)] を選択します。 サーバーの [Backups (バックアップ)] ページで、バックアップを選択し、[Edit backup (バックアップの編集)] を選択します。 ListTagsForResource コマンドを実行します。
バックアップが手動で作成されたか自動的に作成されたかに関係なく、既存の AWS OpsWorks for Chef Automate サーバーまたはバックアップにタグを追加します。	サーバーの詳細ページで、ナビゲーションペインで [Tags (タグ)] を選択し、[Edit (編集)] を選択します。 サーバーの [Backups (バックアップ)] ページで、バックアップを選択し、[Edit backup (バックアップの編集)] を選択します。 TagResource コマンドを実行します。
リソースからタグを削除する	サーバーの詳細ページで、ナビゲーションペインで [Tags (タグ)] を選択し、[Edit (編集)] を選択します。削除するタグの横にある [X] を選択します。 サーバーの [Backups (バックアップ)] ページで、バックアップを選択し、[Edit backup (バックアップの編集)] を選択します。削除するタグの横にある [X] を選択します。 UntagResource コマンドを実行します。

DescribeServers および DescribeBackups のレスポンスにタグ情報は含まれません。タグを表示するには、ListTagsForResource API を使用します。

AWS OpsWorks for Chef Automate でタグを追加、管理する (コンソール)

このセクションの手順は AWS Management Console で実行されます。

タグを追加する場合、タグのキーを空にすることはできません。キーは最大 127 文字で、Unicode 文字、数字、区切り文字、または特殊文字 (+ - = . _ : / @) のみを含めることができます。タグの値はオプションです。キーはあるが値はないタグであれば、追加できます。値は最大 255 文字とし、Unicode 文字、数字、区切り文字、または特殊文字 (+ - = . _ : / @) のみを含めることができます。

トピック

• 新しい AWS OpsWorks for Chef Automate サーバーにタグを追加する (コンソール)
• 新しいバックアップにタグを追加する (コンソール)
• 既存のサーバーにタグを追加または表示する (コンソール)
• 既存のバックアップにタグを追加または表示する (コンソール)
• サーバからタグを削除する (コンソール)
• バックアップからタグを削除する (コンソール)

新しい AWS OpsWorks for Chef Automate サーバーにタグを追加する (コンソール)

1. AWS OpsWorks for Chef Automate サーバーを作成するための [prerequisites] (前提条件) があれば、必ず完了させてください。

2. Chef Automate サーバーの作成 の手順 1～10 に従います。

3. 自動バックアップ設定を指定した後、[Configure advanced settings] (詳細設定の設定) ページの [Tags] (タグ) の領域でタグを追加します。最大 50 個のタグを追加できます。タグを追加したら、[次へ] を選択します。

4. Chef Automate サーバーの作成 のステップ 13 に進み、新しいサーバーに対して選択した設定を確認します。

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

1. AWS OpsWorks for Chef Automate ホームページで、既存の Chef Automate サーバーを選択します。

2. サーバーの詳細ページで、ナビゲーションペインで [Backups (バックアップ)] を選択します。

3. [Backups (バックアップ)] ページで、[Create backup (バックアップの作成)] を選択します。

4. タグを追加する。タグの追加が完了したら、[Create (作成)] を選択します。

既存のサーバーにタグを追加または表示する (コンソール)

1. AWS OpsWorks for Chef Automate ホームページで、既存の Chef Automate サーバーを選択して詳細ページを開きます。

2. ナビゲーションペインで [Tags (タグ)] を選択するか、詳細ページの下部にある [View all tags (すべてのタグを表示)] を選択します。

3. [Tags (タグ)] ページで、[Edit (編集)] を選択します。

4. サーバー上のタグを追加または編集します。完了したら、[保存] を選択します。

   注記

   Chef Automate サーバーでタグを変更すると、EC2 インスタンス、Elastic IP アドレス、セキュリティグループ、S3 バケット、バックアップなど、サーバーに関連付けられているリソースのタグも変更されることに注意してください。

既存のバックアップにタグを追加または表示する (コンソール)

1. AWS OpsWorks for Chef Automate ホームページで、既存の Chef Automate サーバーを選択して詳細ページを開きます。

2. ナビゲーションペインで [Backups (バックアップ)] を選択するか、詳細ページの [Recent backups (最近のバックアップ)] 領域で [View all backups (すべてのバックアップを表示)] を選択します。

3. [Backups (バックアップ)] ページで、管理するバックアップを選択し、[Edit backup (バックアップの編集)] を選択します。

4. バックアップにタグを追加または編集します。完了したら、[Update (更新)] を選択します。

サーバからタグを削除する (コンソール)

1. AWS OpsWorks for Chef Automate ホームページで、既存の Chef Automate サーバーを選択して詳細ページを開きます。

2. ナビゲーションペインで [Tags (タグ)] を選択するか、詳細ページの下部にある [View all tags (すべてのタグを表示)] を選択します。

3. [Tags (タグ)] ページで、[Edit (編集)] を選択します。

4. タグを削除するには、タグの横にある [X] を選択します。完了したら、[保存] を選択します。

   注記

   Chef Automate サーバーでタグを変更すると、EC2 インスタンス、Elastic IP アドレス、セキュリティグループ、S3 バケット、バックアップなど、サーバーに関連付けられているリソースのタグも変更されることに注意してください。

バックアップからタグを削除する (コンソール)

1. AWS OpsWorks for Chef Automate ホームページで、既存の Chef Automate サーバーを選択して詳細ページを開きます。

2. ナビゲーションペインで [Backups (バックアップ)] を選択するか、詳細ページの [Recent backups (最近のバックアップ)] 領域で [View all backups (すべてのバックアップを表示)] を選択します。

3. [Backups (バックアップ)] ページで、管理するバックアップを選択し、[Edit backup (バックアップの編集)] を選択します。

4. タグを削除するには、タグの横にある [X] を選択します。完了したら、[Update (更新)] を選択します。

AWS OpsWorks for Chef Automate でタグを追加および管理する (CLI)

このセクションの手順は AWS CLI で実行されます。タグの使用を開始する前に、AWS CLI の最新リリースを実行していることを確認してください。AWS CLI のインストールまたはアップグレード方法の詳細については、AWS Command Line Interfaceユーザーガイドの [Installing the] AWS CLI (をインストールする) を参照してください。

タグを追加する場合、タグのキーを空にすることはできません。キーは最大 127 文字で、Unicode 文字、数字、区切り文字、または特殊文字 (+ - = . _ : / @) のみを含めることができます。タグの値はオプションです。キーはあるが値はないタグであれば、追加できます。値は最大 255 文字とし、Unicode 文字、数字、区切り文字、または特殊文字 (+ - = . _ : / @) のみを含めることができます。

トピック

• 新しい AWS OpsWorks for Chef Automate サーバーにタグを追加する (CLI)
• 新しいバックアップにタグを追加する (CLI)
• 既存のサーバーまたはバックアップにタグを追加する (CLI)
• リソースタグのリストを取得する
• リソースからタグを削除する

新しい AWS OpsWorks for Chef Automate サーバーにタグを追加する (CLI)

AWS CLI サーバーを作成するときに、AWS OpsWorks for Chef Automate を使用してタグを追加できます。この手順では、サーバーの作成方法について詳しく説明していません。AWS CLI を使用して AWS OpsWorks for Chef Automate のサーバーを作成する方法の詳細については、本ガイドの AWS CLI を使用して Chef Automate サーバーを作成する を参照してください。サーバーには最大 50 個のタグを追加できます。

1. AWS OpsWorks for Chef Automate サーバーを作成するための [prerequisites] (前提条件) があれば、必ず完了させてください。

2. 「AWS CLI を使用して Chef Automate サーバーを作成する」のステップ 1 〜 5 を完了します。

3. ステップ 6 では、create-server コマンドを実行するときに、以下の例に示すように、コマンドに --tags パラメータを追加します。

   aws opsworks-cm create-server ... --tags Key=Key1,Value=Value1 Key=Key2,Value=Value2

   以下の例では、create-server コマンドのタグ部分のみを示しています。

   aws opsworks-cm create-server ... --tags Key=Stage,Value=Production Key=Department,Value=Marketing

4. 「AWS CLI を使用して Chef Automate サーバーを作成する」の残りのステップを行います。タグが新しいサーバーに追加されたことを確認するには、このトピックの「リソースタグのリストを取得する 」の手順に従います。

新しいバックアップにタグを追加する (CLI)

AWS CLI サーバーの新しい手動バックアップを作成するときに、AWS OpsWorks for Chef Automate を使用してタグを追加できます。この手順では、手動バックアップの作成方法について詳しく説明していません。手動バックアップを作成する方法の詳細については、AWS OpsWorks for Chef Automate サーバーのバックアップ の「AWS CLI で手動バックアップを実行するには」を参照してください。バックアップには最大 50 個のタグを追加できます。サーバにタグがある場合、新しいバックアップにはサーバのタグが自動的にタグ付けされます。

デフォルトでは、新しい AWS OpsWorks for Chef Automate サーバーを作成すると、自動バックアップが有効になります。このトピックの「既存のサーバーまたはバックアップにタグを追加する (CLI) 」で説明されている tag-resource コマンドを実行して、自動バックアップにタグを追加できます。

• 手動バックアップの作成中にタグをバックアップに追加するには、以下のコマンドを実行します。コマンドのタグ部分のみを示しています。フル create-backup コマンドの例に関しては、AWS OpsWorks for Chef Automate サーバーのバックアップ の「AWS CLI で手動バックアップを実行するには」を参照してください。

  aws opsworks-cm create-backup ... --tags Key=Key1,Value=Value1 Key=Key2,Value=Value2

  以下の例では、create-backup コマンドのタグ部分のみを示しています。

  aws opsworks-cm create-backup ... --tags Key=Stage,Value=Production Key=Department,Value=Marketing

既存のサーバーまたはバックアップにタグを追加する (CLI)

tag-resource コマンドを実行して、タグを既存の AWS OpsWorks for Chef Automate サーバーまたはバックアップに追加できます (バックアップが手動で作成されたか自動的に作成されたかに関係なく)。ターゲットリソースの Amazon リソースナンバー (ARN) を指定して、タグを追加します。

1. タグを適用するリソースの ARN を取得するには:

   • サーバーの場合は、describe-servers --server-name server_name を実行します。コマンドの結果には、サーバーの ARN が表示されます。

   • バックアップの場合は、describe-backups --backup-id backup_ID を実行します。コマンドの結果には、バックアップの ARN が表示されます。describe-backups --server-name server_name を実行して、特定の AWS OpsWorks for Chef Automate サーバーのすべてのバックアップに関する情報を表示することもできます。

   以下の例では、ServerArn コマンドの結果の describe-servers --server-name opsworks-cm-test のみを示しています。tag-resource コマンドに ServerArn 値を指定して、サーバーにタグを追加します。

   {
       "Servers": [
           {
               ...
               "ServerArn": "arn:aws:opsworks-cm:us-west-2:123456789012:server/opsworks-cm-test/EXAMPLEd-66b0-4196-8274-d1a2bEXAMPLE"
           }
       ]
   }

2. ステップ 1 で返された ARN を使用して、tag-resourceコマンドを実行します。

   aws opsworks-cm tag-resource --resource-arn "server_or_backup_ARN" --tags Key=Key1,Value=Value1 Key=Key2,Value=Value2

   次に例を示します。

   aws opsworks-cm tag-resource --resource-arn "arn:aws:opsworks-cm:us-west-2:123456789012:server/opsworks-cm-test/EXAMPLEd-66b0-4196-8274-d1a2bEXAMPLE" --tags Key=Stage,Value=Production Key=Department,Value=Marketing

3. タグが正常に追加されたことを確認するには、次の手順「リソースタグのリストを取得する 」に進みます。

リソースタグのリストを取得する

list-tags-for-resource コマンドを実行して、AWS OpsWorks for Chef Automate サーバーまたはバックアップにアタッチされているタグを表示できます。ターゲットリソースの ARN を指定して、そのタグを表示します。

1. タグを一覧表示するリソースの ARN を取得するには:

   • サーバーの場合は、describe-servers --server-name server_name を実行します。コマンドの結果には、サーバーの ARN が表示されます。

   • バックアップの場合は、describe-backups --backup-id backup_ID を実行します。コマンドの結果には、バックアップの ARN が表示されます。describe-backups --server-name server_name を実行して、特定の AWS OpsWorks for Chef Automate サーバーのすべてのバックアップに関する情報を表示することもできます。

2. ステップ 1 で返された ARN を使用して、list-tags-for-resource コマンドを実行します。

   aws opsworks-cm list-tags-for-resource --resource-arn "server_or_backup_ARN"

   次に例を示します。

   aws opsworks-cm tag-resource --resource-arn "arn:aws:opsworks-cm:us-west-2:123456789012:server/opsworks-cm-test/EXAMPLEd-66b0-4196-8274-d1a2bEXAMPLE"

   リソースにタグがある場合、コマンドは以下のような結果を返します。

   {
       "Tags": [
           {
               "Key": "Stage",
               "Value": "Production"
           },
           {
               "Key": "Department",
               "Value": "Marketing"
           }
       ]
   }

リソースからタグを削除する

untag-resource コマンドを実行して、AWS OpsWorks for Chef Automate サーバーまたはバックアップからタグを削除できます。リソースが削除されると、リソースのタグも削除されます。ターゲットリソースの Amazon リソースナンバー (ARN) を指定して、タグを削除します。

1. タグを削除するリソースの ARN を取得するには:

   • サーバーの場合は、describe-servers --server-name server_name を実行します。コマンドの結果には、サーバーの ARN が表示されます。

   • バックアップの場合は、describe-backups --backup-id backup_ID を実行します。コマンドの結果には、バックアップの ARN が表示されます。describe-backups --server-name server_name を実行して、特定の AWS OpsWorks for Chef Automate サーバーのすべてのバックアップに関する情報を表示することもできます。

2. ステップ 1 で返された ARN を使用して、untag-resource コマンドを実行します。削除するタグのみを指定します。

   aws opsworks-cm untag-resource --resource-arn "server_or_backup_ARN" --tags Key=Key1,Value=Value1 Key=Key2,Value=Value2

   この例では、untag-resource コマンドは、キーが Stage で値が Production のタグのみを削除します。

   aws opsworks-cm untag-resource --resource-arn "arn:aws:opsworks-cm:us-west-2:123456789012:server/opsworks-cm-test/EXAMPLEd-66b0-4196-8274-d1a2bEXAMPLE" --tags Key=Stage,Value=Production

3. タグが正常に削除されたことを確認するには、このトピックの「リソースタグのリストを取得する 」の手順に従います。

以下も参照してください。

• AWS CLI を使用して Chef Automate サーバーを作成する

• AWS OpsWorks for Chef Automate サーバーのバックアップ

• AWS タグ付け戦略

• AWS Identity and Access Managementユーザーガイド の「Controlling Access to AWS Resources Using Resource Tags」(リソースタグを使用した リソースへのアクセスの制御)

• 「AWS Billing and Cost Management ユーザーガイド」の「コスト配分タグの使用」

• AWS OpsWorksCM API リファレンス の CreateBackup

• AWS OpsWorksCM API リファレンス の CreateServer

• AWS OpsWorksCM API リファレンス の TagResource

• AWS OpsWorksCM API リファレンス の ListTagsForResource

• AWS OpsWorks 「CM API Reference」 (CM API リファレンス) の UntagResource (リソースのタグを外す)