DocumentIdentifier - AWS Systems Manager

DocumentIdentifier

Describes the name of a SSM document.

Contents

Author

The user in your organization who created the document.

Type: String

Required: No

CreatedDate

The date the SSM document was created.

Type: Timestamp

Required: No

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 .

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[\w\.\-\:\/ ]*$

Required: No

DocumentFormat

The document format, either JSON or YAML.

Type: String

Valid Values: YAML | JSON | TEXT

Required: No

DocumentType

The document type.

Type: String

Valid Values: Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate

Required: No

DocumentVersion

The document version.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Required: No

Name

The name of the SSM document.

Type: String

Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$

Required: No

Owner

The Amazon Web Services user account that created the document.

Type: String

Required: No

PlatformTypes

The operating system platform.

Type: Array of strings

Valid Values: Windows | Linux

Required: No

Requires

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

Type: Array of DocumentRequires objects

Array Members: Minimum number of 1 item.

Required: No

ReviewStatus

The current status of a document review.

Type: String

Valid Values: APPROVED | NOT_REVIEWED | PENDING | REJECTED

Required: No

SchemaVersion

The schema version.

Type: String

Pattern: ([0-9]+)\.([0-9]+)

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

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 AWS resource and property types reference in the AWS CloudFormation User Guide.

Type: String

Length Constraints: Maximum length of 200.

Pattern: ^\/[\w\.\-\:\/]*$

Required: No

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.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{1,128}$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: