オンプレミスインスタンスを自動的に登録解除します - AWS CodeDeploy

オンプレミスインスタンスを自動的に登録解除します

通常は、デプロイする計画がなくなった後、オンプレミスインスタンスの登録を解除します。オンプレミスインスタンスの登録を解除すると、オンプレミスインスタンスがデプロイグループのオンプレミスインスタンスタグの一部であっても、オンプレミスインスタンスはデプロイには含まれなくなります。AWS CLI を使用してオンプレミスインスタンスの登録を解除できます。

注記

CodeDeploy コンソールを使用してオンプレミスインスタンスの登録を解除することはできません。また、オンプレミスインスタンスの登録を解除しても、オンプレミスインスタンスに関連付けられたオンプレミスインスタンスタグは解除されません。オンプレミスインスタンスから CodeDeploy エージェントをアンインストールしません。オンプレミスインスタンスの設定ファイルはオンプレミスインスタンスから削除されません。

このセクションのアクティビティの一部 (ただしすべてではない) を実行するために CodeDeploy コンソールを使うには、手動でオンプレミスのインスタンスの登録を解除します の CodeDeploy コンソールセクションを参照してください。

オンプレミスインスタンスタグの関連付けを手動で解除するには、オンプレミスインスタンスから手動でオンプレミスインスタンスタグを削除します を参照してください。

CodeDeploy エージェントを自動でアンインストールし、設定ファイルをオンプレミスインスタンスから削除するには、CodeDeploy エージェントを自動でアンインストールし、設定ファイルをオンプレミスインスタンスから削除します。 を参照してください。

CodeDeploy エージェントのみをオンプレミスインスタンスから手動でアンインストールするには、CodeDeploy エージェントのオペレーションの管理 を参照してください。

AWS CLI を使用して、deregister コマンドを呼び出し、以下を指定します。

  • CodeDeploy に対してオンプレミスインスタンスを一意に識別する名前 (--instance-name のオプションを用いて)

  • 必要に応じて、オンプレミスインスタンスに関連付けられた IIAM ユーザーを削除するかどうか デフォルトの動作では、IAM ユーザーが削除されます。オンプレミスインスタンスに関連付けられた IAM ユーザーを削除しない場合は、コマンドで --no-delete-iam-user オプションを指定します。

  • 必要に応じて、CodeDeploy を用いてオンプレミスインスタンスが登録された AWS のリージョン(--region のオプションを用いて) これは、「AWS 全般のリファレンス」(例: us-west-2) の「リージョンエンドポイント」にリストされているサポート対象のリージョンの 1 つである必要があります。このオプションを指定しない場合、IAM ユーザーの呼び出しに関連付けられているデフォルトの AWS のリージョンが使用されます。

インスタンスを登録解除し、ユーザーを削除する例:

aws deploy deregister --instance-name AssetTag12010298EX --region us-west-2

インスタンスを登録解除し、ユーザーを削除しない例:

aws deploy deregister --instance-name AssetTag12010298EX --no-delete-iam-user --region us-west-2

deregister コマンドは次のことを行います。

  1. CodeDeploy でオンプレミスインスタンスの登録を解除します。

  2. 指定した場合、オンプレミスインスタンスに関連付けられている IAM ユーザーを削除します。

オンプレミスインスタンスの登録解除後:

  • コンソールにはすぐに表示されなくなります。

  • 直後に同じ名前で別のインスタンスを作成できます。

このコマンドでエラーが発生した場合、エラーメッセージが表示され、手動で残りのステップを完了する方法について説明します。それ以外の場合は、成功メッセージが表示され、uninstall コマンドを呼び出す方法が説明されます。