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.

Describes the name of a SSM document.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.DocumentIdentifier

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

Syntax

C#
public class DocumentIdentifier

The DocumentIdentifier type exposes the following members

Constructors

NameDescription
Public Method DocumentIdentifier()

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

Public Method DocumentIdentifier(string)

Instantiates DocumentIdentifier with the parameterized properties

Properties

NameTypeDescription
Public Property Author System.String

Gets and sets the property Author.

The user in your organization who created the document.

Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The date the SSM document was created.

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. If you want to update this value, see UpdateDocument.

Public Property DocumentFormat Amazon.SimpleSystemsManagement.DocumentFormat

Gets and sets the property DocumentFormat.

The document format, either JSON or YAML.

Public Property DocumentType Amazon.SimpleSystemsManagement.DocumentType

Gets and sets the property DocumentType.

The document type.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The document version.

Public Property Name System.String

Gets and sets the property Name.

The name of the SSM document.

Public Property Owner System.String

Gets and sets the property Owner.

The Amazon Web Services user that created the document.

Public Property PlatformTypes System.Collections.Generic.List<System.String>

Gets and sets the property PlatformTypes.

The operating system platform.

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. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Public Property ReviewStatus Amazon.SimpleSystemsManagement.ReviewStatus

Gets and sets the property ReviewStatus.

The current status of a document review.

Public Property SchemaVersion System.String

Gets and sets the property SchemaVersion.

The schema version.

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

Gets and sets the property Tags.

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

Public Property TargetType System.String

Gets and sets the property 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.

Public Property VersionName System.String

Gets and sets the property VersionName.

An optional field specifying the version of the artifact associated 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