/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes an Amazon Web Services Systems Manager document (SSM document).
* See Also:
AWS
* API Reference
The SHA1 hash of the document, which you can use for verification.
*/ 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;} ///@} ///@{ /** *The Sha256 or Sha1 hash created by the system when the document was created. *
Sha1 hashes have been deprecated.
*/ 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;} ///@} ///@{ /** *The hash type of the document. Valid values include Sha256 or
* Sha1.
Sha1 hashes have been deprecated.
*/ 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;} ///@} ///@{ /** *The name of the SSM document.
*/ 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;} ///@} ///@{ /** *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 * UpdateDocument.
*/ 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;} ///@} ///@{ /** *The version of the artifact associated with the document.
*/ 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;} ///@} ///@{ /** *The Amazon Web Services user that created the document.
*/ 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;} ///@} ///@{ /** *The date when the document was created.
*/ 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;} ///@} ///@{ /** *The status of the SSM document.
*/ 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;} ///@} ///@{ /** *A message returned by Amazon Web Services Systems Manager that explains the
* Status value. For example, a Failed status might be
* explained by the StatusInformation message, "The specified S3
* bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
The document version.
*/ 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;} ///@} ///@{ /** *A description of the document.
*/ 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;} ///@} ///@{ /** *A description of the parameters for a document.
*/ inline const Aws::VectorThe list of operating system (OS) platforms compatible with this SSM * document.
*/ inline const Aws::VectorThe type of document.
*/ 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;} ///@} ///@{ /** *The schema version.
*/ 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;} ///@} ///@{ /** *The latest version of the document.
*/ 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;} ///@} ///@{ /** *The default version.
*/ 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;} ///@} ///@{ /** *The document format, either JSON or YAML.
*/ 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;} ///@} ///@{ /** *The target type which defines the kinds of resources the document can run on.
* For example, /AWS::EC2::Instance. For a list of valid resource
* types, see Amazon
* Web Services resource and property types reference in the CloudFormation
* User Guide.
The tags, or metadata, that have been applied to the document.
*/ inline const Aws::VectorDetails about the document attachments, including names, locations, sizes, * and so on.
*/ inline const Aws::VectorA list of SSM documents required by a document. For example, an
* ApplicationConfiguration document requires an
* ApplicationConfigurationSchema document.
The user in your organization who created the document.
*/ 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;} ///@} ///@{ /** *Details about the review of a document.
*/ inline const Aws::VectorThe version of the document currently approved for use in the * organization.
*/ 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;} ///@} ///@{ /** *The version of the document that is currently under review.
*/ 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;} ///@} ///@{ /** *The current status of the review.
*/ 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;} ///@} ///@{ /** *The classification of a document to help you identify and categorize its * use.
*/ inline const Aws::VectorThe value that identifies a document's category.
*/ inline const Aws::Vector