AWS SDK for C++  1.9.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::CreateDocumentRequest Class Reference

#include <CreateDocumentRequest.h>

+ Inheritance diagram for Aws::SSM::Model::CreateDocumentRequest:

Public Member Functions

 CreateDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetContent () const
 
bool ContentHasBeenSet () const
 
void SetContent (const Aws::String &value)
 
void SetContent (Aws::String &&value)
 
void SetContent (const char *value)
 
CreateDocumentRequestWithContent (const Aws::String &value)
 
CreateDocumentRequestWithContent (Aws::String &&value)
 
CreateDocumentRequestWithContent (const char *value)
 
const Aws::Vector< DocumentRequires > & GetRequires () const
 
bool RequiresHasBeenSet () const
 
void SetRequires (const Aws::Vector< DocumentRequires > &value)
 
void SetRequires (Aws::Vector< DocumentRequires > &&value)
 
CreateDocumentRequestWithRequires (const Aws::Vector< DocumentRequires > &value)
 
CreateDocumentRequestWithRequires (Aws::Vector< DocumentRequires > &&value)
 
CreateDocumentRequestAddRequires (const DocumentRequires &value)
 
CreateDocumentRequestAddRequires (DocumentRequires &&value)
 
const Aws::Vector< AttachmentsSource > & GetAttachments () const
 
bool AttachmentsHasBeenSet () const
 
void SetAttachments (const Aws::Vector< AttachmentsSource > &value)
 
void SetAttachments (Aws::Vector< AttachmentsSource > &&value)
 
CreateDocumentRequestWithAttachments (const Aws::Vector< AttachmentsSource > &value)
 
CreateDocumentRequestWithAttachments (Aws::Vector< AttachmentsSource > &&value)
 
CreateDocumentRequestAddAttachments (const AttachmentsSource &value)
 
CreateDocumentRequestAddAttachments (AttachmentsSource &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateDocumentRequestWithName (const Aws::String &value)
 
CreateDocumentRequestWithName (Aws::String &&value)
 
CreateDocumentRequestWithName (const char *value)
 
const Aws::StringGetDisplayName () const
 
bool DisplayNameHasBeenSet () const
 
void SetDisplayName (const Aws::String &value)
 
void SetDisplayName (Aws::String &&value)
 
void SetDisplayName (const char *value)
 
CreateDocumentRequestWithDisplayName (const Aws::String &value)
 
CreateDocumentRequestWithDisplayName (Aws::String &&value)
 
CreateDocumentRequestWithDisplayName (const char *value)
 
const Aws::StringGetVersionName () const
 
bool VersionNameHasBeenSet () const
 
void SetVersionName (const Aws::String &value)
 
void SetVersionName (Aws::String &&value)
 
void SetVersionName (const char *value)
 
CreateDocumentRequestWithVersionName (const Aws::String &value)
 
CreateDocumentRequestWithVersionName (Aws::String &&value)
 
CreateDocumentRequestWithVersionName (const char *value)
 
const DocumentTypeGetDocumentType () const
 
bool DocumentTypeHasBeenSet () const
 
void SetDocumentType (const DocumentType &value)
 
void SetDocumentType (DocumentType &&value)
 
CreateDocumentRequestWithDocumentType (const DocumentType &value)
 
CreateDocumentRequestWithDocumentType (DocumentType &&value)
 
const DocumentFormatGetDocumentFormat () const
 
bool DocumentFormatHasBeenSet () const
 
void SetDocumentFormat (const DocumentFormat &value)
 
void SetDocumentFormat (DocumentFormat &&value)
 
CreateDocumentRequestWithDocumentFormat (const DocumentFormat &value)
 
CreateDocumentRequestWithDocumentFormat (DocumentFormat &&value)
 
const Aws::StringGetTargetType () const
 
bool TargetTypeHasBeenSet () const
 
void SetTargetType (const Aws::String &value)
 
void SetTargetType (Aws::String &&value)
 
void SetTargetType (const char *value)
 
CreateDocumentRequestWithTargetType (const Aws::String &value)
 
CreateDocumentRequestWithTargetType (Aws::String &&value)
 
CreateDocumentRequestWithTargetType (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDocumentRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDocumentRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDocumentRequestAddTags (const Tag &value)
 
CreateDocumentRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file CreateDocumentRequest.h.

Constructor & Destructor Documentation

◆ CreateDocumentRequest()

Aws::SSM::Model::CreateDocumentRequest::CreateDocumentRequest ( )

Member Function Documentation

◆ AddAttachments() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddAttachments ( AttachmentsSource &&  value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 307 of file CreateDocumentRequest.h.

◆ AddAttachments() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddAttachments ( const AttachmentsSource value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 301 of file CreateDocumentRequest.h.

◆ AddRequires() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddRequires ( const DocumentRequires value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 246 of file CreateDocumentRequest.h.

◆ AddRequires() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddRequires ( DocumentRequires &&  value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 258 of file CreateDocumentRequest.h.

◆ AddTags() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddTags ( const Tag value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 751 of file CreateDocumentRequest.h.

◆ AddTags() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::AddTags ( Tag &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 764 of file CreateDocumentRequest.h.

◆ AttachmentsHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::AttachmentsHasBeenSet ( ) const
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 271 of file CreateDocumentRequest.h.

◆ ContentHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::ContentHasBeenSet ( ) const
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 71 of file CreateDocumentRequest.h.

◆ DisplayNameHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::DisplayNameHasBeenSet ( ) const
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 395 of file CreateDocumentRequest.h.

◆ DocumentFormatHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::DocumentFormatHasBeenSet ( ) const
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 538 of file CreateDocumentRequest.h.

◆ DocumentTypeHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::DocumentTypeHasBeenSet ( ) const
inline

The type of document to create.

Definition at line 505 of file CreateDocumentRequest.h.

◆ GetAttachments()

const Aws::Vector<AttachmentsSource>& Aws::SSM::Model::CreateDocumentRequest::GetAttachments ( ) const
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 265 of file CreateDocumentRequest.h.

◆ GetContent()

const Aws::String& Aws::SSM::Model::CreateDocumentRequest::GetContent ( ) const
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 56 of file CreateDocumentRequest.h.

◆ GetDisplayName()

const Aws::String& Aws::SSM::Model::CreateDocumentRequest::GetDisplayName ( ) const
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 388 of file CreateDocumentRequest.h.

◆ GetDocumentFormat()

const DocumentFormat& Aws::SSM::Model::CreateDocumentRequest::GetDocumentFormat ( ) const
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 532 of file CreateDocumentRequest.h.

◆ GetDocumentType()

const DocumentType& Aws::SSM::Model::CreateDocumentRequest::GetDocumentType ( ) const
inline

The type of document to create.

Definition at line 500 of file CreateDocumentRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::CreateDocumentRequest::GetName ( ) const
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 317 of file CreateDocumentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::CreateDocumentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetRequires()

const Aws::Vector<DocumentRequires>& Aws::SSM::Model::CreateDocumentRequest::GetRequires ( ) const
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 174 of file CreateDocumentRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::CreateDocumentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDocumentRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::CreateDocumentRequest::GetTags ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 673 of file CreateDocumentRequest.h.

◆ GetTargetType()

const Aws::String& Aws::SSM::Model::CreateDocumentRequest::GetTargetType ( ) const
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 575 of file CreateDocumentRequest.h.

◆ GetVersionName()

const Aws::String& Aws::SSM::Model::CreateDocumentRequest::GetVersionName ( ) const
inline

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

Definition at line 445 of file CreateDocumentRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::NameHasBeenSet ( ) const
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 326 of file CreateDocumentRequest.h.

◆ RequiresHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::RequiresHasBeenSet ( ) const
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 186 of file CreateDocumentRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::CreateDocumentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttachments() [1/2]

void Aws::SSM::Model::CreateDocumentRequest::SetAttachments ( Aws::Vector< AttachmentsSource > &&  value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 283 of file CreateDocumentRequest.h.

◆ SetAttachments() [2/2]

void Aws::SSM::Model::CreateDocumentRequest::SetAttachments ( const Aws::Vector< AttachmentsSource > &  value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 277 of file CreateDocumentRequest.h.

◆ SetContent() [1/3]

void Aws::SSM::Model::CreateDocumentRequest::SetContent ( Aws::String &&  value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 101 of file CreateDocumentRequest.h.

◆ SetContent() [2/3]

void Aws::SSM::Model::CreateDocumentRequest::SetContent ( const Aws::String value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 86 of file CreateDocumentRequest.h.

◆ SetContent() [3/3]

void Aws::SSM::Model::CreateDocumentRequest::SetContent ( const char *  value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 116 of file CreateDocumentRequest.h.

◆ SetDisplayName() [1/3]

void Aws::SSM::Model::CreateDocumentRequest::SetDisplayName ( Aws::String &&  value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 409 of file CreateDocumentRequest.h.

◆ SetDisplayName() [2/3]

void Aws::SSM::Model::CreateDocumentRequest::SetDisplayName ( const Aws::String value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 402 of file CreateDocumentRequest.h.

◆ SetDisplayName() [3/3]

void Aws::SSM::Model::CreateDocumentRequest::SetDisplayName ( const char *  value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 416 of file CreateDocumentRequest.h.

◆ SetDocumentFormat() [1/2]

void Aws::SSM::Model::CreateDocumentRequest::SetDocumentFormat ( const DocumentFormat value)
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 544 of file CreateDocumentRequest.h.

◆ SetDocumentFormat() [2/2]

void Aws::SSM::Model::CreateDocumentRequest::SetDocumentFormat ( DocumentFormat &&  value)
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 550 of file CreateDocumentRequest.h.

◆ SetDocumentType() [1/2]

void Aws::SSM::Model::CreateDocumentRequest::SetDocumentType ( const DocumentType value)
inline

The type of document to create.

Definition at line 510 of file CreateDocumentRequest.h.

◆ SetDocumentType() [2/2]

void Aws::SSM::Model::CreateDocumentRequest::SetDocumentType ( DocumentType &&  value)
inline

The type of document to create.

Definition at line 515 of file CreateDocumentRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::CreateDocumentRequest::SetName ( Aws::String &&  value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 344 of file CreateDocumentRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::CreateDocumentRequest::SetName ( const Aws::String value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 335 of file CreateDocumentRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::CreateDocumentRequest::SetName ( const char *  value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 353 of file CreateDocumentRequest.h.

◆ SetRequires() [1/2]

void Aws::SSM::Model::CreateDocumentRequest::SetRequires ( Aws::Vector< DocumentRequires > &&  value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 210 of file CreateDocumentRequest.h.

◆ SetRequires() [2/2]

void Aws::SSM::Model::CreateDocumentRequest::SetRequires ( const Aws::Vector< DocumentRequires > &  value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 198 of file CreateDocumentRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::CreateDocumentRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 712 of file CreateDocumentRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::CreateDocumentRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 699 of file CreateDocumentRequest.h.

◆ SetTargetType() [1/3]

void Aws::SSM::Model::CreateDocumentRequest::SetTargetType ( Aws::String &&  value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 611 of file CreateDocumentRequest.h.

◆ SetTargetType() [2/3]

void Aws::SSM::Model::CreateDocumentRequest::SetTargetType ( const Aws::String value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 599 of file CreateDocumentRequest.h.

◆ SetTargetType() [3/3]

void Aws::SSM::Model::CreateDocumentRequest::SetTargetType ( const char *  value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 623 of file CreateDocumentRequest.h.

◆ SetVersionName() [1/3]

void Aws::SSM::Model::CreateDocumentRequest::SetVersionName ( Aws::String &&  value)
inline

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

Definition at line 466 of file CreateDocumentRequest.h.

◆ SetVersionName() [2/3]

void Aws::SSM::Model::CreateDocumentRequest::SetVersionName ( const Aws::String value)
inline

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

Definition at line 459 of file CreateDocumentRequest.h.

◆ SetVersionName() [3/3]

void Aws::SSM::Model::CreateDocumentRequest::SetVersionName ( const char *  value)
inline

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

Definition at line 473 of file CreateDocumentRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::TagsHasBeenSet ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 686 of file CreateDocumentRequest.h.

◆ TargetTypeHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::TargetTypeHasBeenSet ( ) const
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 587 of file CreateDocumentRequest.h.

◆ VersionNameHasBeenSet()

bool Aws::SSM::Model::CreateDocumentRequest::VersionNameHasBeenSet ( ) const
inline

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

Definition at line 452 of file CreateDocumentRequest.h.

◆ WithAttachments() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithAttachments ( Aws::Vector< AttachmentsSource > &&  value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 295 of file CreateDocumentRequest.h.

◆ WithAttachments() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithAttachments ( const Aws::Vector< AttachmentsSource > &  value)
inline

A list of key-value pairs that describe attachments to a version of a document.

Definition at line 289 of file CreateDocumentRequest.h.

◆ WithContent() [1/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithContent ( Aws::String &&  value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 146 of file CreateDocumentRequest.h.

◆ WithContent() [2/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithContent ( const Aws::String value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 131 of file CreateDocumentRequest.h.

◆ WithContent() [3/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithContent ( const char *  value)
inline

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

Definition at line 161 of file CreateDocumentRequest.h.

◆ WithDisplayName() [1/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDisplayName ( Aws::String &&  value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 430 of file CreateDocumentRequest.h.

◆ WithDisplayName() [2/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDisplayName ( const Aws::String value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 423 of file CreateDocumentRequest.h.

◆ WithDisplayName() [3/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDisplayName ( const char *  value)
inline

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Definition at line 437 of file CreateDocumentRequest.h.

◆ WithDocumentFormat() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDocumentFormat ( const DocumentFormat value)
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 556 of file CreateDocumentRequest.h.

◆ WithDocumentFormat() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDocumentFormat ( DocumentFormat &&  value)
inline

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Definition at line 562 of file CreateDocumentRequest.h.

◆ WithDocumentType() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDocumentType ( const DocumentType value)
inline

The type of document to create.

Definition at line 520 of file CreateDocumentRequest.h.

◆ WithDocumentType() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithDocumentType ( DocumentType &&  value)
inline

The type of document to create.

Definition at line 525 of file CreateDocumentRequest.h.

◆ WithName() [1/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithName ( Aws::String &&  value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 371 of file CreateDocumentRequest.h.

◆ WithName() [2/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithName ( const Aws::String value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 362 of file CreateDocumentRequest.h.

◆ WithName() [3/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithName ( const char *  value)
inline

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Definition at line 380 of file CreateDocumentRequest.h.

◆ WithRequires() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithRequires ( Aws::Vector< DocumentRequires > &&  value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 234 of file CreateDocumentRequest.h.

◆ WithRequires() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithRequires ( const Aws::Vector< DocumentRequires > &  value)
inline

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

Definition at line 222 of file CreateDocumentRequest.h.

◆ WithTags() [1/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 738 of file CreateDocumentRequest.h.

◆ WithTags() [2/2]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

Definition at line 725 of file CreateDocumentRequest.h.

◆ WithTargetType() [1/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithTargetType ( Aws::String &&  value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 647 of file CreateDocumentRequest.h.

◆ WithTargetType() [2/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithTargetType ( const Aws::String value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 635 of file CreateDocumentRequest.h.

◆ WithTargetType() [3/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithTargetType ( const char *  value)
inline

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Definition at line 659 of file CreateDocumentRequest.h.

◆ WithVersionName() [1/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithVersionName ( Aws::String &&  value)
inline

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

Definition at line 487 of file CreateDocumentRequest.h.

◆ WithVersionName() [2/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithVersionName ( const Aws::String value)
inline

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

Definition at line 480 of file CreateDocumentRequest.h.

◆ WithVersionName() [3/3]

CreateDocumentRequest& Aws::SSM::Model::CreateDocumentRequest::WithVersionName ( const char *  value)
inline

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

Definition at line 494 of file CreateDocumentRequest.h.


The documentation for this class was generated from the following file: