216 lines
10 KiB
C++
216 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 <aws/core/utils/DateTime.h>
|
|
#include <aws/ssm/model/DocumentFormat.h>
|
|
#include <aws/ssm/model/DocumentStatus.h>
|
|
#include <aws/ssm/model/ReviewStatus.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace SSM
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Version information about the document.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentVersionInfo">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class DocumentVersionInfo
|
|
{
|
|
public:
|
|
AWS_SSM_API DocumentVersionInfo();
|
|
AWS_SSM_API DocumentVersionInfo(Aws::Utils::Json::JsonView jsonValue);
|
|
AWS_SSM_API DocumentVersionInfo& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
///@{
|
|
/**
|
|
* <p>The document name.</p>
|
|
*/
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|
inline DocumentVersionInfo& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
inline DocumentVersionInfo& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
inline DocumentVersionInfo& WithName(const char* value) { SetName(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The friendly name of the SSM document. This value can differ for each version
|
|
* of the document. If you want to update this value, see
|
|
* <a>UpdateDocument</a>.</p>
|
|
*/
|
|
inline const Aws::String& GetDisplayName() const{ return m_displayName; }
|
|
inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; }
|
|
inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; }
|
|
inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); }
|
|
inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); }
|
|
inline DocumentVersionInfo& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;}
|
|
inline DocumentVersionInfo& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;}
|
|
inline DocumentVersionInfo& WithDisplayName(const char* value) { SetDisplayName(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The document version.</p>
|
|
*/
|
|
inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; }
|
|
inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; }
|
|
inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; }
|
|
inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); }
|
|
inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); }
|
|
inline DocumentVersionInfo& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;}
|
|
inline DocumentVersionInfo& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;}
|
|
inline DocumentVersionInfo& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The version of the artifact associated with the document. For example, 12.6.
|
|
* This value is unique across all versions of a document, and can't be
|
|
* changed.</p>
|
|
*/
|
|
inline const Aws::String& GetVersionName() const{ return m_versionName; }
|
|
inline bool VersionNameHasBeenSet() const { return m_versionNameHasBeenSet; }
|
|
inline void SetVersionName(const Aws::String& value) { m_versionNameHasBeenSet = true; m_versionName = value; }
|
|
inline void SetVersionName(Aws::String&& value) { m_versionNameHasBeenSet = true; m_versionName = std::move(value); }
|
|
inline void SetVersionName(const char* value) { m_versionNameHasBeenSet = true; m_versionName.assign(value); }
|
|
inline DocumentVersionInfo& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;}
|
|
inline DocumentVersionInfo& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;}
|
|
inline DocumentVersionInfo& WithVersionName(const char* value) { SetVersionName(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The date the document was created.</p>
|
|
*/
|
|
inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; }
|
|
inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; }
|
|
inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; }
|
|
inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); }
|
|
inline DocumentVersionInfo& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;}
|
|
inline DocumentVersionInfo& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>An identifier for the default version of the document.</p>
|
|
*/
|
|
inline bool GetIsDefaultVersion() const{ return m_isDefaultVersion; }
|
|
inline bool IsDefaultVersionHasBeenSet() const { return m_isDefaultVersionHasBeenSet; }
|
|
inline void SetIsDefaultVersion(bool value) { m_isDefaultVersionHasBeenSet = true; m_isDefaultVersion = value; }
|
|
inline DocumentVersionInfo& WithIsDefaultVersion(bool value) { SetIsDefaultVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The document format, either JSON or YAML.</p>
|
|
*/
|
|
inline const DocumentFormat& GetDocumentFormat() const{ return m_documentFormat; }
|
|
inline bool DocumentFormatHasBeenSet() const { return m_documentFormatHasBeenSet; }
|
|
inline void SetDocumentFormat(const DocumentFormat& value) { m_documentFormatHasBeenSet = true; m_documentFormat = value; }
|
|
inline void SetDocumentFormat(DocumentFormat&& value) { m_documentFormatHasBeenSet = true; m_documentFormat = std::move(value); }
|
|
inline DocumentVersionInfo& WithDocumentFormat(const DocumentFormat& value) { SetDocumentFormat(value); return *this;}
|
|
inline DocumentVersionInfo& WithDocumentFormat(DocumentFormat&& value) { SetDocumentFormat(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The status of the SSM document, such as <code>Creating</code>,
|
|
* <code>Active</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
|
|
*/
|
|
inline const DocumentStatus& GetStatus() const{ return m_status; }
|
|
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
|
|
inline void SetStatus(const DocumentStatus& value) { m_statusHasBeenSet = true; m_status = value; }
|
|
inline void SetStatus(DocumentStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
|
|
inline DocumentVersionInfo& WithStatus(const DocumentStatus& value) { SetStatus(value); return *this;}
|
|
inline DocumentVersionInfo& WithStatus(DocumentStatus&& value) { SetStatus(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A message returned by Amazon Web Services Systems Manager that explains the
|
|
* <code>Status</code> value. For example, a <code>Failed</code> status might be
|
|
* explained by the <code>StatusInformation</code> message, "The specified S3
|
|
* bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
|
|
*/
|
|
inline const Aws::String& GetStatusInformation() const{ return m_statusInformation; }
|
|
inline bool StatusInformationHasBeenSet() const { return m_statusInformationHasBeenSet; }
|
|
inline void SetStatusInformation(const Aws::String& value) { m_statusInformationHasBeenSet = true; m_statusInformation = value; }
|
|
inline void SetStatusInformation(Aws::String&& value) { m_statusInformationHasBeenSet = true; m_statusInformation = std::move(value); }
|
|
inline void SetStatusInformation(const char* value) { m_statusInformationHasBeenSet = true; m_statusInformation.assign(value); }
|
|
inline DocumentVersionInfo& WithStatusInformation(const Aws::String& value) { SetStatusInformation(value); return *this;}
|
|
inline DocumentVersionInfo& WithStatusInformation(Aws::String&& value) { SetStatusInformation(std::move(value)); return *this;}
|
|
inline DocumentVersionInfo& WithStatusInformation(const char* value) { SetStatusInformation(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The current status of the approval review for the latest version of the
|
|
* document.</p>
|
|
*/
|
|
inline const ReviewStatus& GetReviewStatus() const{ return m_reviewStatus; }
|
|
inline bool ReviewStatusHasBeenSet() const { return m_reviewStatusHasBeenSet; }
|
|
inline void SetReviewStatus(const ReviewStatus& value) { m_reviewStatusHasBeenSet = true; m_reviewStatus = value; }
|
|
inline void SetReviewStatus(ReviewStatus&& value) { m_reviewStatusHasBeenSet = true; m_reviewStatus = std::move(value); }
|
|
inline DocumentVersionInfo& WithReviewStatus(const ReviewStatus& value) { SetReviewStatus(value); return *this;}
|
|
inline DocumentVersionInfo& WithReviewStatus(ReviewStatus&& value) { SetReviewStatus(std::move(value)); return *this;}
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet = false;
|
|
|
|
Aws::String m_displayName;
|
|
bool m_displayNameHasBeenSet = false;
|
|
|
|
Aws::String m_documentVersion;
|
|
bool m_documentVersionHasBeenSet = false;
|
|
|
|
Aws::String m_versionName;
|
|
bool m_versionNameHasBeenSet = false;
|
|
|
|
Aws::Utils::DateTime m_createdDate;
|
|
bool m_createdDateHasBeenSet = false;
|
|
|
|
bool m_isDefaultVersion;
|
|
bool m_isDefaultVersionHasBeenSet = false;
|
|
|
|
DocumentFormat m_documentFormat;
|
|
bool m_documentFormatHasBeenSet = false;
|
|
|
|
DocumentStatus m_status;
|
|
bool m_statusHasBeenSet = false;
|
|
|
|
Aws::String m_statusInformation;
|
|
bool m_statusInformationHasBeenSet = false;
|
|
|
|
ReviewStatus m_reviewStatus;
|
|
bool m_reviewStatusHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace SSM
|
|
} // namespace Aws
|