/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SSM { namespace Model { /** *

Describes the name of a SSM document.

See Also:

AWS * API Reference

*/ class DocumentIdentifier { public: AWS_SSM_API DocumentIdentifier(); AWS_SSM_API DocumentIdentifier(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API DocumentIdentifier& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the SSM document.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the SSM document.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the SSM document.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the SSM document.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the SSM document.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the SSM document.

*/ inline DocumentIdentifier& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the SSM document.

*/ inline DocumentIdentifier& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the SSM document.

*/ inline DocumentIdentifier& WithName(const char* value) { SetName(value); return *this;} /** *

The date the SSM document was created.

*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *

The date the SSM document was created.

*/ inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; } /** *

The date the SSM document was created.

*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; } /** *

The date the SSM document was created.

*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); } /** *

The date the SSM document was created.

*/ inline DocumentIdentifier& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *

The date the SSM document was created.

*/ inline DocumentIdentifier& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *

An optional field where you can specify a friendly name for 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; } /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; } /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; } /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); } /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); } /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline DocumentIdentifier& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;} /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline DocumentIdentifier& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;} /** *

An optional field where you can specify a friendly name for the SSM document. * This value can differ for each version of the document. If you want to update * this value, see UpdateDocument.

*/ inline DocumentIdentifier& WithDisplayName(const char* value) { SetDisplayName(value); return *this;} /** *

The Amazon Web Services user that created the document.

*/ inline const Aws::String& GetOwner() const{ return m_owner; } /** *

The Amazon Web Services user that created the document.

*/ inline bool OwnerHasBeenSet() const { return m_ownerHasBeenSet; } /** *

The Amazon Web Services user that created the document.

*/ inline void SetOwner(const Aws::String& value) { m_ownerHasBeenSet = true; m_owner = value; } /** *

The Amazon Web Services user that created the document.

*/ inline void SetOwner(Aws::String&& value) { m_ownerHasBeenSet = true; m_owner = std::move(value); } /** *

The Amazon Web Services user that created the document.

*/ inline void SetOwner(const char* value) { m_ownerHasBeenSet = true; m_owner.assign(value); } /** *

The Amazon Web Services user that created the document.

*/ inline DocumentIdentifier& WithOwner(const Aws::String& value) { SetOwner(value); return *this;} /** *

The Amazon Web Services user that created the document.

*/ inline DocumentIdentifier& WithOwner(Aws::String&& value) { SetOwner(std::move(value)); return *this;} /** *

The Amazon Web Services user that created the document.

*/ inline DocumentIdentifier& WithOwner(const char* value) { SetOwner(value); return *this;} /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline const Aws::String& GetVersionName() const{ return m_versionName; } /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline bool VersionNameHasBeenSet() const { return m_versionNameHasBeenSet; } /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline void SetVersionName(const Aws::String& value) { m_versionNameHasBeenSet = true; m_versionName = value; } /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline void SetVersionName(Aws::String&& value) { m_versionNameHasBeenSet = true; m_versionName = std::move(value); } /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline void SetVersionName(const char* value) { m_versionNameHasBeenSet = true; m_versionName.assign(value); } /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline DocumentIdentifier& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;} /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline DocumentIdentifier& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;} /** *

An optional field specifying the version of the artifact associated with the * document. For example, "Release 12, Update 6". This value is unique across all * versions of a document, and can't be changed.

*/ inline DocumentIdentifier& WithVersionName(const char* value) { SetVersionName(value); return *this;} /** *

The operating system platform.

*/ inline const Aws::Vector& GetPlatformTypes() const{ return m_platformTypes; } /** *

The operating system platform.

*/ inline bool PlatformTypesHasBeenSet() const { return m_platformTypesHasBeenSet; } /** *

The operating system platform.

*/ inline void SetPlatformTypes(const Aws::Vector& value) { m_platformTypesHasBeenSet = true; m_platformTypes = value; } /** *

The operating system platform.

*/ inline void SetPlatformTypes(Aws::Vector&& value) { m_platformTypesHasBeenSet = true; m_platformTypes = std::move(value); } /** *

The operating system platform.

*/ inline DocumentIdentifier& WithPlatformTypes(const Aws::Vector& value) { SetPlatformTypes(value); return *this;} /** *

The operating system platform.

*/ inline DocumentIdentifier& WithPlatformTypes(Aws::Vector&& value) { SetPlatformTypes(std::move(value)); return *this;} /** *

The operating system platform.

*/ inline DocumentIdentifier& AddPlatformTypes(const PlatformType& value) { m_platformTypesHasBeenSet = true; m_platformTypes.push_back(value); return *this; } /** *

The operating system platform.

*/ inline DocumentIdentifier& AddPlatformTypes(PlatformType&& value) { m_platformTypesHasBeenSet = true; m_platformTypes.push_back(std::move(value)); return *this; } /** *

The document version.

*/ inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; } /** *

The document version.

*/ inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; } /** *

The document version.

*/ inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; } /** *

The document version.

*/ inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); } /** *

The document version.

*/ inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); } /** *

The document version.

*/ inline DocumentIdentifier& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} /** *

The document version.

*/ inline DocumentIdentifier& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} /** *

The document version.

*/ inline DocumentIdentifier& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;} /** *

The document type.

*/ inline const DocumentType& GetDocumentType() const{ return m_documentType; } /** *

The document type.

*/ inline bool DocumentTypeHasBeenSet() const { return m_documentTypeHasBeenSet; } /** *

The document type.

*/ inline void SetDocumentType(const DocumentType& value) { m_documentTypeHasBeenSet = true; m_documentType = value; } /** *

The document type.

*/ inline void SetDocumentType(DocumentType&& value) { m_documentTypeHasBeenSet = true; m_documentType = std::move(value); } /** *

The document type.

*/ inline DocumentIdentifier& WithDocumentType(const DocumentType& value) { SetDocumentType(value); return *this;} /** *

The document type.

*/ inline DocumentIdentifier& WithDocumentType(DocumentType&& value) { SetDocumentType(std::move(value)); return *this;} /** *

The schema version.

*/ inline const Aws::String& GetSchemaVersion() const{ return m_schemaVersion; } /** *

The schema version.

*/ inline bool SchemaVersionHasBeenSet() const { return m_schemaVersionHasBeenSet; } /** *

The schema version.

*/ inline void SetSchemaVersion(const Aws::String& value) { m_schemaVersionHasBeenSet = true; m_schemaVersion = value; } /** *

The schema version.

*/ inline void SetSchemaVersion(Aws::String&& value) { m_schemaVersionHasBeenSet = true; m_schemaVersion = std::move(value); } /** *

The schema version.

*/ inline void SetSchemaVersion(const char* value) { m_schemaVersionHasBeenSet = true; m_schemaVersion.assign(value); } /** *

The schema version.

*/ inline DocumentIdentifier& WithSchemaVersion(const Aws::String& value) { SetSchemaVersion(value); return *this;} /** *

The schema version.

*/ inline DocumentIdentifier& WithSchemaVersion(Aws::String&& value) { SetSchemaVersion(std::move(value)); return *this;} /** *

The schema version.

*/ inline DocumentIdentifier& WithSchemaVersion(const char* value) { SetSchemaVersion(value); return *this;} /** *

The document format, either JSON or YAML.

*/ inline const DocumentFormat& GetDocumentFormat() const{ return m_documentFormat; } /** *

The document format, either JSON or YAML.

*/ inline bool DocumentFormatHasBeenSet() const { return m_documentFormatHasBeenSet; } /** *

The document format, either JSON or YAML.

*/ inline void SetDocumentFormat(const DocumentFormat& value) { m_documentFormatHasBeenSet = true; m_documentFormat = value; } /** *

The document format, either JSON or YAML.

*/ inline void SetDocumentFormat(DocumentFormat&& value) { m_documentFormatHasBeenSet = true; m_documentFormat = std::move(value); } /** *

The document format, either JSON or YAML.

*/ inline DocumentIdentifier& WithDocumentFormat(const DocumentFormat& value) { SetDocumentFormat(value); return *this;} /** *

The document format, either JSON or YAML.

*/ inline DocumentIdentifier& 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.

