AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::DescribeChapCredentialsResult Class Reference

#include <DescribeChapCredentialsResult.h>

Public Member Functions

 DescribeChapCredentialsResult ()
 
 DescribeChapCredentialsResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeChapCredentialsResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::Vector< ChapInfo > & GetChapCredentials () const
 
void SetChapCredentials (const Aws::Vector< ChapInfo > &value)
 
void SetChapCredentials (Aws::Vector< ChapInfo > &&value)
 
DescribeChapCredentialsResultWithChapCredentials (const Aws::Vector< ChapInfo > &value)
 
DescribeChapCredentialsResultWithChapCredentials (Aws::Vector< ChapInfo > &&value)
 
DescribeChapCredentialsResultAddChapCredentials (const ChapInfo &value)
 
DescribeChapCredentialsResultAddChapCredentials (ChapInfo &&value)
 

Detailed Description

A JSON object containing the following fields:

See Also:

AWS API Reference

Definition at line 33 of file DescribeChapCredentialsResult.h.

Constructor & Destructor Documentation

◆ DescribeChapCredentialsResult() [1/2]

Aws::StorageGateway::Model::DescribeChapCredentialsResult::DescribeChapCredentialsResult ( )

◆ DescribeChapCredentialsResult() [2/2]

Aws::StorageGateway::Model::DescribeChapCredentialsResult::DescribeChapCredentialsResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddChapCredentials() [1/2]

DescribeChapCredentialsResult& Aws::StorageGateway::Model::DescribeChapCredentialsResult::AddChapCredentials ( ChapInfo &&  value)
inline

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.

Definition at line 151 of file DescribeChapCredentialsResult.h.

◆ AddChapCredentials() [2/2]

DescribeChapCredentialsResult& Aws::StorageGateway::Model::DescribeChapCredentialsResult::AddChapCredentials ( const ChapInfo value)
inline

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.

Definition at line 135 of file DescribeChapCredentialsResult.h.

◆ GetChapCredentials()

const Aws::Vector<ChapInfo>& Aws::StorageGateway::Model::DescribeChapCredentialsResult::GetChapCredentials ( ) const
inline

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.

Definition at line 55 of file DescribeChapCredentialsResult.h.

◆ operator=()

DescribeChapCredentialsResult& Aws::StorageGateway::Model::DescribeChapCredentialsResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetChapCredentials() [1/2]

void Aws::StorageGateway::Model::DescribeChapCredentialsResult::SetChapCredentials ( Aws::Vector< ChapInfo > &&  value)
inline

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.

Definition at line 87 of file DescribeChapCredentialsResult.h.

◆ SetChapCredentials() [2/2]

void Aws::StorageGateway::Model::DescribeChapCredentialsResult::SetChapCredentials ( const Aws::Vector< ChapInfo > &  value)
inline

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.

Definition at line 71 of file DescribeChapCredentialsResult.h.

◆ WithChapCredentials() [1/2]

DescribeChapCredentialsResult& Aws::StorageGateway::Model::DescribeChapCredentialsResult::WithChapCredentials ( Aws::Vector< ChapInfo > &&  value)
inline

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.

Definition at line 119 of file DescribeChapCredentialsResult.h.

◆ WithChapCredentials() [2/2]

DescribeChapCredentialsResult& Aws::StorageGateway::Model::DescribeChapCredentialsResult::WithChapCredentials ( const Aws::Vector< ChapInfo > &  value)
inline

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.

Definition at line 103 of file DescribeChapCredentialsResult.h.


The documentation for this class was generated from the following file: