Network.AWS.OpsWorks.RegisterInstance

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

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks 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 Stack.

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: AWS API Reference for RegisterInstance.

Creating a Request

registerInstance

Arguments

:: Text

riStackId

-> RegisterInstance

Creates a value of RegisterInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• riPrivateIP
• riHostname
• riInstanceIdentity
• riPublicIP
• riRsaPublicKeyFingerprint
• riRsaPublicKey
• riStackId

data RegisterInstance

See: registerInstance smart constructor.

Instances

Eq RegisterInstance

Data RegisterInstance

Read RegisterInstance

Show RegisterInstance

Generic RegisterInstance

ToJSON RegisterInstance

AWSRequest RegisterInstance

ToPath RegisterInstance

ToHeaders RegisterInstance

ToQuery RegisterInstance

Typeable * RegisterInstance

type Rep RegisterInstance

type Rs RegisterInstance = RegisterInstanceResponse

Request Lenses

riPrivateIP :: Lens' RegisterInstance (Maybe Text)

The instance's private IP address.

riHostname :: Lens' RegisterInstance (Maybe Text)

The instance's hostname.

riInstanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity)

An InstanceIdentity object that contains the instance's identity.

riPublicIP :: Lens' RegisterInstance (Maybe Text)

The instance's public IP address.

riRsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text)

The instances public RSA key fingerprint.

riRsaPublicKey :: Lens' RegisterInstance (Maybe Text)

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

riStackId :: Lens' RegisterInstance Text

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

Destructuring the Response

registerInstanceResponse

Arguments

:: Int

rirsStatus

-> RegisterInstanceResponse

Creates a value of RegisterInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rirsInstanceId
• rirsStatus

data RegisterInstanceResponse

Contains the response to a RegisterInstanceResult request.

See: registerInstanceResponse smart constructor.

Instances

Eq RegisterInstanceResponse

Data RegisterInstanceResponse

Read RegisterInstanceResponse

Show RegisterInstanceResponse

Generic RegisterInstanceResponse

Typeable * RegisterInstanceResponse

type Rep RegisterInstanceResponse

Response Lenses

rirsInstanceId :: Lens' RegisterInstanceResponse (Maybe Text)

The registered instance's AWS OpsWorks ID.

rirsStatus :: Lens' RegisterInstanceResponse Int

The response status code.