Copyright	(c) 2013-2021 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

Amazonka.CodeDeploy.RegisterOnPremisesInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

Creating a Request

data RegisterOnPremisesInstance Source #

Represents the input of the register on-premises instance operation.

See: newRegisterOnPremisesInstance smart constructor.

Constructors

RegisterOnPremisesInstance'
Fields iamUserArn :: Maybe Text The ARN of the IAM user to associate with the on-premises instance. iamSessionArn :: Maybe Text The ARN of the IAM session to associate with the on-premises instance. instanceName :: Text The name of the on-premises instance to register.

Instances

Instances details

Eq RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods (==) :: RegisterOnPremisesInstance -> RegisterOnPremisesInstance -> Bool # (/=) :: RegisterOnPremisesInstance -> RegisterOnPremisesInstance -> Bool #
Read RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods readsPrec :: Int -> ReadS RegisterOnPremisesInstance # readList :: ReadS [RegisterOnPremisesInstance] # readPrec :: ReadPrec RegisterOnPremisesInstance # readListPrec :: ReadPrec [RegisterOnPremisesInstance] #
Show RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods showsPrec :: Int -> RegisterOnPremisesInstance -> ShowS # show :: RegisterOnPremisesInstance -> String # showList :: [RegisterOnPremisesInstance] -> ShowS #
Generic RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Associated Types type Rep RegisterOnPremisesInstance :: Type -> Type # Methods from :: RegisterOnPremisesInstance -> Rep RegisterOnPremisesInstance x # to :: Rep RegisterOnPremisesInstance x -> RegisterOnPremisesInstance #
NFData RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods rnf :: RegisterOnPremisesInstance -> () #
Hashable RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods hashWithSalt :: Int -> RegisterOnPremisesInstance -> Int # hash :: RegisterOnPremisesInstance -> Int #
ToJSON RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods toJSON :: RegisterOnPremisesInstance -> Value # toEncoding :: RegisterOnPremisesInstance -> Encoding # toJSONList :: [RegisterOnPremisesInstance] -> Value # toEncodingList :: [RegisterOnPremisesInstance] -> Encoding #
AWSRequest RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Associated Types type AWSResponse RegisterOnPremisesInstance # Methods request :: RegisterOnPremisesInstance -> Request RegisterOnPremisesInstance # response :: MonadResource m => Logger -> Service -> Proxy RegisterOnPremisesInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterOnPremisesInstance))) #
ToHeaders RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods toHeaders :: RegisterOnPremisesInstance -> [Header] #
ToPath RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods toPath :: RegisterOnPremisesInstance -> ByteString #
ToQuery RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods toQuery :: RegisterOnPremisesInstance -> QueryString #
type Rep RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance type Rep RegisterOnPremisesInstance = D1 ('MetaData "RegisterOnPremisesInstance" "Amazonka.CodeDeploy.RegisterOnPremisesInstance" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "RegisterOnPremisesInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "iamUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "iamSessionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterOnPremisesInstance Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance type AWSResponse RegisterOnPremisesInstance = RegisterOnPremisesInstanceResponse

newRegisterOnPremisesInstance Source #

Arguments

:: Text	`$sel:instanceName:RegisterOnPremisesInstance'`
-> RegisterOnPremisesInstance

Create a value of RegisterOnPremisesInstance 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:

$sel:iamUserArn:RegisterOnPremisesInstance', registerOnPremisesInstance_iamUserArn - The ARN of the IAM user to associate with the on-premises instance.

$sel:iamSessionArn:RegisterOnPremisesInstance', registerOnPremisesInstance_iamSessionArn - The ARN of the IAM session to associate with the on-premises instance.

$sel:instanceName:RegisterOnPremisesInstance', registerOnPremisesInstance_instanceName - The name of the on-premises instance to register.

Request Lenses

registerOnPremisesInstance_iamUserArn :: Lens' RegisterOnPremisesInstance (Maybe Text) Source #

The ARN of the IAM user to associate with the on-premises instance.

registerOnPremisesInstance_iamSessionArn :: Lens' RegisterOnPremisesInstance (Maybe Text) Source #

The ARN of the IAM session to associate with the on-premises instance.

registerOnPremisesInstance_instanceName :: Lens' RegisterOnPremisesInstance Text Source #

The name of the on-premises instance to register.

Destructuring the Response

data RegisterOnPremisesInstanceResponse Source #

See: newRegisterOnPremisesInstanceResponse smart constructor.

Constructors

RegisterOnPremisesInstanceResponse'

Instances

Instances details

Eq RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods (==) :: RegisterOnPremisesInstanceResponse -> RegisterOnPremisesInstanceResponse -> Bool # (/=) :: RegisterOnPremisesInstanceResponse -> RegisterOnPremisesInstanceResponse -> Bool #
Read RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods readsPrec :: Int -> ReadS RegisterOnPremisesInstanceResponse # readList :: ReadS [RegisterOnPremisesInstanceResponse] # readPrec :: ReadPrec RegisterOnPremisesInstanceResponse # readListPrec :: ReadPrec [RegisterOnPremisesInstanceResponse] #
Show RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods showsPrec :: Int -> RegisterOnPremisesInstanceResponse -> ShowS # show :: RegisterOnPremisesInstanceResponse -> String # showList :: [RegisterOnPremisesInstanceResponse] -> ShowS #
Generic RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Associated Types type Rep RegisterOnPremisesInstanceResponse :: Type -> Type # Methods from :: RegisterOnPremisesInstanceResponse -> Rep RegisterOnPremisesInstanceResponse x # to :: Rep RegisterOnPremisesInstanceResponse x -> RegisterOnPremisesInstanceResponse #
NFData RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance Methods rnf :: RegisterOnPremisesInstanceResponse -> () #
type Rep RegisterOnPremisesInstanceResponse Source #
Instance details Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance type Rep RegisterOnPremisesInstanceResponse = D1 ('MetaData "RegisterOnPremisesInstanceResponse" "Amazonka.CodeDeploy.RegisterOnPremisesInstance" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "RegisterOnPremisesInstanceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRegisterOnPremisesInstanceResponse :: RegisterOnPremisesInstanceResponse Source #

Create a value of RegisterOnPremisesInstanceResponse with all optional fields omitted.

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