Network.AWS.StorageGateway.UpdateChapCredentials

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.

Creating a Request

updateChapCredentials

Arguments

:: Text

uccTargetARN

-> Text

uccSecretToAuthenticateInitiator

-> Text

uccInitiatorName

-> UpdateChapCredentials

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

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

Methods

(==) :: UpdateChapCredentials -> UpdateChapCredentials -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS UpdateChapCredentials

readList :: ReadS [UpdateChapCredentials]

readPrec :: ReadPrec UpdateChapCredentials

readListPrec :: ReadPrec [UpdateChapCredentials]

Show UpdateChapCredentials

Methods

showsPrec :: Int -> UpdateChapCredentials -> ShowS

show :: UpdateChapCredentials -> String

showList :: [UpdateChapCredentials] -> ShowS

Generic UpdateChapCredentials

Associated Types

type Rep UpdateChapCredentials :: * -> *

Methods

from :: UpdateChapCredentials -> Rep UpdateChapCredentials x

to :: Rep UpdateChapCredentials x -> UpdateChapCredentials

Hashable UpdateChapCredentials

Methods

hashWithSalt :: Int -> UpdateChapCredentials -> Int

hash :: UpdateChapCredentials -> Int

ToJSON UpdateChapCredentials

Methods

toJSON :: UpdateChapCredentials -> Value

toEncoding :: UpdateChapCredentials -> Encoding

toJSONList :: [UpdateChapCredentials] -> Value

toEncodingList :: [UpdateChapCredentials] -> Encoding

NFData UpdateChapCredentials

Methods

rnf :: UpdateChapCredentials -> ()

AWSRequest UpdateChapCredentials

Associated Types

type Rs UpdateChapCredentials :: *

Methods

request :: UpdateChapCredentials -> Request UpdateChapCredentials

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

ToQuery UpdateChapCredentials

Methods

toQuery :: UpdateChapCredentials -> QueryString

ToPath UpdateChapCredentials

Methods

toPath :: UpdateChapCredentials -> ByteString

ToHeaders UpdateChapCredentials

Methods

toHeaders :: UpdateChapCredentials -> [Header]

type Rep UpdateChapCredentials

type Rep UpdateChapCredentials = D1 (MetaData "UpdateChapCredentials" "Network.AWS.StorageGateway.UpdateChapCredentials" "amazonka-storagegateway-1.5.0-Dl0pEQb6pvFBwTkfuWFwCu" False) (C1 (MetaCons "UpdateChapCredentials'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uccSecretToAuthenticateTarget") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uccTargetARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_uccSecretToAuthenticateInitiator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_uccInitiatorName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateChapCredentials

type Rs UpdateChapCredentials = UpdateChapCredentialsResponse

Request Lenses

uccSecretToAuthenticateTarget :: Lens' UpdateChapCredentials (Maybe Text)

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

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

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

The iSCSI initiator that connects to the target.

Destructuring the Response

updateChapCredentialsResponse

Arguments

:: Int

uccrsResponseStatus

-> UpdateChapCredentialsResponse

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

A JSON object containing the following fields:

See: updateChapCredentialsResponse smart constructor.

Instances

Eq UpdateChapCredentialsResponse

Methods

(==) :: UpdateChapCredentialsResponse -> UpdateChapCredentialsResponse -> Bool

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

Data UpdateChapCredentialsResponse

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

Methods

readsPrec :: Int -> ReadS UpdateChapCredentialsResponse

readList :: ReadS [UpdateChapCredentialsResponse]

readPrec :: ReadPrec UpdateChapCredentialsResponse

readListPrec :: ReadPrec [UpdateChapCredentialsResponse]

Show UpdateChapCredentialsResponse

Methods

showsPrec :: Int -> UpdateChapCredentialsResponse -> ShowS

show :: UpdateChapCredentialsResponse -> String

showList :: [UpdateChapCredentialsResponse] -> ShowS

Generic UpdateChapCredentialsResponse

Associated Types

type Rep UpdateChapCredentialsResponse :: * -> *

Methods

from :: UpdateChapCredentialsResponse -> Rep UpdateChapCredentialsResponse x

to :: Rep UpdateChapCredentialsResponse x -> UpdateChapCredentialsResponse

NFData UpdateChapCredentialsResponse

Methods

rnf :: UpdateChapCredentialsResponse -> ()

type Rep UpdateChapCredentialsResponse

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

Response Lenses

uccrsTargetARN :: Lens' UpdateChapCredentialsResponse (Maybe Text)

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

uccrsInitiatorName :: Lens' UpdateChapCredentialsResponse (Maybe Text)

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

uccrsResponseStatus :: Lens' UpdateChapCredentialsResponse Int

• - | The response status code.