OpsWorks / Client / register_instance

register_instance#

OpsWorks.Client.register_instance(**kwargs)#

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

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.register_instance(
    StackId='string',
    Hostname='string',
    PublicIp='string',
    PrivateIp='string',
    RsaPublicKey='string',
    RsaPublicKeyFingerprint='string',
    InstanceIdentity={
        'Document': 'string',
        'Signature': 'string'
    }
)
Parameters:

  • StackId (string) –

    [REQUIRED]

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

  • Hostname (string) –

    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 (string) – The instance’s public IP address.

  • PrivateIp (string) – The instance’s private IP address.

  • RsaPublicKey (string) – The instances public RSA key. This key is used to encrypt communication between the instance and the service.

  • RsaPublicKeyFingerprint (string) – The instances public RSA key fingerprint.

  • InstanceIdentity (dict) –

    An InstanceIdentity object that contains the instance’s identity.

    • Document (string) –

      A JSON document that contains the metadata.

    • Signature (string) –

      A signature that can be used to verify the document’s accuracy and authenticity.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceId': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a RegisterInstanceResult request.

    • InstanceId (string) –

      The registered instance’s OpsWorks Stacks ID.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException