[register-on-premises-instance] コマンド (IAM ユーザー ARN) を使用してオンプレミスインスタンスを登録します。

アクセス権限 (CLI) を割り当てるには

1. AWS CLI を呼び出すのに使用している Amazon EC2インスタンスまたはデバイス上に、次のポリシーの内容を用いてファイルを作成します。ファイルに CodeDeploy-OnPrem-Permissions.json のような名前を付けて、ファイルを保存します。

   {
       "Version": "2012-10-17",		 	 	 
       "Statement": [
           {
               "Action": [
                   "s3:Get*",
                   "s3:List*"
               ],
               "Effect": "Allow",
               "Resource": "*"
           }
       ]
   }

   注記

   このポリシーを、オンプレミスインスタンスがアクセスする必要のある Amazon S3 バケットにのみ制限することをお勧めします。このポリシーを制限する場合、AWS CodeDeploy のエージェントを含む Amazon S3 バケットへのアクセスを許可することも確認します。そうしない場合、CodeDeploy エージェントが関連するオンプレミスインスタンスにインストールされる、または更新されるたびに、エラーが発生する可能性があります。

   例:

   {
     "Version": "2012-10-17",		 	 	 
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "s3:Get*",
           "s3:List*"
         ],
         "Resource": [
           "arn:aws:s3:::amzn-s3-demo-bucket/*",
           "arn:aws:s3:::aws-codedeploy-us-east-2/*",
           "arn:aws:s3:::aws-codedeploy-us-east-1/*",
           "arn:aws:s3:::aws-codedeploy-us-west-1/*",
           "arn:aws:s3:::aws-codedeploy-us-west-2/*",
           "arn:aws:s3:::aws-codedeploy-ca-central-1/*",
           "arn:aws:s3:::aws-codedeploy-eu-west-1/*",
           "arn:aws:s3:::aws-codedeploy-eu-west-2/*",
           "arn:aws:s3:::aws-codedeploy-eu-west-3/*",
           "arn:aws:s3:::aws-codedeploy-eu-central-1/*",
           "arn:aws:s3:::aws-codedeploy-eu-central-2/*",
           "arn:aws:s3:::aws-codedeploy-eu-north-1/*",
           "arn:aws:s3:::aws-codedeploy-eu-south-1/*",
           "arn:aws:s3:::aws-codedeploy-eu-south-2/*",
           "arn:aws:s3:::aws-codedeploy-il-central-1/*",
           "arn:aws:s3:::aws-codedeploy-ap-east-1/*",
           "arn:aws:s3:::aws-codedeploy-ap-northeast-1/*",
           "arn:aws:s3:::aws-codedeploy-ap-northeast-2/*",
           "arn:aws:s3:::aws-codedeploy-ap-northeast-3/*",
           "arn:aws:s3:::aws-codedeploy-ap-southeast-1/*",        
           "arn:aws:s3:::aws-codedeploy-ap-southeast-2/*",
           "arn:aws:s3:::aws-codedeploy-ap-southeast-3/*",
           "arn:aws:s3:::aws-codedeploy-ap-southeast-4/*",
           "arn:aws:s3:::aws-codedeploy-ap-south-1/*",
           "arn:aws:s3:::aws-codedeploy-ap-south-2/*",
           "arn:aws:s3:::aws-codedeploy-me-central-1/*",
           "arn:aws:s3:::aws-codedeploy-me-south-1/*",
           "arn:aws:s3:::aws-codedeploy-sa-east-1/*"
         ]
       }
     ]
   }

2. put-user-policy コマンドを呼び出し、IAM ユーザーの名前 (--user-name のオプションを用いて)、ポリシーの名前 (--policy-name のオプションを用いて)、および新しく作成したポリシードキュメントへのパス (--policy-document のオプションを用いて) を指定します。例えば、CodeDeploy-OnPrem-Permissions.json というファイルが、コマンドを呼び出しているのと同じディレクトリ (フォルダ) にあるとします。

   重要

   ファイル名の前に必ず file:// を含めてください。このコマンドでは必須です。

   aws iam put-user-policy --user-name CodeDeployUser-OnPrem --policy-name CodeDeploy-OnPrem-Permissions --policy-document file://CodeDeploy-OnPrem-Permissions.json

アクセス権限を割り当てるには (コンソール)

1. https://console.aws.amazon.com/iam/ で IAM コンソール を開きます。

