storagegateway/aws.sdk.kotlin.services.storagegateway/StorageGatewayClient/updateChapCredentials

updateChapCredentials

abstract suspend fun updateChapCredentials(input: UpdateChapCredentialsRequest): UpdateChapCredentialsResponse

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.

Samples

// Updates the Challenge Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI
// target.
val resp = storageGatewayClient.updateChapCredentials {
    targetArn = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
    secretToAuthenticateInitiator = "111111111111"
    initiatorName = "iqn.1991-05.com.microsoft:computername.domain.example.com"
    secretToAuthenticateTarget = "222222222222"
}