/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace StorageGateway { namespace Model { /** *

A JSON object containing the following fields:

See Also:

AWS * API Reference

*/ class DescribeChapCredentialsResult { public: AWS_STORAGEGATEWAY_API DescribeChapCredentialsResult(); AWS_STORAGEGATEWAY_API DescribeChapCredentialsResult(const Aws::AmazonWebServiceResult& result); AWS_STORAGEGATEWAY_API DescribeChapCredentialsResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

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.

*/ inline const Aws::Vector& GetChapCredentials() const{ return m_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.

*/ inline void SetChapCredentials(const Aws::Vector& value) { m_chapCredentials = value; } /** *

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.

*/ inline void SetChapCredentials(Aws::Vector&& value) { m_chapCredentials = std::move(value); } /** *

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.

*/ inline DescribeChapCredentialsResult& WithChapCredentials(const Aws::Vector& value) { SetChapCredentials(value); return *this;} /** *

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.

*/ inline DescribeChapCredentialsResult& WithChapCredentials(Aws::Vector&& value) { SetChapCredentials(std::move(value)); return *this;} /** *

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.

*/ inline DescribeChapCredentialsResult& AddChapCredentials(const ChapInfo& value) { m_chapCredentials.push_back(value); return *this; } /** *

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.

*/ inline DescribeChapCredentialsResult& AddChapCredentials(ChapInfo&& value) { m_chapCredentials.push_back(std::move(value)); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeChapCredentialsResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeChapCredentialsResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeChapCredentialsResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::Vector m_chapCredentials; Aws::String m_requestId; }; } // namespace Model } // namespace StorageGateway } // namespace Aws