*/ inline const Aws::String& GetTargetType() const{ return m_targetType; } /** *

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.

*/ inline bool TargetTypeHasBeenSet() const { return m_targetTypeHasBeenSet; } /** *

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.

*/ inline void SetTargetType(const Aws::String& value) { m_targetTypeHasBeenSet = true; m_targetType = value; } /** *

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.

*/ inline void SetTargetType(Aws::String&& value) { m_targetTypeHasBeenSet = true; m_targetType = std::move(value); } /** *

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.

*/ inline void SetTargetType(const char* value) { m_targetTypeHasBeenSet = true; m_targetType.assign(value); } /** *

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.

*/ inline DocumentIdentifier& WithTargetType(const Aws::String& value) { SetTargetType(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.

*/ inline DocumentIdentifier& WithTargetType(Aws::String&& value) { SetTargetType(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.

*/ inline DocumentIdentifier& WithTargetType(const char* value) { SetTargetType(value); return *this;} /** *

The tags, or metadata, that have been applied to the document.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

The tags, or metadata, that have been applied to the document.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The tags, or metadata, that have been applied to the document.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The tags, or metadata, that have been applied to the document.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The tags, or metadata, that have been applied to the document.

*/ inline DocumentIdentifier& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

The tags, or metadata, that have been applied to the document.

*/ inline DocumentIdentifier& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

The tags, or metadata, that have been applied to the document.

*/ inline DocumentIdentifier& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

The tags, or metadata, that have been applied to the document.

*/ inline DocumentIdentifier& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline const Aws::Vector& GetRequires() const{ return m_requires; } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline bool RequiresHasBeenSet() const { return m_requiresHasBeenSet; } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline void SetRequires(const Aws::Vector& value) { m_requiresHasBeenSet = true; m_requires = value; } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline void SetRequires(Aws::Vector&& value) { m_requiresHasBeenSet = true; m_requires = std::move(value); } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline DocumentIdentifier& WithRequires(const Aws::Vector& value) { SetRequires(value); return *this;} /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline DocumentIdentifier& WithRequires(Aws::Vector&& value) { SetRequires(std::move(value)); return *this;} /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline DocumentIdentifier& AddRequires(const DocumentRequires& value) { m_requiresHasBeenSet = true; m_requires.push_back(value); return *this; } /** *

A list of SSM documents required by a document. For example, an * ApplicationConfiguration document requires an * ApplicationConfigurationSchema document.

*/ inline DocumentIdentifier& AddRequires(DocumentRequires&& value) { m_requiresHasBeenSet = true; m_requires.push_back(std::move(value)); return *this; } /** *

The current status of a document review.

*/ inline const ReviewStatus& GetReviewStatus() const{ return m_reviewStatus; } /** *

The current status of a document review.

*/ inline bool ReviewStatusHasBeenSet() const { return m_reviewStatusHasBeenSet; } /** *

The current status of a document review.

*/ inline void SetReviewStatus(const ReviewStatus& value) { m_reviewStatusHasBeenSet = true; m_reviewStatus = value; } /** *

The current status of a document review.

*/ inline void SetReviewStatus(ReviewStatus&& value) { m_reviewStatusHasBeenSet = true; m_reviewStatus = std::move(value); } /** *

The current status of a document review.

*/ inline DocumentIdentifier& WithReviewStatus(const ReviewStatus& value) { SetReviewStatus(value); return *this;} /** *

The current status of a document review.

*/ inline DocumentIdentifier& WithReviewStatus(ReviewStatus&& value) { SetReviewStatus(std::move(value)); return *this;} /** *

The user in your organization who created the document.

*/ inline const Aws::String& GetAuthor() const{ return m_author; } /** *

The user in your organization who created the document.

*/ inline bool AuthorHasBeenSet() const { return m_authorHasBeenSet; } /** *

The user in your organization who created the document.

*/ inline void SetAuthor(const Aws::String& value) { m_authorHasBeenSet = true; m_author = value; } /** *

The user in your organization who created the document.

*/ inline void SetAuthor(Aws::String&& value) { m_authorHasBeenSet = true; m_author = std::move(value); } /** *

The user in your organization who created the document.

*/ inline void SetAuthor(const char* value) { m_authorHasBeenSet = true; m_author.assign(value); } /** *

The user in your organization who created the document.

*/ inline DocumentIdentifier& WithAuthor(const Aws::String& value) { SetAuthor(value); return *this;} /** *

The user in your organization who created the document.

*/ inline DocumentIdentifier& WithAuthor(Aws::String&& value) { SetAuthor(std::move(value)); return *this;} /** *

The user in your organization who created the document.

*/ inline DocumentIdentifier& WithAuthor(const char* value) { SetAuthor(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::Utils::DateTime m_createdDate; bool m_createdDateHasBeenSet = false; Aws::String m_displayName; bool m_displayNameHasBeenSet = false; Aws::String m_owner; bool m_ownerHasBeenSet = false; Aws::String m_versionName; bool m_versionNameHasBeenSet = false; Aws::Vector m_platformTypes; bool m_platformTypesHasBeenSet = false; Aws::String m_documentVersion; bool m_documentVersionHasBeenSet = false; DocumentType m_documentType; bool m_documentTypeHasBeenSet = false; Aws::String m_schemaVersion; bool m_schemaVersionHasBeenSet = false; DocumentFormat m_documentFormat; bool m_documentFormatHasBeenSet = false; Aws::String m_targetType; bool m_targetTypeHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; Aws::Vector m_requires; bool m_requiresHasBeenSet = false; ReviewStatus m_reviewStatus; bool m_reviewStatusHasBeenSet = false; Aws::String m_author; bool m_authorHasBeenSet = false; }; } // namespace Model } // namespace SSM } // namespace Aws