[ 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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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