Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorks.RegisterInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers instances that were created outside of AWS 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 AWS OpsWorks Stacks 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 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.

Synopsis

data RegisterInstance = RegisterInstance' {
- hostname :: Maybe Text
- instanceIdentity :: Maybe InstanceIdentity
- privateIp :: Maybe Text
- publicIp :: Maybe Text
- rsaPublicKey :: Maybe Text
- rsaPublicKeyFingerprint :: Maybe Text
- stackId :: Text
}
newRegisterInstance :: Text -> RegisterInstance
registerInstance_hostname :: Lens' RegisterInstance (Maybe Text)
registerInstance_instanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity)
registerInstance_privateIp :: Lens' RegisterInstance (Maybe Text)
registerInstance_publicIp :: Lens' RegisterInstance (Maybe Text)
registerInstance_rsaPublicKey :: Lens' RegisterInstance (Maybe Text)
registerInstance_rsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text)
registerInstance_stackId :: Lens' RegisterInstance Text
data RegisterInstanceResponse = RegisterInstanceResponse' {
- instanceId :: Maybe Text
- httpStatus :: Int
}
newRegisterInstanceResponse :: Int -> RegisterInstanceResponse
registerInstanceResponse_instanceId :: Lens' RegisterInstanceResponse (Maybe Text)
registerInstanceResponse_httpStatus :: Lens' RegisterInstanceResponse Int

Creating a Request

data RegisterInstance Source #

See: newRegisterInstance smart constructor.

Constructors

RegisterInstance'

Fields

hostname :: Maybe Text
The instance's hostname.
instanceIdentity :: Maybe InstanceIdentity
An InstanceIdentity object that contains the instance's identity.
privateIp :: Maybe Text
The instance's private IP address.
publicIp :: Maybe Text
The instance's public IP address.
rsaPublicKey :: Maybe Text
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
rsaPublicKeyFingerprint :: Maybe Text
The instances public RSA key fingerprint.
stackId :: Text
The ID of the stack that the instance is to be registered with.

Instances

Instances details

ToJSON RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods toJSON :: RegisterInstance -> Value # toEncoding :: RegisterInstance -> Encoding # toJSONList :: [RegisterInstance] -> Value # toEncodingList :: [RegisterInstance] -> Encoding #
ToHeaders RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods toHeaders :: RegisterInstance -> [Header] #
ToPath RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods toPath :: RegisterInstance -> ByteString #
ToQuery RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods toQuery :: RegisterInstance -> QueryString #
AWSRequest RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Associated Types type AWSResponse RegisterInstance # Methods request :: (Service -> Service) -> RegisterInstance -> Request RegisterInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterInstance))) #
Generic RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Associated Types type Rep RegisterInstance :: Type -> Type # Methods from :: RegisterInstance -> Rep RegisterInstance x # to :: Rep RegisterInstance x -> RegisterInstance #
Read RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods readsPrec :: Int -> ReadS RegisterInstance # readList :: ReadS [RegisterInstance] # readPrec :: ReadPrec RegisterInstance # readListPrec :: ReadPrec [RegisterInstance] #
Show RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods showsPrec :: Int -> RegisterInstance -> ShowS # show :: RegisterInstance -> String # showList :: [RegisterInstance] -> ShowS #
NFData RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods rnf :: RegisterInstance -> () #
Eq RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods (==) :: RegisterInstance -> RegisterInstance -> Bool # (/=) :: RegisterInstance -> RegisterInstance -> Bool #
Hashable RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods hashWithSalt :: Int -> RegisterInstance -> Int # hash :: RegisterInstance -> Int #
type AWSResponse RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance type AWSResponse RegisterInstance = RegisterInstanceResponse
type Rep RegisterInstance Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance type Rep RegisterInstance = D1 ('MetaData "RegisterInstance" "Amazonka.OpsWorks.RegisterInstance" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "RegisterInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceIdentity)) :: S1 ('MetaSel ('Just "privateIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "publicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "rsaPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "rsaPublicKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRegisterInstance Source #

Arguments

:: Text	`RegisterInstance`
-> RegisterInstance

Create a value of RegisterInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterInstance, registerInstance_hostname - The instance's hostname.

$sel:instanceIdentity:RegisterInstance', registerInstance_instanceIdentity - An InstanceIdentity object that contains the instance's identity.

RegisterInstance, registerInstance_privateIp - The instance's private IP address.

RegisterInstance, registerInstance_publicIp - The instance's public IP address.

$sel:rsaPublicKey:RegisterInstance', registerInstance_rsaPublicKey - The instances public RSA key. This key is used to encrypt communication between the instance and the service.

$sel:rsaPublicKeyFingerprint:RegisterInstance', registerInstance_rsaPublicKeyFingerprint - The instances public RSA key fingerprint.

RegisterInstance, registerInstance_stackId - The ID of the stack that the instance is to be registered with.

Request Lenses

registerInstance_hostname :: Lens' RegisterInstance (Maybe Text) Source #

The instance's hostname.

registerInstance_instanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity) Source #

An InstanceIdentity object that contains the instance's identity.

registerInstance_privateIp :: Lens' RegisterInstance (Maybe Text) Source #

The instance's private IP address.

registerInstance_publicIp :: Lens' RegisterInstance (Maybe Text) Source #

The instance's public IP address.

registerInstance_rsaPublicKey :: Lens' RegisterInstance (Maybe Text) Source #

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

registerInstance_rsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text) Source #

The instances public RSA key fingerprint.

registerInstance_stackId :: Lens' RegisterInstance Text Source #

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

Destructuring the Response

data RegisterInstanceResponse Source #

Contains the response to a RegisterInstanceResult request.

See: newRegisterInstanceResponse smart constructor.

Constructors

RegisterInstanceResponse'
Fields instanceId :: Maybe Text The registered instance's AWS OpsWorks Stacks ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Associated Types type Rep RegisterInstanceResponse :: Type -> Type # Methods from :: RegisterInstanceResponse -> Rep RegisterInstanceResponse x # to :: Rep RegisterInstanceResponse x -> RegisterInstanceResponse #
Read RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods readsPrec :: Int -> ReadS RegisterInstanceResponse # readList :: ReadS [RegisterInstanceResponse] # readPrec :: ReadPrec RegisterInstanceResponse # readListPrec :: ReadPrec [RegisterInstanceResponse] #
Show RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods showsPrec :: Int -> RegisterInstanceResponse -> ShowS # show :: RegisterInstanceResponse -> String # showList :: [RegisterInstanceResponse] -> ShowS #
NFData RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods rnf :: RegisterInstanceResponse -> () #
Eq RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance Methods (==) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool # (/=) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool #
type Rep RegisterInstanceResponse Source #
Instance details Defined in Amazonka.OpsWorks.RegisterInstance type Rep RegisterInstanceResponse = D1 ('MetaData "RegisterInstanceResponse" "Amazonka.OpsWorks.RegisterInstance" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "RegisterInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterInstanceResponse'`
-> RegisterInstanceResponse

Create a value of RegisterInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterInstanceResponse, registerInstanceResponse_instanceId - The registered instance's AWS OpsWorks Stacks ID.

$sel:httpStatus:RegisterInstanceResponse', registerInstanceResponse_httpStatus - The response's http status code.

Response Lenses

registerInstanceResponse_instanceId :: Lens' RegisterInstanceResponse (Maybe Text) Source #

The registered instance's AWS OpsWorks Stacks ID.

registerInstanceResponse_httpStatus :: Lens' RegisterInstanceResponse Int Source #

The response's http status code.