DocumentRequires - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DocumentRequires

An SSM document required by the current document.

Contents

Name

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

Type: String

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

Required: Yes

RequireType

The document type of the required SSM document.

Type: String

Length Constraints: Maximum length of 128.

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

Required: No

Version

The document version required by the current document.

Type: String

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

Required: No

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.

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 Amazon SDKs, see the following: