AmazonOpsWorksClient.RegisterInstanceAsync Method (RegisterInstanceRequest, CancellationToken)

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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRegisterInstance and EndRegisterInstance.

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

Syntax

public virtual Task<RegisterInstanceResponse> RegisterInstanceAsync(
         RegisterInstanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request: Type: Amazon.OpsWorks.Model.RegisterInstanceRequest

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

cancellationToken: Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

Type: Task<RegisterInstanceResponse>

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

Exceptions

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

AmazonOpsWorksClient.RegisterInstanceAsync (RegisterInstanceRequest, CancellationToken)

Method

Syntax

Parameters

Return Value

Exceptions

Version Information

See Also