CodeDeploy エージェント設定リファレンス

:log_aws_wire:

true CodeDeploy エージェントが Amazon S3 からワイヤログをキャプチャし、:log_dir: 設定で指定された場所のログファイルに書き込むには、 に設定します。

バージョン 2.0.x 以降では、ファイル名は codedeploy-agent.aws_wire.log (0640 アクセス許可で作成) です。

バージョン 1.8.x 以前では、ファイル名は ですcodedeploy-agent.wire.log。

デフォルトの設定は false です。

この設定は、すべてのインスタンスタイプに適用されます。この設定を使用できるようにするには、この設定を Windows サーバーインスタンスに追加する必要があります。

:log_dir:

CodeDeploy エージェントオペレーションに関連するログファイルが保存されるインスタンスのフォルダ。

デフォルトの設定は、Amazon Linux、Ubuntu Server、RHEL インスタンス用の '/var/log/aws/codedeploy-agent'、および Windows Server インスタンス用の C:\ProgramData\Amazon\CodeDeploy\log です。

:pid_dir:

codedeploy-agent.pid が保存されているフォルダ。

このファイルには、CodeDeploy エージェントのプロセス ID (PID) が含まれます。デフォルトの設定は '/opt/codedeploy-agent/state/.pid' です。

この設定は、Amazon Linux、Ubuntu Server、RHEL インスタンスにのみ適用されます。

:program_name:

CodeDeploy エージェントのプログラム名。

デフォルトの設定は codedeploy-agent です。

この設定は、Amazon Linux、Ubuntu Server、RHEL インスタンスにのみ適用されます。

:root_dir:

関連するリビジョン、デプロイ履歴、およびインスタンスのデプロイスクリプトが保存されるフォルダ。

デフォルトの設定は、Amazon Linux、Ubuntu Server、RHEL インスタンス用の /opt/codedeploy-agent/deployment-root、および Windows Server インスタンス用の C:\ProgramData\Amazon\CodeDeploy です。

:verbose:

CodeDeploy エージェントでインスタンスのデバッグメッセージログファイルを表示する場合は、true に設定します。

デフォルトの設定は false です。

:wait_between_runs:

保留中のデプロイに対する CodeDeploy エージェントによる CodeDeploy のポーリング間隔 (秒単位)。

バージョン 2.0.x 以降では、デフォルト設定は です30。

バージョン 1.8.x 以前では、デフォルト設定は です1。

:on_premises_config_file:

オンプレミスインスタンスの場合、codedeploy.onpremises.yml ( Ubuntu Server および RHEL の場合)、または conf.onpremises.yml (Windows Server の場合) という名前の設定ファイルの別の場所へのパスです。

デフォルトでは、これらのファイルは Ubuntu Server および RHEL の場合は /etc/codedeploy-agent/conf/codedeploy.onpremises.yml、 Windows Server の場合は C:\ProgramData\Amazon\CodeDeployconf.onpremises.yml に保存されます。

バージョン 1.0.1.686 以降のバージョンの CodeDeploy エージェントで利用できます。

:proxy_uri:

(オプション) CodeDeploy エージェントが CodeDeploy オペレーション AWS のために に接続する HTTP CodeDeploy プロキシ。https://user:password@my.proxy:443/path?query のような形式を使用します。

バージョン 1.0.1.824 以降のバージョンの CodeDeploy エージェントで利用できます。

:max_revisions:

(オプション) CodeDeploy エージェントでアーカイブするデプロイグループ用のアプリケーションリビジョンの数。指定された数を超えるリビジョンは削除されます。

正の整数を入力します。値を指定しない場合、CodeDeploy は現在デプロイされたリビジョンに加えて 5 つの最新のリビジョンを保持します。

バージョン 1.0.1.966 以降のバージョンの CodeDeploy エージェント でサポートされます。

:enable_auth_policy:

(オプション) IAM 認可 を使用して、アクセスコントロールを設定し、CodeDeploy エージェントが使用している IAM ロールまたはユーザーのアクセス許可を制限する場合に true に設定します。Amazon Virtual Private Cloud で CodeDeploy を使用 にするには、この値は、true である必要があります。

デフォルトの設定は false です。

:disable_imds_v1:

この設定は、CodeDeploy エージェント 1.7.0 以降で使用できます。

