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 CreateDocument operation. Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateDocumentRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The CreateDocumentRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDocumentRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateDocumentRequest(string, string)

Instantiates CreateDocumentRequest with the parameterized properties

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.

The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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.

Public Property DisplayName System.String

Gets and sets the property 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. You can update this value at a later time using the UpdateDocument operation.

Public Property DocumentFormat Amazon.SimpleSystemsManagement.DocumentFormat

Gets and sets the property DocumentFormat.

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

Public Property DocumentType Amazon.SimpleSystemsManagement.DocumentType

Gets and sets the property DocumentType.

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

Public Property Name System.String

Gets and sets the property Name.

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

  • AWSEC2

  • AWSConfigRemediation

  • AWSSupport

Public Property Requires System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.DocumentRequires>

Gets and sets the property Requires.

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.

Public Property Tags System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Tag>

Gets and sets the property Tags.

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.

Public Property TargetType System.String

Gets and sets the property TargetType.

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.

Public Property VersionName System.String

Gets and sets the property VersionName.

An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. 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