231 lines
10 KiB
C
231 lines
10 KiB
C
|
/**
|
|||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#pragma once
|
|||
|
|
#include <aws/ssm/SSM_EXPORTS.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
template<typename RESULT_TYPE>
|
|||
|
|
class AmazonWebServiceResult;
|
|||
|
|
|
|||
|
|
namespace Utils
|
|||
|
|
{
|
|||
|
|
namespace Json
|
|||
|
|
{
|
|||
|
|
class JsonValue;
|
|||
|
|
} // namespace Json
|
|||
|
|
} // namespace Utils
|
|||
|
|
namespace SSM
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
class AWS_SSM_API StartSessionResult
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
StartSessionResult();
|
|||
|
|
StartSessionResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
|
|||
|
|
StartSessionResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetSessionId() const{ return m_sessionId; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetSessionId(const Aws::String& value) { m_sessionId = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetSessionId(Aws::String&& value) { m_sessionId = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetSessionId(const char* value) { m_sessionId.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithSessionId(const Aws::String& value) { SetSessionId(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithSessionId(Aws::String&& value) { SetSessionId(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The ID of the session.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithSessionId(const char* value) { SetSessionId(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetTokenValue() const{ return m_tokenValue; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTokenValue(const Aws::String& value) { m_tokenValue = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTokenValue(Aws::String&& value) { m_tokenValue = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetTokenValue(const char* value) { m_tokenValue.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithTokenValue(const Aws::String& value) { SetTokenValue(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithTokenValue(Aws::String&& value) { SetTokenValue(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>An encrypted token value containing session and caller information. Used to
|
|||
|
|
* authenticate the connection to the instance.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithTokenValue(const char* value) { SetTokenValue(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetStreamUrl() const{ return m_streamUrl; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStreamUrl(const Aws::String& value) { m_streamUrl = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStreamUrl(Aws::String&& value) { m_streamUrl = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStreamUrl(const char* value) { m_streamUrl.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithStreamUrl(const Aws::String& value) { SetStreamUrl(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithStreamUrl(Aws::String&& value) { SetStreamUrl(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A URL back to SSM Agent on the instance that the Session Manager client uses
|
|||
|
|
* to send commands and receive output from the instance. Format:
|
|||
|
|
* <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|||
|
|
* </p> <p> <b>region</b> represents the Region identifier for an AWS Region
|
|||
|
|
* supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East
|
|||
|
|
* (Ohio) Region. For a list of supported <b>region</b> values, see the
|
|||
|
|
* <b>Region</b> column in <a
|
|||
|
|
* href="http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems
|
|||
|
|
* Manager service endpoints</a> in the <i>AWS General Reference</i>.</p> <p>
|
|||
|
|
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|||
|
|
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline StartSessionResult& WithStreamUrl(const char* value) { SetStreamUrl(value); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::String m_sessionId;
|
|||
|
|
|
|||
|
|
Aws::String m_tokenValue;
|
|||
|
|
|
|||
|
|
Aws::String m_streamUrl;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace SSM
|
|||
|
|
} // namespace Aws
|