Use RegisterOnPremisesInstance with a CLI

The following code examples show how to use RegisterOnPremisesInstance.

CLI

AWS CLI

To register an on-premises instance

The following register-on-premises-instance example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance.

aws deploy register-on-premises-instance \
    --instance-name AssetTag12010298EX \
    --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem

This command produces no output.

• For API details, see RegisterOnPremisesInstance in AWS CLI Command Reference.

PowerShell

Tools for PowerShell

Example 1: This example registers an on-premises instance with the specified name and IAM user.

Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX

• For API details, see RegisterOnPremisesInstance in AWS Tools for PowerShell Cmdlet Reference.