AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Note:

For PCL this operation is only available in asynchronous form. Please refer to RegisterInstanceAsync.

Namespace: Amazon.OpsWorks
Assembly: AWSSDK.OpsWorks.dll
Version: 3.x.y.z

Syntax

C#
public virtual RegisterInstanceResponse RegisterInstance(
         RegisterInstanceRequest request
)
Parameters
request
Type: Amazon.OpsWorks.Model.RegisterInstanceRequest

Container for the necessary parameters to execute the RegisterInstance service method.

Return Value
The response from the RegisterInstance service method, as returned by OpsWorks.

Exceptions

ExceptionCondition
ResourceNotFoundException Indicates that a resource was not found.
ValidationException Indicates that a request was not valid.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also