IMDSv2 エラーが発生したときに IMDSv1 へのフォールバックを無効にするには、true に設定します。デフォルトは false です (フォールバックを有効にします）。

:disable_core_dumps:

バージョン 2.0.x 以降。

コアダンプtrueを抑制するには、 に設定します。クラッシュ調査falseのために を に設定します。

デフォルトの設定は true です。

:enable_command_port:

バージョン 2.0.x 以降。

エージェントのステータスをクエリしtrue、コマンドをローカルに挿入するためのループバック専用 (127.0.0.1) ローカル管理インターフェイスを有効にするには、 に設定します。

デフォルトの設定は false です。

:reject_symlinks_in_bundle:

バージョン 2.0.x 以降。

シンボリックリンクまたはハードリンクを含むバンドルを拒否trueするには、 に設定します。

デフォルトの設定は false です。

:reject_path_traversal_in_bundle:

バージョン 2.0.x 以降。

に設定するとtrue、../パストラバーサルまたは絶対パスを含むアーカイブエントリと、バンドルルートをエスケープする AppSpec ソースフィールドが拒否されます。

デフォルトの設定は false です。

:reject_unsafe_permissions_in_bundle:

バージョン 2.0.x 以降。

SUID/SGID ファイルまたは SUID/SGID を設定する AppSpec アクセス許可モードを含むバンドルを拒否trueするには、 に設定します。

デフォルトの設定は false です。

:reject_unconfined_selinux_in_bundle:

バージョン 2.0.x 以降。

に設定するとtrue、SELinux タイプを MAC で無効にするファイルを含むバンドルが拒否されます。

デフォルトの設定は false です。

:reject_symlink_permission_targets:

バージョン 2.0.x 以降。

に設定するtrueと、ターゲットがシンボリックリンクである AppSpec ファイルpermissionsエントリが拒否されます。デフォルトでは、エージェントは所有権、モード、ACL、および SELinux の変更を適用するときにリンクに従います。

デフォルトの設定は false です。

:ignore_ownership_in_bundle:

バージョン 2.0.x 以降。

アーカイブに記録されたユーザー ID tar とグループ ID を適用するroot代わりに、 と tgzバンドルから抽出されたファイルの所有権を にリセットtrueするには、 に設定します。zip バンドル内のファイルは、この設定rootに関係なく によって所有されます。

デフォルトの設定は false です。

:restrict_agent_dir_permissions:

バージョン 2.0.x 以降。Linux インスタンスのみ。

に設定するとtrue、エージェントインストールルートのディレクトリとファイルが、デフォルトで使用されているワールド読み取りモードではなく、ルートのみのアクセスに制限されます。

デフォルトの設定は false です。

:restrict_log_dir_permissions:

バージョン 2.0.x 以降。Linux インスタンスのみ。

true に設定すると、エージェントログとアップデーターログを含むエージェントログディレクトリが、デフォルトで使用されているワールド読み取りモードではなく、ルートのみのアクセスに制限されます。

デフォルトの設定は false です。

:restrict_hook_env_to_allowlist:

バージョン 2.0.x 以降。

基本シェル変数と CodeDeploy デプロイ変数のみを含む最小限の環境でライフサイクルイベントフックを実行するtrueには、 に設定します。デフォルトでは、フックはエージェントプロセスの完全な環境を継承します。

デフォルトの設定は false です。

:strip_loader_env_in_hooks:

バージョン 2.0.x 以降。Linux インスタンスのみ。

true ライフサイクルイベントフックの環境から LD_PRELOAD、LD_LIBRARY_PATH、および LD_AUDIT変数を削除するには、 に設定します。

デフォルトの設定は false です。

:disable_powershell_profile_in_hooks:

バージョン 2.0.x 以降。Windows Server インスタンスのみ。

および -NoProfile-NonInteractiveオプションを使用して.ps1ライフサイクルイベントフックを実行するtrueには、 に設定します。デフォルトでは、これらのフックはエージェントが実行するユーザーの PowerShell プロファイルをロードします。

デフォルトの設定は false です。

:archive_max_extraction_size:

バージョン 2.0.x 以降。

宣言された非圧縮バンドルサイズの上限を設定します。抽出されたコンテンツがこの値を超えると、デプロイは失敗します。

デフォルトは上限なし (無制限) です。

:wait_after_error:

エラーが発生してから通常のオペレーションを再開するまでにエージェントが待機する秒数。

デフォルトの設定は 30 です。

:http_read_timeout:

サービス API コールの秒単位の HTTP 読み取りタイムアウト。

デフォルトの設定は 80 です。

:kill_agent_max_wait_time_seconds:

強制終了するまでエージェントが正常なシャットダウンを待機する最大秒数。バージョン 2.0.x 以降では、この値は 24 時間 (86400 秒) に制限されます。

デフォルト設定は 7200 (2 時間) です。

:enable_deployments_log:

を に設定trueして、集約されたデプロイログ () を書き込みますcodedeploy-agent-deployments.log。

デフォルトの設定は true です。

:use_fips_mode:

FIPS 準拠のエンドポイントtrueを使用するには、 に設定します。米国リージョンにのみ適用されます。

デフォルトの設定は false です。

:deploy_control_endpoint:

(オプション) CodeDeploy サービスのカスタムコントロールプレーンエンドポイント URL。

デフォルトは上書きされません (エージェントはリージョンからエンドポイントを解決します）。

:s3_endpoint_override:

(オプション) バンドルダウンロード用のカスタム Amazon S3 エンドポイント URL。

デフォルトは上書きされません (エージェントはリージョンから Amazon S3 エンドポイントを解決します）。

:ongoing_deployment_tracking:

デプロイの追跡状態に使用されるサブディレクトリの名前。

デフォルトの設定は ongoing-deployment です。