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.

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

Methods

(==) :: RegisterInstance -> RegisterInstance -> Bool

(/=) :: RegisterInstance -> RegisterInstance -> Bool

Data RegisterInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterInstance -> c RegisterInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterInstance

toConstr :: RegisterInstance -> Constr

dataTypeOf :: RegisterInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterInstance)

gmapT :: (forall b. Data b => b -> b) -> RegisterInstance -> RegisterInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterInstance -> m RegisterInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterInstance -> m RegisterInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterInstance -> m RegisterInstance

Read RegisterInstance

Methods

readsPrec :: Int -> ReadS RegisterInstance

readList :: ReadS [RegisterInstance]

readPrec :: ReadPrec RegisterInstance

readListPrec :: ReadPrec [RegisterInstance]

Show RegisterInstance

Methods

showsPrec :: Int -> RegisterInstance -> ShowS

show :: RegisterInstance -> String

showList :: [RegisterInstance] -> ShowS

Generic RegisterInstance

Associated Types

type Rep RegisterInstance :: * -> *

Methods

from :: RegisterInstance -> Rep RegisterInstance x

to :: Rep RegisterInstance x -> RegisterInstance

Hashable RegisterInstance

Methods

hashWithSalt :: Int -> RegisterInstance -> Int

hash :: RegisterInstance -> Int

ToJSON RegisterInstance

Methods

toJSON :: RegisterInstance -> Value

toEncoding :: RegisterInstance -> Encoding

toJSONList :: [RegisterInstance] -> Value

toEncodingList :: [RegisterInstance] -> Encoding

NFData RegisterInstance

Methods

rnf :: RegisterInstance -> ()

AWSRequest RegisterInstance

Associated Types

type Rs RegisterInstance :: *

Methods

request :: RegisterInstance -> Request RegisterInstance

response :: MonadResource m => Logger -> Service -> Proxy * RegisterInstance -> ClientResponse -> m (Response RegisterInstance)

ToQuery RegisterInstance

Methods

toQuery :: RegisterInstance -> QueryString

ToPath RegisterInstance

Methods

toPath :: RegisterInstance -> ByteString

ToHeaders RegisterInstance

Methods

toHeaders :: RegisterInstance -> [Header]

type Rep RegisterInstance

type Rep RegisterInstance = D1 (MetaData "RegisterInstance" "Network.AWS.OpsWorks.RegisterInstance" "amazonka-opsworks-1.4.3-BeJH4daCH1TAzAUbiglv2L" False) (C1 (MetaCons "RegisterInstance'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_riPrivateIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_riHostname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_riInstanceIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InstanceIdentity))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_riPublicIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_riRsaPublicKeyFingerprint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_riRsaPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_riStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs 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

rirsResponseStatus

-> 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
• rirsResponseStatus

data RegisterInstanceResponse

Contains the response to a RegisterInstanceResult request.

See: registerInstanceResponse smart constructor.

Instances

Eq RegisterInstanceResponse

Methods

(==) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool

(/=) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool

Data RegisterInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterInstanceResponse -> c RegisterInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterInstanceResponse

toConstr :: RegisterInstanceResponse -> Constr

dataTypeOf :: RegisterInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterInstanceResponse -> RegisterInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterInstanceResponse -> m RegisterInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterInstanceResponse -> m RegisterInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterInstanceResponse -> m RegisterInstanceResponse

Read RegisterInstanceResponse

Methods

readsPrec :: Int -> ReadS RegisterInstanceResponse

readList :: ReadS [RegisterInstanceResponse]

readPrec :: ReadPrec RegisterInstanceResponse

readListPrec :: ReadPrec [RegisterInstanceResponse]

Show RegisterInstanceResponse

Methods

showsPrec :: Int -> RegisterInstanceResponse -> ShowS

show :: RegisterInstanceResponse -> String

showList :: [RegisterInstanceResponse] -> ShowS

Generic RegisterInstanceResponse

Associated Types

type Rep RegisterInstanceResponse :: * -> *

Methods

from :: RegisterInstanceResponse -> Rep RegisterInstanceResponse x

to :: Rep RegisterInstanceResponse x -> RegisterInstanceResponse

NFData RegisterInstanceResponse

Methods

rnf :: RegisterInstanceResponse -> ()

type Rep RegisterInstanceResponse

type Rep RegisterInstanceResponse = D1 (MetaData "RegisterInstanceResponse" "Network.AWS.OpsWorks.RegisterInstance" "amazonka-opsworks-1.4.3-BeJH4daCH1TAzAUbiglv2L" False) (C1 (MetaCons "RegisterInstanceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rirsInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

rirsInstanceId :: Lens' RegisterInstanceResponse (Maybe Text)

The registered instance's AWS OpsWorks ID.

rirsResponseStatus :: Lens' RegisterInstanceResponse Int

The response status code.