Skip to content

Register Instance

opsworks_register_instance R Documentation

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

Description

Registers instances that were created outside of 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 OpsWorks Stacks agent on the instance, and registering the instance with the stack. register_instance handles only the second step. You should instead use the CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the create_instance 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.

Usage

opsworks_register_instance(StackId, Hostname, PublicIp, PrivateIp,
  RsaPublicKey, RsaPublicKeyFingerprint, InstanceIdentity)

Arguments

StackId

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

Hostname

The instance's host name. The following are character limits for instance host names.

  • Linux-based instances: 63 characters

  • Windows-based instances: 15 characters

PublicIp

The instance's public IP address.

PrivateIp

The instance's private IP address.

RsaPublicKey

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

RsaPublicKeyFingerprint

The instances public RSA key fingerprint.

InstanceIdentity

An InstanceIdentity object that contains the instance's identity.

Value

A list with the following syntax: 

list(
  InstanceId = "string"
)

Request syntax

svc$register_instance(
  StackId = "string",
  Hostname = "string",
  PublicIp = "string",
  PrivateIp = "string",
  RsaPublicKey = "string",
  RsaPublicKeyFingerprint = "string",
  InstanceIdentity = list(
    Document = "string",
    Signature = "string"
  )
)