Amazonka.CodeDeploy.RegisterOnPremisesInstance

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

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

See: newRegisterOnPremisesInstance smart constructor.

Constructors

RegisterOnPremisesInstance'

Fields

• iamSessionArn :: Maybe Text

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

• iamUserArn :: Maybe Text

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

• instanceName :: Text

  The name of the on-premises instance to register.

Instances

ToJSON RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

toJSON :: RegisterOnPremisesInstance -> Value

toEncoding :: RegisterOnPremisesInstance -> Encoding

toJSONList :: [RegisterOnPremisesInstance] -> Value

toEncodingList :: [RegisterOnPremisesInstance] -> Encoding

ToHeaders RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

toHeaders :: RegisterOnPremisesInstance -> [Header]

ToPath RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

toPath :: RegisterOnPremisesInstance -> ByteString

ToQuery RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

toQuery :: RegisterOnPremisesInstance -> QueryString

AWSRequest RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Associated Types

type AWSResponse RegisterOnPremisesInstance

Methods

request :: (Service -> Service) -> RegisterOnPremisesInstance -> Request RegisterOnPremisesInstance

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterOnPremisesInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterOnPremisesInstance)))

Generic RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Associated Types

type Rep RegisterOnPremisesInstance :: Type -> Type

Methods

from :: RegisterOnPremisesInstance -> Rep RegisterOnPremisesInstance x

to :: Rep RegisterOnPremisesInstance x -> RegisterOnPremisesInstance

Read RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

readsPrec :: Int -> ReadS RegisterOnPremisesInstance

readList :: ReadS [RegisterOnPremisesInstance]

readPrec :: ReadPrec RegisterOnPremisesInstance

readListPrec :: ReadPrec [RegisterOnPremisesInstance]

Show RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

showsPrec :: Int -> RegisterOnPremisesInstance -> ShowS

show :: RegisterOnPremisesInstance -> String

showList :: [RegisterOnPremisesInstance] -> ShowS

NFData RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

rnf :: RegisterOnPremisesInstance -> ()

Eq RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

(==) :: RegisterOnPremisesInstance -> RegisterOnPremisesInstance -> Bool

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

Hashable RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

hashWithSalt :: Int -> RegisterOnPremisesInstance -> Int

hash :: RegisterOnPremisesInstance -> Int

type AWSResponse RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

type AWSResponse RegisterOnPremisesInstance = RegisterOnPremisesInstanceResponse

type Rep RegisterOnPremisesInstance

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

type Rep RegisterOnPremisesInstance = D1 ('MetaData "RegisterOnPremisesInstance" "Amazonka.CodeDeploy.RegisterOnPremisesInstance" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "RegisterOnPremisesInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "iamSessionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "iamUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRegisterOnPremisesInstance

Arguments

:: Text

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:

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

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

RegisterOnPremisesInstance, registerOnPremisesInstance_instanceName - The name of the on-premises instance to register.

Request Lenses

registerOnPremisesInstance_iamSessionArn :: Lens' RegisterOnPremisesInstance (Maybe Text)

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

registerOnPremisesInstance_iamUserArn :: Lens' RegisterOnPremisesInstance (Maybe Text)

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

registerOnPremisesInstance_instanceName :: Lens' RegisterOnPremisesInstance Text

The name of the on-premises instance to register.

Destructuring the Response

data RegisterOnPremisesInstanceResponse

See: newRegisterOnPremisesInstanceResponse smart constructor.

Constructors

RegisterOnPremisesInstanceResponse'

Instances

Generic RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Associated Types

type Rep RegisterOnPremisesInstanceResponse :: Type -> Type

Methods

from :: RegisterOnPremisesInstanceResponse -> Rep RegisterOnPremisesInstanceResponse x

to :: Rep RegisterOnPremisesInstanceResponse x -> RegisterOnPremisesInstanceResponse

Read RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

readsPrec :: Int -> ReadS RegisterOnPremisesInstanceResponse

readList :: ReadS [RegisterOnPremisesInstanceResponse]

readPrec :: ReadPrec RegisterOnPremisesInstanceResponse

readListPrec :: ReadPrec [RegisterOnPremisesInstanceResponse]

Show RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

showsPrec :: Int -> RegisterOnPremisesInstanceResponse -> ShowS

show :: RegisterOnPremisesInstanceResponse -> String

showList :: [RegisterOnPremisesInstanceResponse] -> ShowS

NFData RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

rnf :: RegisterOnPremisesInstanceResponse -> ()

Eq RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

Methods

(==) :: RegisterOnPremisesInstanceResponse -> RegisterOnPremisesInstanceResponse -> Bool

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

type Rep RegisterOnPremisesInstanceResponse

Defined in Amazonka.CodeDeploy.RegisterOnPremisesInstance

type Rep RegisterOnPremisesInstanceResponse = D1 ('MetaData "RegisterOnPremisesInstanceResponse" "Amazonka.CodeDeploy.RegisterOnPremisesInstance" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "RegisterOnPremisesInstanceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRegisterOnPremisesInstanceResponse :: RegisterOnPremisesInstanceResponse

Create a value of RegisterOnPremisesInstanceResponse with all optional fields omitted.

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