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.

Container for the parameters to the RegisterInstance operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.OpsWorks.AmazonOpsWorksRequest
      Amazon.OpsWorks.Model.RegisterInstanceRequest

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

Syntax

C#
public class RegisterInstanceRequest : AmazonOpsWorksRequest
         IAmazonWebServiceRequest

The RegisterInstanceRequest type exposes the following members

Constructors

NameDescription
Public Method RegisterInstanceRequest()

Properties

NameTypeDescription
Public Property Hostname System.String

Gets and sets the property Hostname.

The instance's hostname.

Public Property InstanceIdentity Amazon.OpsWorks.Model.InstanceIdentity

Gets and sets the property InstanceIdentity.

An InstanceIdentity object that contains the instance's identity.

Public Property PrivateIp System.String

Gets and sets the property PrivateIp.

The instance's private IP address.

Public Property PublicIp System.String

Gets and sets the property PublicIp.

The instance's public IP address.

Public Property RsaPublicKey System.String

Gets and sets the property RsaPublicKey.

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

Public Property RsaPublicKeyFingerprint System.String

Gets and sets the property RsaPublicKeyFingerprint.

The instances public RSA key fingerprint.

Public Property StackId System.String

Gets and sets the property StackId.

The ID of the stack that the instance is to be registered with.

Version Information

.NET Standard:
Supported in: 1.3

.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