2. ナビゲーションペインで、[Policies] を選択し、[Create Policy] を選択します。([Get Started] ボタンが表示された場合は、そのボタンを選択してから、[Create Policy] を選択します)。

3. [独自のポリシーを作成] の横で、[選択] を選択します。

4. [ポリシー名] ボックスに、このポリシーの名前を入力します (CodeDeploy-OnPrem-Permissions など)。

5. [ポリシードキュメント] ボックスに、以下のアクセス権限の式を入力するか貼り付けることで、AWS CodeDeploy が IAM ユーザーに代わって、アプリケーションリビジョンをポリシーで指定されたどの Amazon S3 バケットからでもオンプレミスインスタンスにデプロイすることを許可します。

   {
       "Version": "2012-10-17",		 	 	 
       "Statement": [
           {
               "Action": [
                   "s3:Get*",
                   "s3:List*"
               ],
               "Effect": "Allow",
               "Resource": "*"
           }
       ]
   }

6. [ポリシーを作成] を選択します。

7. ナビゲーションペインで [ユーザー] を選択します。

8. ユーザーのリストで、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する で作成した IAM ユーザーを探して選択します。

9. [Permissions] タブを開き、[Managed Policies] で [Attach Policy] を選択します。

10. CodeDeploy-OnPrem-Permissions という名前のポリシーを選択した後、[ポリシーのアタッチ] を選択します。

認証情報 (CLI) を取得するには

1. list-access-keys コマンドを呼び出し、IAM ユーザーの名前を指定し (--user-name のオプションを用いて)、アクセスキー ID のみのクエリを実行します (--query および --output のオプションを用いて)。例:

   aws iam list-access-keys --user-name CodeDeployUser-OnPrem --query "AccessKeyMetadata[*].AccessKeyId" --output text

2. キーが出力に表示されないか、1 つのキーについての情報だけが出力に表示されたら、create-access-key コマンドを呼び出し、IAM ユーザーの名前を指定します (--user-name のオプションを用いて)。

   aws iam create-access-key --user-name CodeDeployUser-OnPrem

   create-access-key コマンドを呼び出した出力で、AccessKeyId フィールドおよび SecretAccessKey フィールドの値をメモします。この情報は ステップ 4: オンプレミスインスタンスに設定ファイルを追加 で必要になります。

   重要

   このシークレットアクセスキーにアクセスできるのは、この時だけです。このシークレットアクセスキーを忘れた、またはアクセスできなくなった場合、ステップ 3: ユーザーの認証情報を取得する のステップに従い、新しいキーを生成する必要があります。

3. 2 つのアクセスキーが既にリストされている場合は、そのうちの 1 つを削除する必要があります。削除するには、delete-access-key コマンドを呼び出して、IAM ユーザーの名前 (--user-name のオプションを用いて) と削除するアクセスキーの ID (--access-key-id のオプションを用いて) を指定します。それから、このステップの前のほうにある説明のとおり、create-access-key コマンドを呼び出します。delete-access-key コマンドを呼び出す例は以下のとおりです。

   aws iam delete-access-key --user-name CodeDeployUser-OnPrem --access-key-id access-key-ID

   重要

   このアクセスキーの 1 つを削除するために delete-access-key のコマンドを呼び出すとき、および ステップ 4: オンプレミスインスタンスに設定ファイルを追加 で説明するようにオンプレミスインスタンスがすでにこのアクセスキーを使用しているときは、ステップ 4: オンプレミスインスタンスに設定ファイルを追加 の説明に再び従って、この IAM ユーザーに関連付けられる別のアクセスキー ID とシークレットアクセスキーを指定する必要があります。そうしない場合、そのオンプレミスインスタンスへのデプロイは、無期限の保留状態のまま、または完全にエラーとなる可能性があります。

認証情報を取得するには (コンソール)

1. 1. https://console.aws.amazon.com/iam/ で IAM コンソール を開きます。

   2. ユーザーのリストがナビゲーションペインに表示されない場合は、[Users] を選択します。

   3. ユーザーのリストで、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する で作成した IAM ユーザーを探して選択します。

