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