/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace Transfer { namespace Model { class TestConnectionResult { public: AWS_TRANSFER_API TestConnectionResult(); AWS_TRANSFER_API TestConnectionResult(const Aws::AmazonWebServiceResult& result); AWS_TRANSFER_API TestConnectionResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

Returns the identifier of the connector object that you are testing.

*/ inline const Aws::String& GetConnectorId() const{ return m_connectorId; } /** *

Returns the identifier of the connector object that you are testing.

*/ inline void SetConnectorId(const Aws::String& value) { m_connectorId = value; } /** *

Returns the identifier of the connector object that you are testing.

*/ inline void SetConnectorId(Aws::String&& value) { m_connectorId = std::move(value); } /** *

Returns the identifier of the connector object that you are testing.

*/ inline void SetConnectorId(const char* value) { m_connectorId.assign(value); } /** *

Returns the identifier of the connector object that you are testing.

*/ inline TestConnectionResult& WithConnectorId(const Aws::String& value) { SetConnectorId(value); return *this;} /** *

Returns the identifier of the connector object that you are testing.

*/ inline TestConnectionResult& WithConnectorId(Aws::String&& value) { SetConnectorId(std::move(value)); return *this;} /** *

Returns the identifier of the connector object that you are testing.

*/ inline TestConnectionResult& WithConnectorId(const char* value) { SetConnectorId(value); return *this;} /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline void SetStatus(const Aws::String& value) { m_status = value; } /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline void SetStatus(Aws::String&& value) { m_status = std::move(value); } /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline void SetStatus(const char* value) { m_status.assign(value); } /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline TestConnectionResult& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline TestConnectionResult& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

Returns OK for successful test, or ERROR if the * test fails.

*/ inline TestConnectionResult& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; } /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline void SetStatusMessage(const Aws::String& value) { m_statusMessage = value; } /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline void SetStatusMessage(Aws::String&& value) { m_statusMessage = std::move(value); } /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline void SetStatusMessage(const char* value) { m_statusMessage.assign(value); } /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline TestConnectionResult& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;} /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline TestConnectionResult& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;} /** *

Returns Connection succeeded if the test is successful. Or, * returns a descriptive error message if the test fails. The following list * provides the details for some error messages and troubleshooting steps for * each.

  • Unable to access secrets manager: Verify that * your secret name aligns with the one in Transfer Role permissions.

  • *
  • Unknown Host/Connection failed: Verify the server URL in the * connector configuration , and verify that the login credentials work * successfully outside of the connector.

  • Private key not * found: Verify that the secret exists and is formatted correctly.

  • *
  • Invalid trusted host keys: Verify that the trusted host key in * the connector configuration matches the ssh-keyscan output.

    *
*/ inline TestConnectionResult& WithStatusMessage(const char* value) { SetStatusMessage(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 TestConnectionResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline TestConnectionResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline TestConnectionResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_connectorId; Aws::String m_status; Aws::String m_statusMessage; Aws::String m_requestId; }; } // namespace Model } // namespace Transfer } // namespace Aws