2. [Security credentials] タブにキーが表示されていない場合、または 1 つしか表示されていない場合は、[Create access key] を選択します。

   2 つのアクセスキーが表示されている場合は、片方を削除する必要があります。片方のアクセスキーの横にある [Delete] を選択した後、[Create access key] を選択します。

   重要

   このいずれかのアクセスキーの横にある Delete を選択する場合、および、オンプレミスインスタンスが ステップ 4: オンプレミスインスタンスに設定ファイルを追加 にある説明のとおりにすでにそのアクセスキーを使用している場合は、ステップ 4: オンプレミスインスタンスに設定ファイルを追加 の手順に再び従って、この IAM ユーザーと関連付けられた異なるアクセスキー ID およびシークレットアクセスキーを指定する必要があります。そうしない場合、そのオンプレミスインスタンスへのデプロイは、無期限の保留状態のまま、または完全にエラーとなる可能性があります。

3. [Show] を選択し、アクセスキー ID とシークレットアクセスキーをメモします。この情報は、次のステップで必要になります。または、[Download .csv file] を選択して、アクセスキー ID とシークレットアクセスキーのコピーを保存することができます。

   重要

   認証情報をメモする、または、ダウンロードするのでない限り、このシークレットアクセスキーにアクセスできるのは、この時だけです。このシークレットアクセスキーを忘れた、またはアクセスできなくなった場合、ステップ 3: ユーザーの認証情報を取得する のステップに従い、新しいキーを生成する必要があります。

4. [Close] を選択して [Users > IAM User Name] ページに戻ります。

1. オンプレミスインスタンス上の以下の場所に、codedeploy.onpremises.yml (Ubuntu サーバーまたは RHEL オンプレミスインスタンスの場合)、または conf.onpremises.yml (Windows サーバーのオンプレミスインスタンスの場合) という名前のファイルを作成します。

   • Ubuntu サーバーの場合:/etc/codedeploy-agent/conf

   • Windows サーバーについて：C:\ProgramData\Amazon\CodeDeploy

2. テキストエディタを使用して、新しく作成した codedeploy.onpremises.yml または conf.onpremises.yml ファイルに次の情報を追加します。

   ---
   aws_access_key_id: secret-key-id
   aws_secret_access_key: secret-access-key
   iam_user_arn: iam-user-arn
   region: supported-region

   コードの説明は以下のとおりです。

   • secret-key-id は、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する または ステップ 3: ユーザーの認証情報を取得する でメモした、対応するIAM ユーザーのシークレットキー ID です。

   • secret-access-key は、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する または ステップ 3: ユーザーの認証情報を取得する でメモした、対応する IAM ユーザーのシークレットアクセスキーです。

   • iam-user-arn は、「ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する」で先にメモした IAM ユーザーの ARN です。

   • supported-region は、CodeDeploy でサポートされているリージョンの識別子で、CodeDeploy アプリケーション、デプロイグループ、およびアプリケーションリビジョンがある場所です (us-west-2 など)。リージョンのリストについては、「AWS 全般のリファレンス」の「リージョンエンドポイント」を参照してください。

   重要

   ステップ 3: ユーザーの認証情報を取得する の片方のアクセスキーの横にある Delete を選択し、またオンプレミスインスタンスがすでに関連するアクセスキー ID およびシークレットアクセスキーを使用している場合は、ステップ 4: オンプレミスインスタンスに設定ファイルを追加 の手順に再び従って、この IAM ユーザーと関連付けられた異なるアクセスキー ID およびシークレットアクセスキーを指定する必要があります。そうしない場合、オンプレミスインスタンスへのデプロイは、無期限の保留状態のまま、または完全にエラーとなる可能性があります。

1. AWS CLI をオンプレミスインスタンスにインストールするには、AWS CLI ユーザーガイド の Getting set up with the AWS Command Line Interface の手順に従います。

   注記

   オンプレミスインスタンスを使用するための CodeDeploy コマンドは、AWS CLI のバージョン 1.7.19 で使用できるようになりました。すでにインストールしている AWS CLI のバージョンがある場合は、aws --version コマンドを呼び出してバージョンを確認できます。

