Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- registerInstance :: Text -> RegisterInstance
- data RegisterInstance
- riPrivateIP :: Lens' RegisterInstance (Maybe Text)
- riHostname :: Lens' RegisterInstance (Maybe Text)
- riInstanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity)
- riPublicIP :: Lens' RegisterInstance (Maybe Text)
- riRsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text)
- riRsaPublicKey :: Lens' RegisterInstance (Maybe Text)
- riStackId :: Lens' RegisterInstance Text
- registerInstanceResponse :: Int -> RegisterInstanceResponse
- data RegisterInstanceResponse
- rirsInstanceId :: Lens' RegisterInstanceResponse (Maybe Text)
- rirsResponseStatus :: Lens' RegisterInstanceResponse Int
Creating a Request
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:
data RegisterInstance Source
See: registerInstance
smart constructor.
Request Lenses
riPrivateIP :: Lens' RegisterInstance (Maybe Text) Source
The instance's private IP address.
riHostname :: Lens' RegisterInstance (Maybe Text) Source
The instance's hostname.
riInstanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity) Source
An InstanceIdentity object that contains the instance's identity.
riPublicIP :: Lens' RegisterInstance (Maybe Text) Source
The instance's public IP address.
riRsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text) Source
The instances public RSA key fingerprint.
riRsaPublicKey :: Lens' RegisterInstance (Maybe Text) Source
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
riStackId :: Lens' RegisterInstance Text Source
The ID of the stack that the instance is to be registered with.
Destructuring the Response
registerInstanceResponse Source
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:
data RegisterInstanceResponse Source
Contains the response to a RegisterInstanceResult
request.
See: registerInstanceResponse
smart constructor.
Response Lenses
rirsInstanceId :: Lens' RegisterInstanceResponse (Maybe Text) Source
The registered instance's AWS OpsWorks ID.
rirsResponseStatus :: Lens' RegisterInstanceResponse Int Source
The response status code.