AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateDocument operation. Updates one or more values for an SSM document.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.UpdateDocumentRequest

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateDocumentRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The UpdateDocumentRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateDocumentRequest()

Properties

NameTypeDescription
Public Property Attachments System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.AttachmentsSource>

Gets and sets the property Attachments.

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

Public Property Content System.String

Gets and sets the property Content.

A valid JSON or YAML string.

Public Property DisplayName System.String

Gets and sets the property DisplayName.

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

Public Property DocumentFormat Amazon.SimpleSystemsManagement.DocumentFormat

Gets and sets the property DocumentFormat.

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Public Property Name System.String

Gets and sets the property Name.

The name of the SSM document that you want to update.

Public Property TargetType System.String

Gets and sets the property TargetType.

Specify a new target type for the document.

Public Property VersionName System.String

Gets and sets the property VersionName.

An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5