2. AWS CLI をオンプレミスインスタンス上に構成するには、AWS CLI ユーザーガイド の Configuring the AWS Command Line Interface の手順に従います。

   重要

   AWS CLI を設定する際 (例えば、aws configure のコマンドを呼び出す場合など) は、AWS で指定されているアクセス権限に加えて少なくとも以下の オンプレミスインスタンスを設定するための前提条件 のアクセス権限を持つ IIAM ユーザーのシークレットキー ID とシークレットアクセスキーを必ず指定します。これにより、オンプレミスインスタンス上で CodeDeploy エージェントをダウンロードしてインストールすることができます。

   JSON

   {
     "Version":"2012-10-17",		 	 	 
     "Statement" : [
       {
         "Effect" : "Allow",
         "Action" : [
           "codedeploy:*"
         ],
         "Resource" : "*"
       },
       {
         "Effect" : "Allow",
         "Action" : [
           "s3:Get*",
           "s3:List*"
         ],
         "Resource" : [
           "arn:aws:s3:::amzn-s3-demo-bucket/*",
           "arn:aws:s3:::amzn-s3-demo-bucket1/*"
         ]
       }     
     ]
   }
   

   JSON

   {
     "Version":"2012-10-17",		 	 	 
     "Statement" : [
       {
         "Effect" : "Allow",
         "Action" : [
           "codedeploy:*"
         ],
         "Resource" : "*"
       },
       {
         "Effect" : "Allow",
         "Action" : [
           "s3:Get*",
           "s3:List*"
         ],
         "Resource" : [
           "*"
         ]
       }     
     ]
   }
   

   これらのアクセス権限は、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する で作成した IAM ユーザー、または別のユーザーのいずれかに割り当てられることができます。これらのアクセス権限を ユーザーに割り当てるには、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する にある手順に従いますが、手順のアクセス権限の代わりにこれらのアクセス権限を使用します。

1. AWS CLI を使用する前に、ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する で作成した IAM ユーザーのユーザー ARN が必要です。ユーザー ARN がまだない場合は、get-user コマンドを呼び出し、IAM ユーザーの名前を指定し (--user-name のオプションを用いて)、ユーザー ARN のみをクエリします (--query のオプションと --output のオプションを用いて)。

   aws iam get-user --user-name CodeDeployUser-OnPrem --query "User.Arn" --output text

2. register-on-premises-instance コマンドを呼び出し、以下を指定します。

   • オンプレミスインスタンスを一意に識別する名前 (--instance-name オプションで指定)。

     重要

     オンプレミスインスタンスを識別するために、特にデバッグのため、オンプレミスインスタンスの一意な特徴を示す名前 (例えば、もしあれば、シリアルナンバーや内部アセット識別子など) を指定することを強くお勧めします。名前として MAC アドレスを指定した場合、MAC アドレスには、コロン (:) など CodeDeploy が許可しない文字が含まれることに注意してください。許可された文字の一覧については、「CodeDeploy のクォータ」を参照してください。

   • ステップ 1: オンプレミスインスタンス用に IAM ユーザーを作成する で作成した IAM ユーザーの ARN (--iam-user-arn のオプションを用いて)

     例:

     aws deploy register-on-premises-instance --instance-name AssetTag12010298EX --iam-user-arn arn:aws:iam::444455556666:user/CodeDeployUser-OnPrem

オンプレミスインスタンスにタグ付けするには (CLI)

• add-tags-to-on-premises-instances コマンドを呼び出し、以下を指定します。

  • オンプレミスインスタンスを一意に識別する名前 (--instance-names オプションで指定)。

  • 使用するオンプレミスインスタンスのタグキーの名前とタグ値 (--tags オプションで指定)。名前と値はいずれも指定する必要があります。CodeDeploy は値のみがあるオンプレミスインスタンスタグを許可しません。

    例:

    aws deploy add-tags-to-on-premises-instances --instance-names AssetTag12010298EX --tags Key=Name,Value=CodeDeployDemo-OnPrem

オンプレミスインスタンスにタグ付けするには (コンソール)

1. AWS マネジメントコンソール にサインインして、CodeDeploy コンソール https://console.aws.amazon.com/codedeploy を開きます。

   注記

   「CodeDeploy の開始方法」で設定したのと同じユーザーでサインインします。

2. CodeDeploy メニューから On-premises instances を選択します。

3. オンプレミスインスタンスのリストで、タグ付けするオンプレミスインスタンスの横にある矢印を選択します。

4. タグのリストで、目的のタグキーとタグ値を選択または入力します。タグキーとタグ値を入力するたびに、別の行が表示されます。最大 10 個のタグにこれを繰り返すことができます。タグを削除するには、削除アイコンを選択します ( )。

5. タグを追加したら、[Update Tags] を選択します。