This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ssm/include/aws/ssm/model/Session.h

427 lines
14 KiB
C
Raw Normal View History

/**
* 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 <aws/ssm/model/SessionStatus.h>
#include <aws/core/utils/DateTime.h>
#include <aws/ssm/model/SessionManagerOutputUrl.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace SSM
{
namespace Model
{
/**
* <p>Information about a Session Manager connection to an instance.</p><p><h3>See
* Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/Session">AWS API
* Reference</a></p>
*/
class AWS_SSM_API Session
{
public:
Session();
Session(Aws::Utils::Json::JsonView jsonValue);
Session& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The ID of the session.</p>
*/
inline const Aws::String& GetSessionId() const{ return m_sessionId; }
/**
* <p>The ID of the session.</p>
*/
inline bool SessionIdHasBeenSet() const { return m_sessionIdHasBeenSet; }
/**
* <p>The ID of the session.</p>
*/
inline void SetSessionId(const Aws::String& value) { m_sessionIdHasBeenSet = true; m_sessionId = value; }
/**
* <p>The ID of the session.</p>
*/
inline void SetSessionId(Aws::String&& value) { m_sessionIdHasBeenSet = true; m_sessionId = std::move(value); }
/**
* <p>The ID of the session.</p>
*/
inline void SetSessionId(const char* value) { m_sessionIdHasBeenSet = true; m_sessionId.assign(value); }
/**
* <p>The ID of the session.</p>
*/
inline Session& WithSessionId(const Aws::String& value) { SetSessionId(value); return *this;}
/**
* <p>The ID of the session.</p>
*/
inline Session& WithSessionId(Aws::String&& value) { SetSessionId(std::move(value)); return *this;}
/**
* <p>The ID of the session.</p>
*/
inline Session& WithSessionId(const char* value) { SetSessionId(value); return *this;}
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline const Aws::String& GetTarget() const{ return m_target; }
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline bool TargetHasBeenSet() const { return m_targetHasBeenSet; }
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline void SetTarget(const Aws::String& value) { m_targetHasBeenSet = true; m_target = value; }
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline void SetTarget(Aws::String&& value) { m_targetHasBeenSet = true; m_target = std::move(value); }
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline void SetTarget(const char* value) { m_targetHasBeenSet = true; m_target.assign(value); }
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline Session& WithTarget(const Aws::String& value) { SetTarget(value); return *this;}
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline Session& WithTarget(Aws::String&& value) { SetTarget(std::move(value)); return *this;}
/**
* <p>The instance that the Session Manager session connected to.</p>
*/
inline Session& WithTarget(const char* value) { SetTarget(value); return *this;}
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline const SessionStatus& GetStatus() const{ return m_status; }
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline void SetStatus(const SessionStatus& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline void SetStatus(SessionStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline Session& WithStatus(const SessionStatus& value) { SetStatus(value); return *this;}
/**
* <p>The status of the session. For example, "Connected" or "Terminated".</p>
*/
inline Session& WithStatus(SessionStatus&& value) { SetStatus(std::move(value)); return *this;}
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline const Aws::Utils::DateTime& GetStartDate() const{ return m_startDate; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline bool StartDateHasBeenSet() const { return m_startDateHasBeenSet; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline void SetStartDate(const Aws::Utils::DateTime& value) { m_startDateHasBeenSet = true; m_startDate = value; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline void SetStartDate(Aws::Utils::DateTime&& value) { m_startDateHasBeenSet = true; m_startDate = std::move(value); }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline Session& WithStartDate(const Aws::Utils::DateTime& value) { SetStartDate(value); return *this;}
/**
* <p>The date and time, in ISO-8601 Extended format, when the session began.</p>
*/
inline Session& WithStartDate(Aws::Utils::DateTime&& value) { SetStartDate(std::move(value)); return *this;}
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline const Aws::Utils::DateTime& GetEndDate() const{ return m_endDate; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline bool EndDateHasBeenSet() const { return m_endDateHasBeenSet; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline void SetEndDate(const Aws::Utils::DateTime& value) { m_endDateHasBeenSet = true; m_endDate = value; }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline void SetEndDate(Aws::Utils::DateTime&& value) { m_endDateHasBeenSet = true; m_endDate = std::move(value); }
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline Session& WithEndDate(const Aws::Utils::DateTime& value) { SetEndDate(value); return *this;}
/**
* <p>The date and time, in ISO-8601 Extended format, when the session was
* terminated.</p>
*/
inline Session& WithEndDate(Aws::Utils::DateTime&& value) { SetEndDate(std::move(value)); return *this;}
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline const Aws::String& GetDocumentName() const{ return m_documentName; }
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; }
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline void SetDocumentName(const Aws::String& value) { m_documentNameHasBeenSet = true; m_documentName = value; }
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline void SetDocumentName(Aws::String&& value) { m_documentNameHasBeenSet = true; m_documentName = std::move(value); }
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline void SetDocumentName(const char* value) { m_documentNameHasBeenSet = true; m_documentName.assign(value); }
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline Session& WithDocumentName(const Aws::String& value) { SetDocumentName(value); return *this;}
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline Session& WithDocumentName(Aws::String&& value) { SetDocumentName(std::move(value)); return *this;}
/**
* <p>The name of the Session Manager SSM document used to define the parameters
* and plugin settings for the session. For example,
* <code>SSM-SessionManagerRunShell</code>.</p>
*/
inline Session& WithDocumentName(const char* value) { SetDocumentName(value); return *this;}
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline const Aws::String& GetOwner() const{ return m_owner; }
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline bool OwnerHasBeenSet() const { return m_ownerHasBeenSet; }
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline void SetOwner(const Aws::String& value) { m_ownerHasBeenSet = true; m_owner = value; }
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline void SetOwner(Aws::String&& value) { m_ownerHasBeenSet = true; m_owner = std::move(value); }
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline void SetOwner(const char* value) { m_ownerHasBeenSet = true; m_owner.assign(value); }
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline Session& WithOwner(const Aws::String& value) { SetOwner(value); return *this;}
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline Session& WithOwner(Aws::String&& value) { SetOwner(std::move(value)); return *this;}
/**
* <p>The ID of the AWS user account that started the session.</p>
*/
inline Session& WithOwner(const char* value) { SetOwner(value); return *this;}
/**
* <p>Reserved for future use.</p>
*/
inline const Aws::String& GetDetails() const{ return m_details; }
/**
* <p>Reserved for future use.</p>
*/
inline bool DetailsHasBeenSet() const { return m_detailsHasBeenSet; }
/**
* <p>Reserved for future use.</p>
*/
inline void SetDetails(const Aws::String& value) { m_detailsHasBeenSet = true; m_details = value; }
/**
* <p>Reserved for future use.</p>
*/
inline void SetDetails(Aws::String&& value) { m_detailsHasBeenSet = true; m_details = std::move(value); }
/**
* <p>Reserved for future use.</p>
*/
inline void SetDetails(const char* value) { m_detailsHasBeenSet = true; m_details.assign(value); }
/**
* <p>Reserved for future use.</p>
*/
inline Session& WithDetails(const Aws::String& value) { SetDetails(value); return *this;}
/**
* <p>Reserved for future use.</p>
*/
inline Session& WithDetails(Aws::String&& value) { SetDetails(std::move(value)); return *this;}
/**
* <p>Reserved for future use.</p>
*/
inline Session& WithDetails(const char* value) { SetDetails(value); return *this;}
/**
* <p>Reserved for future use.</p>
*/
inline const SessionManagerOutputUrl& GetOutputUrl() const{ return m_outputUrl; }
/**
* <p>Reserved for future use.</p>
*/
inline bool OutputUrlHasBeenSet() const { return m_outputUrlHasBeenSet; }
/**
* <p>Reserved for future use.</p>
*/
inline void SetOutputUrl(const SessionManagerOutputUrl& value) { m_outputUrlHasBeenSet = true; m_outputUrl = value; }
/**
* <p>Reserved for future use.</p>
*/
inline void SetOutputUrl(SessionManagerOutputUrl&& value) { m_outputUrlHasBeenSet = true; m_outputUrl = std::move(value); }
/**
* <p>Reserved for future use.</p>
*/
inline Session& WithOutputUrl(const SessionManagerOutputUrl& value) { SetOutputUrl(value); return *this;}
/**
* <p>Reserved for future use.</p>
*/
inline Session& WithOutputUrl(SessionManagerOutputUrl&& value) { SetOutputUrl(std::move(value)); return *this;}
private:
Aws::String m_sessionId;
bool m_sessionIdHasBeenSet;
Aws::String m_target;
bool m_targetHasBeenSet;
SessionStatus m_status;
bool m_statusHasBeenSet;
Aws::Utils::DateTime m_startDate;
bool m_startDateHasBeenSet;
Aws::Utils::DateTime m_endDate;
bool m_endDateHasBeenSet;
Aws::String m_documentName;
bool m_documentNameHasBeenSet;
Aws::String m_owner;
bool m_ownerHasBeenSet;
Aws::String m_details;
bool m_detailsHasBeenSet;
SessionManagerOutputUrl m_outputUrl;
bool m_outputUrlHasBeenSet;
};
} // namespace Model
} // namespace SSM
} // namespace Aws