Automatically deregister an on-premises instance - Amazon CodeDeploy
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Automatically deregister an on-premises instance

Typically, you deregister an on-premises instance after you're no longer planning to deploy to it. When you deregister an on-premises instance, even though the on-premises instance might be part of a deployment group's on-premises instance tags, the on-premises instance will not be included in any deployments. You can use the Amazon CLI to deregister on-premises instances.

Note

You cannot use the CodeDeploy console to deregister an on-premises instance. Also, deregistering an on-premises instance removes any on-premises instance tags that are associated with the on-premises instance. It does not uninstall the CodeDeploy agent from the on-premises instance. It does not remove the on-premises instance configuration file from the on-premises instance.

To use the CodeDeploy console to perform some (but not all) of the activities in this section, see the CodeDeploy console section of Manually deregister an on-premises instance.

To manually disassociate any associated on-premises instance tags, see Manually remove on-premises instance tags from an on-premises instance.

To automatically uninstall the CodeDeploy agent and remove the configuration file from the on-premises instance, see Automatically uninstall the CodeDeploy agent and remove the configuration file from an on-premises instance.

To manually uninstall only the CodeDeploy agent from the on-premises instance, see Managing CodeDeploy agent operations.

Use the Amazon CLI to call the deregister command, specifying:

  • The name that uniquely identifies the on-premises instance to CodeDeploy (with the --instance-name option).

  • Optionally, whether to delete the IAM user associated with the on-premises instance. The default behaviour is to delete the IAM user. If you do not want to delete the IAM user associated with the on-premises instance, specify the --no-delete-iam-user option in the command.

  • Optionally, the Amazon region where the on-premises instance was registered with CodeDeploy (with the --region option). This must be one of the supported regions listed in Region and endpoints in the Amazon General Reference (for example, us-west-2). If this option is not specified, the default Amazon region associated with the calling IAM user will be used.

An example that degisters an instance and deletes the user:

aws deploy deregister --instance-name AssetTag12010298EX --region us-west-2

An example that degisters an instance and does not delete the user:

aws deploy deregister --instance-name AssetTag12010298EX --no-delete-iam-user --region us-west-2

The deregister command does the following:

  1. Deregisters the on-premises instance with CodeDeploy.

  2. If specified, deletes the IAM user associated with the on-premises instance.

If this command encounters any errors, an error message appears, describing how you can manually complete the remaining steps. Otherwise, a success message appears, describing how to call the uninstall command.