amazonka-storagegateway-1.6.1: Amazon Storage Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.UpdateChapCredentials

Contents

Description

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

Important: When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

Synopsis

Creating a Request

updateChapCredentials Source #

Creates a value of UpdateChapCredentials with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • uccSecretToAuthenticateTarget - The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
  • uccTargetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
  • uccSecretToAuthenticateInitiator - The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
  • uccInitiatorName - The iSCSI initiator that connects to the target.

data UpdateChapCredentials Source #

A JSON object containing one or more of the following fields:

  • 'UpdateChapCredentialsInput$InitiatorName'
  • 'UpdateChapCredentialsInput$SecretToAuthenticateInitiator'
  • 'UpdateChapCredentialsInput$SecretToAuthenticateTarget'
  • 'UpdateChapCredentialsInput$TargetARN'

See: updateChapCredentials smart constructor.

Instances
Eq UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Data UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Methods

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

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

toConstr :: UpdateChapCredentials -> Constr #

dataTypeOf :: UpdateChapCredentials -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateChapCredentials) #

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

gmapT :: (forall b. Data b => b -> b) -> UpdateChapCredentials -> UpdateChapCredentials #

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

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

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

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

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

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

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

Read UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Show UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Generic UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Associated Types

type Rep UpdateChapCredentials :: Type -> Type #

Hashable UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

ToJSON UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

AWSRequest UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Associated Types

type Rs UpdateChapCredentials :: Type #

ToHeaders UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

ToPath UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

ToQuery UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

NFData UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Methods

rnf :: UpdateChapCredentials -> () #

type Rep UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

type Rep UpdateChapCredentials = D1 (MetaData "UpdateChapCredentials" "Network.AWS.StorageGateway.UpdateChapCredentials" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateChapCredentials'" PrefixI True) ((S1 (MetaSel (Just "_uccSecretToAuthenticateTarget") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uccTargetARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_uccSecretToAuthenticateInitiator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uccInitiatorName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs UpdateChapCredentials Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Request Lenses

uccSecretToAuthenticateTarget :: Lens' UpdateChapCredentials (Maybe Text) Source #

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

uccTargetARN :: Lens' UpdateChapCredentials Text Source #

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

uccSecretToAuthenticateInitiator :: Lens' UpdateChapCredentials Text Source #

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

uccInitiatorName :: Lens' UpdateChapCredentials Text Source #

The iSCSI initiator that connects to the target.

Destructuring the Response

updateChapCredentialsResponse Source #

Creates a value of UpdateChapCredentialsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • uccrsTargetARN - The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
  • uccrsInitiatorName - The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
  • uccrsResponseStatus - -- | The response status code.

data UpdateChapCredentialsResponse Source #

A JSON object containing the following fields:

See: updateChapCredentialsResponse smart constructor.

Instances
Eq UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Data UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Methods

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

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

toConstr :: UpdateChapCredentialsResponse -> Constr #

dataTypeOf :: UpdateChapCredentialsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateChapCredentialsResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> UpdateChapCredentialsResponse -> UpdateChapCredentialsResponse #

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

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

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

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

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

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

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

Read UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Show UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Generic UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

Associated Types

type Rep UpdateChapCredentialsResponse :: Type -> Type #

NFData UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

type Rep UpdateChapCredentialsResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateChapCredentials

type Rep UpdateChapCredentialsResponse = D1 (MetaData "UpdateChapCredentialsResponse" "Network.AWS.StorageGateway.UpdateChapCredentials" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateChapCredentialsResponse'" PrefixI True) (S1 (MetaSel (Just "_uccrsTargetARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uccrsInitiatorName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

uccrsTargetARN :: Lens' UpdateChapCredentialsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

uccrsInitiatorName :: Lens' UpdateChapCredentialsResponse (Maybe Text) Source #

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.