Constructor Detail

DescribeChapCredentialsResult

Method Detail

getChapCredentials

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP
credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned.
CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with
the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Returns:

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains
CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array
is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

setChapCredentials

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP
credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned.
CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with
the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Parameters:

chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains
CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array
is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

withChapCredentials

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP
credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned.
CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with
the initiator (e.g. Windows client).

chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains
CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array
is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Returns:

Returns a reference to this object so that method calls can be chained together.

withChapCredentials

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP
credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned.
CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with
the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Parameters:

chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains
CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array
is returned. CHAP credential information is provided in a JSON object with the following fields:

InitiatorName: The iSCSI initiator that connects to the target.

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

SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g. Windows client).

TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Returns:

Returns a reference to this object so that method calls can be chained together.