| 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.StorageGateway.UpdateChapCredentials
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. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Synopsis
- data UpdateChapCredentials = UpdateChapCredentials' {}
- newUpdateChapCredentials :: Text -> Text -> Text -> UpdateChapCredentials
- updateChapCredentials_secretToAuthenticateTarget :: Lens' UpdateChapCredentials (Maybe Text)
- updateChapCredentials_targetARN :: Lens' UpdateChapCredentials Text
- updateChapCredentials_secretToAuthenticateInitiator :: Lens' UpdateChapCredentials Text
- updateChapCredentials_initiatorName :: Lens' UpdateChapCredentials Text
- data UpdateChapCredentialsResponse = UpdateChapCredentialsResponse' {
- targetARN :: Maybe Text
- initiatorName :: Maybe Text
- httpStatus :: Int
- newUpdateChapCredentialsResponse :: Int -> UpdateChapCredentialsResponse
- updateChapCredentialsResponse_targetARN :: Lens' UpdateChapCredentialsResponse (Maybe Text)
- updateChapCredentialsResponse_initiatorName :: Lens' UpdateChapCredentialsResponse (Maybe Text)
- updateChapCredentialsResponse_httpStatus :: Lens' UpdateChapCredentialsResponse Int
Creating a Request
data UpdateChapCredentials Source #
A JSON object containing one or more of the following fields:
- UpdateChapCredentialsInput$InitiatorName
- UpdateChapCredentialsInput$SecretToAuthenticateInitiator
- UpdateChapCredentialsInput$SecretToAuthenticateTarget
- UpdateChapCredentialsInput$TargetARN
See: newUpdateChapCredentials smart constructor.
Constructors
| UpdateChapCredentials' | |
Fields
| |
Instances
newUpdateChapCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateChapCredentials |
Create a value of UpdateChapCredentials 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:secretToAuthenticateTarget:UpdateChapCredentials', updateChapCredentials_secretToAuthenticateTarget - 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.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
$sel:targetARN:UpdateChapCredentials', updateChapCredentials_targetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return the TargetARN for
specified VolumeARN.
$sel:secretToAuthenticateInitiator:UpdateChapCredentials', updateChapCredentials_secretToAuthenticateInitiator - The secret key that the initiator (for example, the Windows client) must
provide to participate in mutual CHAP with the target.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
$sel:initiatorName:UpdateChapCredentials', updateChapCredentials_initiatorName - The iSCSI initiator that connects to the target.
Request Lenses
updateChapCredentials_secretToAuthenticateTarget :: 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.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
updateChapCredentials_targetARN :: 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.
updateChapCredentials_secretToAuthenticateInitiator :: 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.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
updateChapCredentials_initiatorName :: Lens' UpdateChapCredentials Text Source #
The iSCSI initiator that connects to the target.
Destructuring the Response
data UpdateChapCredentialsResponse Source #
A JSON object containing the following fields:
See: newUpdateChapCredentialsResponse smart constructor.
Constructors
| UpdateChapCredentialsResponse' | |
Fields
| |
Instances
newUpdateChapCredentialsResponse Source #
Create a value of UpdateChapCredentialsResponse 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:targetARN:UpdateChapCredentials', updateChapCredentialsResponse_targetARN - The Amazon Resource Name (ARN) of the target. This is the same target
specified in the request.
$sel:initiatorName:UpdateChapCredentials', updateChapCredentialsResponse_initiatorName - The iSCSI initiator that connects to the target. This is the same
initiator name specified in the request.
$sel:httpStatus:UpdateChapCredentialsResponse', updateChapCredentialsResponse_httpStatus - The response's http status code.
Response Lenses
updateChapCredentialsResponse_targetARN :: Lens' UpdateChapCredentialsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
updateChapCredentialsResponse_initiatorName :: Lens' UpdateChapCredentialsResponse (Maybe Text) Source #
The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
updateChapCredentialsResponse_httpStatus :: Lens' UpdateChapCredentialsResponse Int Source #
The response's http status code.