Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deploy ]

install

Description

Configures and installs the AWS CodeDeploy Agent on the on-premises instance.

See 'aws help' for descriptions of global parameters.

Synopsis

  install
--config-file <path>
[--override-config]
[--agent-installer <s3-location>]

Options

--config-file (string) Required. The path to the on-premises instance configuration file.

--override-config (boolean) Optional. Overrides the on-premises instance configuration file.

--agent-installer (string) Optional. The AWS CodeDeploy Agent installer file.

See 'aws help' for descriptions of global parameters.

Examples

To install an on-premises instance

The following install example copies the on-premises configuration file from the specified location on the instance to the location on the instance that the AWS CodeDeploy Agent expects to find it. It also installs the AWS CodeDeploy Agent on the instance. It does not create any IAM user, nor register the on-premises instance with AWS CodeDeploy, nor associate any on-premises instance tags in AWS CodeDeploy for the instance.

aws deploy install \
    --override-config \
    --config-file C:\temp\codedeploy.onpremises.yml \
    --region us-west-2 \
    --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi

Output:

Creating the on-premises instance configuration file... DONE
Installing the AWS CodeDeploy Agent... DONE