577 lines
33 KiB
C++
577 lines
33 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/ssm/model/DocumentHashType.h>
|
|
#include <aws/core/utils/DateTime.h>
|
|
#include <aws/ssm/model/DocumentStatus.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/ssm/model/DocumentType.h>
|
|
#include <aws/ssm/model/DocumentFormat.h>
|
|
#include <aws/ssm/model/ReviewStatus.h>
|
|
#include <aws/ssm/model/DocumentParameter.h>
|
|
#include <aws/ssm/model/PlatformType.h>
|
|
#include <aws/ssm/model/Tag.h>
|
|
#include <aws/ssm/model/AttachmentInformation.h>
|
|
#include <aws/ssm/model/DocumentRequires.h>
|
|
#include <aws/ssm/model/ReviewInformation.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace SSM
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Describes an Amazon Web Services Systems Manager document (SSM document).
|
|
* </p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DocumentDescription">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class DocumentDescription
|
|
{
|
|
public:
|
|
AWS_SSM_API DocumentDescription();
|
|
AWS_SSM_API DocumentDescription(Aws::Utils::Json::JsonView jsonValue);
|
|
AWS_SSM_API DocumentDescription& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
///@{
|
|
/**
|
|
* <p>The SHA1 hash of the document, which you can use for verification.</p>
|
|
*/
|
|
inline const Aws::String& GetSha1() const{ return m_sha1; }
|
|
inline bool Sha1HasBeenSet() const { return m_sha1HasBeenSet; }
|
|
inline void SetSha1(const Aws::String& value) { m_sha1HasBeenSet = true; m_sha1 = value; }
|
|
inline void SetSha1(Aws::String&& value) { m_sha1HasBeenSet = true; m_sha1 = std::move(value); }
|
|
inline void SetSha1(const char* value) { m_sha1HasBeenSet = true; m_sha1.assign(value); }
|
|
inline DocumentDescription& WithSha1(const Aws::String& value) { SetSha1(value); return *this;}
|
|
inline DocumentDescription& WithSha1(Aws::String&& value) { SetSha1(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithSha1(const char* value) { SetSha1(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The Sha256 or Sha1 hash created by the system when the document was created.
|
|
* </p> <p>Sha1 hashes have been deprecated.</p>
|
|
*/
|
|
inline const Aws::String& GetHash() const{ return m_hash; }
|
|
inline bool HashHasBeenSet() const { return m_hashHasBeenSet; }
|
|
inline void SetHash(const Aws::String& value) { m_hashHasBeenSet = true; m_hash = value; }
|
|
inline void SetHash(Aws::String&& value) { m_hashHasBeenSet = true; m_hash = std::move(value); }
|
|
inline void SetHash(const char* value) { m_hashHasBeenSet = true; m_hash.assign(value); }
|
|
inline DocumentDescription& WithHash(const Aws::String& value) { SetHash(value); return *this;}
|
|
inline DocumentDescription& WithHash(Aws::String&& value) { SetHash(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithHash(const char* value) { SetHash(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The hash type of the document. Valid values include <code>Sha256</code> or
|
|
* <code>Sha1</code>.</p> <p>Sha1 hashes have been deprecated.</p>
|
|
*/
|
|
inline const DocumentHashType& GetHashType() const{ return m_hashType; }
|
|
inline bool HashTypeHasBeenSet() const { return m_hashTypeHasBeenSet; }
|
|
inline void SetHashType(const DocumentHashType& value) { m_hashTypeHasBeenSet = true; m_hashType = value; }
|
|
inline void SetHashType(DocumentHashType&& value) { m_hashTypeHasBeenSet = true; m_hashType = std::move(value); }
|
|
inline DocumentDescription& WithHashType(const DocumentHashType& value) { SetHashType(value); return *this;}
|
|
inline DocumentDescription& WithHashType(DocumentHashType&& value) { SetHashType(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The name of the SSM document.</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 DocumentDescription& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
inline DocumentDescription& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
inline DocumentDescription& 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 DocumentDescription& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;}
|
|
inline DocumentDescription& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithDisplayName(const char* value) { SetDisplayName(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The version of the artifact associated with the document.</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 DocumentDescription& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;}
|
|
inline DocumentDescription& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithVersionName(const char* value) { SetVersionName(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The Amazon Web Services user that created the document.</p>
|
|
*/
|
|
inline const Aws::String& GetOwner() const{ return m_owner; }
|
|
inline bool OwnerHasBeenSet() const { return m_ownerHasBeenSet; }
|
|
inline void SetOwner(const Aws::String& value) { m_ownerHasBeenSet = true; m_owner = value; }
|
|
inline void SetOwner(Aws::String&& value) { m_ownerHasBeenSet = true; m_owner = std::move(value); }
|
|
inline void SetOwner(const char* value) { m_ownerHasBeenSet = true; m_owner.assign(value); }
|
|
inline DocumentDescription& WithOwner(const Aws::String& value) { SetOwner(value); return *this;}
|
|
inline DocumentDescription& WithOwner(Aws::String&& value) { SetOwner(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithOwner(const char* value) { SetOwner(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The date when 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 DocumentDescription& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;}
|
|
inline DocumentDescription& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The status of the SSM document.</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 DocumentDescription& WithStatus(const DocumentStatus& value) { SetStatus(value); return *this;}
|
|
inline DocumentDescription& 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 DocumentDescription& WithStatusInformation(const Aws::String& value) { SetStatusInformation(value); return *this;}
|
|
inline DocumentDescription& WithStatusInformation(Aws::String&& value) { SetStatusInformation(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithStatusInformation(const char* value) { SetStatusInformation(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 DocumentDescription& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;}
|
|
inline DocumentDescription& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A description of the document. </p>
|
|
*/
|
|
inline const Aws::String& GetDescription() const{ return m_description; }
|
|
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
|
|
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
|
|
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
|
|
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
|
|
inline DocumentDescription& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
|
|
inline DocumentDescription& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithDescription(const char* value) { SetDescription(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A description of the parameters for a document.</p>
|
|
*/
|
|
inline const Aws::Vector<DocumentParameter>& GetParameters() const{ return m_parameters; }
|
|
inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
|
|
inline void SetParameters(const Aws::Vector<DocumentParameter>& value) { m_parametersHasBeenSet = true; m_parameters = value; }
|
|
inline void SetParameters(Aws::Vector<DocumentParameter>&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); }
|
|
inline DocumentDescription& WithParameters(const Aws::Vector<DocumentParameter>& value) { SetParameters(value); return *this;}
|
|
inline DocumentDescription& WithParameters(Aws::Vector<DocumentParameter>&& value) { SetParameters(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddParameters(const DocumentParameter& value) { m_parametersHasBeenSet = true; m_parameters.push_back(value); return *this; }
|
|
inline DocumentDescription& AddParameters(DocumentParameter&& value) { m_parametersHasBeenSet = true; m_parameters.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The list of operating system (OS) platforms compatible with this SSM
|
|
* document. </p>
|
|
*/
|
|
inline const Aws::Vector<PlatformType>& GetPlatformTypes() const{ return m_platformTypes; }
|
|
inline bool PlatformTypesHasBeenSet() const { return m_platformTypesHasBeenSet; }
|
|
inline void SetPlatformTypes(const Aws::Vector<PlatformType>& value) { m_platformTypesHasBeenSet = true; m_platformTypes = value; }
|
|
inline void SetPlatformTypes(Aws::Vector<PlatformType>&& value) { m_platformTypesHasBeenSet = true; m_platformTypes = std::move(value); }
|
|
inline DocumentDescription& WithPlatformTypes(const Aws::Vector<PlatformType>& value) { SetPlatformTypes(value); return *this;}
|
|
inline DocumentDescription& WithPlatformTypes(Aws::Vector<PlatformType>&& value) { SetPlatformTypes(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddPlatformTypes(const PlatformType& value) { m_platformTypesHasBeenSet = true; m_platformTypes.push_back(value); return *this; }
|
|
inline DocumentDescription& AddPlatformTypes(PlatformType&& value) { m_platformTypesHasBeenSet = true; m_platformTypes.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The type of document.</p>
|
|
*/
|
|
inline const DocumentType& GetDocumentType() const{ return m_documentType; }
|
|
inline bool DocumentTypeHasBeenSet() const { return m_documentTypeHasBeenSet; }
|
|
inline void SetDocumentType(const DocumentType& value) { m_documentTypeHasBeenSet = true; m_documentType = value; }
|
|
inline void SetDocumentType(DocumentType&& value) { m_documentTypeHasBeenSet = true; m_documentType = std::move(value); }
|
|
inline DocumentDescription& WithDocumentType(const DocumentType& value) { SetDocumentType(value); return *this;}
|
|
inline DocumentDescription& WithDocumentType(DocumentType&& value) { SetDocumentType(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The schema version.</p>
|
|
*/
|
|
inline const Aws::String& GetSchemaVersion() const{ return m_schemaVersion; }
|
|
inline bool SchemaVersionHasBeenSet() const { return m_schemaVersionHasBeenSet; }
|
|
inline void SetSchemaVersion(const Aws::String& value) { m_schemaVersionHasBeenSet = true; m_schemaVersion = value; }
|
|
inline void SetSchemaVersion(Aws::String&& value) { m_schemaVersionHasBeenSet = true; m_schemaVersion = std::move(value); }
|
|
inline void SetSchemaVersion(const char* value) { m_schemaVersionHasBeenSet = true; m_schemaVersion.assign(value); }
|
|
inline DocumentDescription& WithSchemaVersion(const Aws::String& value) { SetSchemaVersion(value); return *this;}
|
|
inline DocumentDescription& WithSchemaVersion(Aws::String&& value) { SetSchemaVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithSchemaVersion(const char* value) { SetSchemaVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The latest version of the document.</p>
|
|
*/
|
|
inline const Aws::String& GetLatestVersion() const{ return m_latestVersion; }
|
|
inline bool LatestVersionHasBeenSet() const { return m_latestVersionHasBeenSet; }
|
|
inline void SetLatestVersion(const Aws::String& value) { m_latestVersionHasBeenSet = true; m_latestVersion = value; }
|
|
inline void SetLatestVersion(Aws::String&& value) { m_latestVersionHasBeenSet = true; m_latestVersion = std::move(value); }
|
|
inline void SetLatestVersion(const char* value) { m_latestVersionHasBeenSet = true; m_latestVersion.assign(value); }
|
|
inline DocumentDescription& WithLatestVersion(const Aws::String& value) { SetLatestVersion(value); return *this;}
|
|
inline DocumentDescription& WithLatestVersion(Aws::String&& value) { SetLatestVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithLatestVersion(const char* value) { SetLatestVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The default version.</p>
|
|
*/
|
|
inline const Aws::String& GetDefaultVersion() const{ return m_defaultVersion; }
|
|
inline bool DefaultVersionHasBeenSet() const { return m_defaultVersionHasBeenSet; }
|
|
inline void SetDefaultVersion(const Aws::String& value) { m_defaultVersionHasBeenSet = true; m_defaultVersion = value; }
|
|
inline void SetDefaultVersion(Aws::String&& value) { m_defaultVersionHasBeenSet = true; m_defaultVersion = std::move(value); }
|
|
inline void SetDefaultVersion(const char* value) { m_defaultVersionHasBeenSet = true; m_defaultVersion.assign(value); }
|
|
inline DocumentDescription& WithDefaultVersion(const Aws::String& value) { SetDefaultVersion(value); return *this;}
|
|
inline DocumentDescription& WithDefaultVersion(Aws::String&& value) { SetDefaultVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithDefaultVersion(const char* value) { SetDefaultVersion(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 DocumentDescription& WithDocumentFormat(const DocumentFormat& value) { SetDocumentFormat(value); return *this;}
|
|
inline DocumentDescription& WithDocumentFormat(DocumentFormat&& value) { SetDocumentFormat(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The target type which defines the kinds of resources the document can run on.
|
|
* For example, <code>/AWS::EC2::Instance</code>. For a list of valid resource
|
|
* types, see <a
|
|
* href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon
|
|
* Web Services resource and property types reference</a> in the <i>CloudFormation
|
|
* User Guide</i>. </p>
|
|
*/
|
|
inline const Aws::String& GetTargetType() const{ return m_targetType; }
|
|
inline bool TargetTypeHasBeenSet() const { return m_targetTypeHasBeenSet; }
|
|
inline void SetTargetType(const Aws::String& value) { m_targetTypeHasBeenSet = true; m_targetType = value; }
|
|
inline void SetTargetType(Aws::String&& value) { m_targetTypeHasBeenSet = true; m_targetType = std::move(value); }
|
|
inline void SetTargetType(const char* value) { m_targetTypeHasBeenSet = true; m_targetType.assign(value); }
|
|
inline DocumentDescription& WithTargetType(const Aws::String& value) { SetTargetType(value); return *this;}
|
|
inline DocumentDescription& WithTargetType(Aws::String&& value) { SetTargetType(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithTargetType(const char* value) { SetTargetType(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The tags, or metadata, that have been applied to the document.</p>
|
|
*/
|
|
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
|
|
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
|
|
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
|
|
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
|
|
inline DocumentDescription& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
|
|
inline DocumentDescription& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
|
|
inline DocumentDescription& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Details about the document attachments, including names, locations, sizes,
|
|
* and so on.</p>
|
|
*/
|
|
inline const Aws::Vector<AttachmentInformation>& GetAttachmentsInformation() const{ return m_attachmentsInformation; }
|
|
inline bool AttachmentsInformationHasBeenSet() const { return m_attachmentsInformationHasBeenSet; }
|
|
inline void SetAttachmentsInformation(const Aws::Vector<AttachmentInformation>& value) { m_attachmentsInformationHasBeenSet = true; m_attachmentsInformation = value; }
|
|
inline void SetAttachmentsInformation(Aws::Vector<AttachmentInformation>&& value) { m_attachmentsInformationHasBeenSet = true; m_attachmentsInformation = std::move(value); }
|
|
inline DocumentDescription& WithAttachmentsInformation(const Aws::Vector<AttachmentInformation>& value) { SetAttachmentsInformation(value); return *this;}
|
|
inline DocumentDescription& WithAttachmentsInformation(Aws::Vector<AttachmentInformation>&& value) { SetAttachmentsInformation(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddAttachmentsInformation(const AttachmentInformation& value) { m_attachmentsInformationHasBeenSet = true; m_attachmentsInformation.push_back(value); return *this; }
|
|
inline DocumentDescription& AddAttachmentsInformation(AttachmentInformation&& value) { m_attachmentsInformationHasBeenSet = true; m_attachmentsInformation.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A list of SSM documents required by a document. For example, an
|
|
* <code>ApplicationConfiguration</code> document requires an
|
|
* <code>ApplicationConfigurationSchema</code> document.</p>
|
|
*/
|
|
inline const Aws::Vector<DocumentRequires>& GetRequires() const{ return m_requires; }
|
|
inline bool RequiresHasBeenSet() const { return m_requiresHasBeenSet; }
|
|
inline void SetRequires(const Aws::Vector<DocumentRequires>& value) { m_requiresHasBeenSet = true; m_requires = value; }
|
|
inline void SetRequires(Aws::Vector<DocumentRequires>&& value) { m_requiresHasBeenSet = true; m_requires = std::move(value); }
|
|
inline DocumentDescription& WithRequires(const Aws::Vector<DocumentRequires>& value) { SetRequires(value); return *this;}
|
|
inline DocumentDescription& WithRequires(Aws::Vector<DocumentRequires>&& value) { SetRequires(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddRequires(const DocumentRequires& value) { m_requiresHasBeenSet = true; m_requires.push_back(value); return *this; }
|
|
inline DocumentDescription& AddRequires(DocumentRequires&& value) { m_requiresHasBeenSet = true; m_requires.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The user in your organization who created the document.</p>
|
|
*/
|
|
inline const Aws::String& GetAuthor() const{ return m_author; }
|
|
inline bool AuthorHasBeenSet() const { return m_authorHasBeenSet; }
|
|
inline void SetAuthor(const Aws::String& value) { m_authorHasBeenSet = true; m_author = value; }
|
|
inline void SetAuthor(Aws::String&& value) { m_authorHasBeenSet = true; m_author = std::move(value); }
|
|
inline void SetAuthor(const char* value) { m_authorHasBeenSet = true; m_author.assign(value); }
|
|
inline DocumentDescription& WithAuthor(const Aws::String& value) { SetAuthor(value); return *this;}
|
|
inline DocumentDescription& WithAuthor(Aws::String&& value) { SetAuthor(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithAuthor(const char* value) { SetAuthor(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Details about the review of a document.</p>
|
|
*/
|
|
inline const Aws::Vector<ReviewInformation>& GetReviewInformation() const{ return m_reviewInformation; }
|
|
inline bool ReviewInformationHasBeenSet() const { return m_reviewInformationHasBeenSet; }
|
|
inline void SetReviewInformation(const Aws::Vector<ReviewInformation>& value) { m_reviewInformationHasBeenSet = true; m_reviewInformation = value; }
|
|
inline void SetReviewInformation(Aws::Vector<ReviewInformation>&& value) { m_reviewInformationHasBeenSet = true; m_reviewInformation = std::move(value); }
|
|
inline DocumentDescription& WithReviewInformation(const Aws::Vector<ReviewInformation>& value) { SetReviewInformation(value); return *this;}
|
|
inline DocumentDescription& WithReviewInformation(Aws::Vector<ReviewInformation>&& value) { SetReviewInformation(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddReviewInformation(const ReviewInformation& value) { m_reviewInformationHasBeenSet = true; m_reviewInformation.push_back(value); return *this; }
|
|
inline DocumentDescription& AddReviewInformation(ReviewInformation&& value) { m_reviewInformationHasBeenSet = true; m_reviewInformation.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The version of the document currently approved for use in the
|
|
* organization.</p>
|
|
*/
|
|
inline const Aws::String& GetApprovedVersion() const{ return m_approvedVersion; }
|
|
inline bool ApprovedVersionHasBeenSet() const { return m_approvedVersionHasBeenSet; }
|
|
inline void SetApprovedVersion(const Aws::String& value) { m_approvedVersionHasBeenSet = true; m_approvedVersion = value; }
|
|
inline void SetApprovedVersion(Aws::String&& value) { m_approvedVersionHasBeenSet = true; m_approvedVersion = std::move(value); }
|
|
inline void SetApprovedVersion(const char* value) { m_approvedVersionHasBeenSet = true; m_approvedVersion.assign(value); }
|
|
inline DocumentDescription& WithApprovedVersion(const Aws::String& value) { SetApprovedVersion(value); return *this;}
|
|
inline DocumentDescription& WithApprovedVersion(Aws::String&& value) { SetApprovedVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithApprovedVersion(const char* value) { SetApprovedVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The version of the document that is currently under review.</p>
|
|
*/
|
|
inline const Aws::String& GetPendingReviewVersion() const{ return m_pendingReviewVersion; }
|
|
inline bool PendingReviewVersionHasBeenSet() const { return m_pendingReviewVersionHasBeenSet; }
|
|
inline void SetPendingReviewVersion(const Aws::String& value) { m_pendingReviewVersionHasBeenSet = true; m_pendingReviewVersion = value; }
|
|
inline void SetPendingReviewVersion(Aws::String&& value) { m_pendingReviewVersionHasBeenSet = true; m_pendingReviewVersion = std::move(value); }
|
|
inline void SetPendingReviewVersion(const char* value) { m_pendingReviewVersionHasBeenSet = true; m_pendingReviewVersion.assign(value); }
|
|
inline DocumentDescription& WithPendingReviewVersion(const Aws::String& value) { SetPendingReviewVersion(value); return *this;}
|
|
inline DocumentDescription& WithPendingReviewVersion(Aws::String&& value) { SetPendingReviewVersion(std::move(value)); return *this;}
|
|
inline DocumentDescription& WithPendingReviewVersion(const char* value) { SetPendingReviewVersion(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The current status of the review.</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 DocumentDescription& WithReviewStatus(const ReviewStatus& value) { SetReviewStatus(value); return *this;}
|
|
inline DocumentDescription& WithReviewStatus(ReviewStatus&& value) { SetReviewStatus(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The classification of a document to help you identify and categorize its
|
|
* use.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetCategory() const{ return m_category; }
|
|
inline bool CategoryHasBeenSet() const { return m_categoryHasBeenSet; }
|
|
inline void SetCategory(const Aws::Vector<Aws::String>& value) { m_categoryHasBeenSet = true; m_category = value; }
|
|
inline void SetCategory(Aws::Vector<Aws::String>&& value) { m_categoryHasBeenSet = true; m_category = std::move(value); }
|
|
inline DocumentDescription& WithCategory(const Aws::Vector<Aws::String>& value) { SetCategory(value); return *this;}
|
|
inline DocumentDescription& WithCategory(Aws::Vector<Aws::String>&& value) { SetCategory(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddCategory(const Aws::String& value) { m_categoryHasBeenSet = true; m_category.push_back(value); return *this; }
|
|
inline DocumentDescription& AddCategory(Aws::String&& value) { m_categoryHasBeenSet = true; m_category.push_back(std::move(value)); return *this; }
|
|
inline DocumentDescription& AddCategory(const char* value) { m_categoryHasBeenSet = true; m_category.push_back(value); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The value that identifies a document's category.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetCategoryEnum() const{ return m_categoryEnum; }
|
|
inline bool CategoryEnumHasBeenSet() const { return m_categoryEnumHasBeenSet; }
|
|
inline void SetCategoryEnum(const Aws::Vector<Aws::String>& value) { m_categoryEnumHasBeenSet = true; m_categoryEnum = value; }
|
|
inline void SetCategoryEnum(Aws::Vector<Aws::String>&& value) { m_categoryEnumHasBeenSet = true; m_categoryEnum = std::move(value); }
|
|
inline DocumentDescription& WithCategoryEnum(const Aws::Vector<Aws::String>& value) { SetCategoryEnum(value); return *this;}
|
|
inline DocumentDescription& WithCategoryEnum(Aws::Vector<Aws::String>&& value) { SetCategoryEnum(std::move(value)); return *this;}
|
|
inline DocumentDescription& AddCategoryEnum(const Aws::String& value) { m_categoryEnumHasBeenSet = true; m_categoryEnum.push_back(value); return *this; }
|
|
inline DocumentDescription& AddCategoryEnum(Aws::String&& value) { m_categoryEnumHasBeenSet = true; m_categoryEnum.push_back(std::move(value)); return *this; }
|
|
inline DocumentDescription& AddCategoryEnum(const char* value) { m_categoryEnumHasBeenSet = true; m_categoryEnum.push_back(value); return *this; }
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_sha1;
|
|
bool m_sha1HasBeenSet = false;
|
|
|
|
Aws::String m_hash;
|
|
bool m_hashHasBeenSet = false;
|
|
|
|
DocumentHashType m_hashType;
|
|
bool m_hashTypeHasBeenSet = false;
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet = false;
|
|
|
|
Aws::String m_displayName;
|
|
bool m_displayNameHasBeenSet = false;
|
|
|
|
Aws::String m_versionName;
|
|
bool m_versionNameHasBeenSet = false;
|
|
|
|
Aws::String m_owner;
|
|
bool m_ownerHasBeenSet = false;
|
|
|
|
Aws::Utils::DateTime m_createdDate;
|
|
bool m_createdDateHasBeenSet = false;
|
|
|
|
DocumentStatus m_status;
|
|
bool m_statusHasBeenSet = false;
|
|
|
|
Aws::String m_statusInformation;
|
|
bool m_statusInformationHasBeenSet = false;
|
|
|
|
Aws::String m_documentVersion;
|
|
bool m_documentVersionHasBeenSet = false;
|
|
|
|
Aws::String m_description;
|
|
bool m_descriptionHasBeenSet = false;
|
|
|
|
Aws::Vector<DocumentParameter> m_parameters;
|
|
bool m_parametersHasBeenSet = false;
|
|
|
|
Aws::Vector<PlatformType> m_platformTypes;
|
|
bool m_platformTypesHasBeenSet = false;
|
|
|
|
DocumentType m_documentType;
|
|
bool m_documentTypeHasBeenSet = false;
|
|
|
|
Aws::String m_schemaVersion;
|
|
bool m_schemaVersionHasBeenSet = false;
|
|
|
|
Aws::String m_latestVersion;
|
|
bool m_latestVersionHasBeenSet = false;
|
|
|
|
Aws::String m_defaultVersion;
|
|
bool m_defaultVersionHasBeenSet = false;
|
|
|
|
DocumentFormat m_documentFormat;
|
|
bool m_documentFormatHasBeenSet = false;
|
|
|
|
Aws::String m_targetType;
|
|
bool m_targetTypeHasBeenSet = false;
|
|
|
|
Aws::Vector<Tag> m_tags;
|
|
bool m_tagsHasBeenSet = false;
|
|
|
|
Aws::Vector<AttachmentInformation> m_attachmentsInformation;
|
|
bool m_attachmentsInformationHasBeenSet = false;
|
|
|
|
Aws::Vector<DocumentRequires> m_requires;
|
|
bool m_requiresHasBeenSet = false;
|
|
|
|
Aws::String m_author;
|
|
bool m_authorHasBeenSet = false;
|
|
|
|
Aws::Vector<ReviewInformation> m_reviewInformation;
|
|
bool m_reviewInformationHasBeenSet = false;
|
|
|
|
Aws::String m_approvedVersion;
|
|
bool m_approvedVersionHasBeenSet = false;
|
|
|
|
Aws::String m_pendingReviewVersion;
|
|
bool m_pendingReviewVersionHasBeenSet = false;
|
|
|
|
ReviewStatus m_reviewStatus;
|
|
bool m_reviewStatusHasBeenSet = false;
|
|
|
|
Aws::Vector<Aws::String> m_category;
|
|
bool m_categoryHasBeenSet = false;
|
|
|
|
Aws::Vector<Aws::String> m_categoryEnum;
|
|
bool m_categoryEnumHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace SSM
|
|
} // namespace Aws
|