/AWS1/CL_OWX=>REGISTERINSTANCE()¶
About RegisterInstance¶
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. RegisterInstance 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 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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_STACKID TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The ID of the stack that the instance is to be registered with.
Optional arguments:¶
IV_HOSTNAME TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The instance's host name. The following are character limits for instance host names.
Linux-based instances: 63 characters
Windows-based instances: 15 characters
IV_PUBLICIP TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The instance's public IP address.
IV_PRIVATEIP TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The instance's private IP address.
IV_RSAPUBLICKEY TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
IV_RSAPUBLICKEYFINGERPRINT TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING¶
The instances public RSA key fingerprint.
IO_INSTANCEIDENTITY TYPE REF TO /AWS1/CL_OWXINSTANCEIDENTITY /AWS1/CL_OWXINSTANCEIDENTITY¶
An InstanceIdentity object that contains the instance's identity.