Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-ssm-document.json
Parent schema serverless-framework-configuration
Type: object

The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm

Properties

Content object | string required

The content for the Systems Manager document in JSON, YAML or String format.

Attachments AttachmentsSource[]

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

minItems=0maxItems=20
Name string | Aws_CF_FunctionString

A name for the Systems Manager document.

VersionName string | Aws_CF_FunctionString

An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.

DocumentType string | Aws_CF_FunctionString

The type of document to create.

DocumentFormat string | Aws_CF_FunctionString

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

TargetType string | Aws_CF_FunctionString

Specify a target type to define the kinds of resources the document can run on.

Tags Tag[]

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.

maxItems=1000

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

minItems=1
UpdateMethod string | Aws_CF_FunctionString

Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.

Definitions

AttachmentsSource object
Key string | Aws_CF_FunctionString

The key of a key-value pair that identifies the location of an attachment to a document.

Values string[]

The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

minItems=1maxItems=1
Name string | Aws_CF_FunctionString

The name of the document attachment file.

Tag object
Key string | Aws_CF_FunctionString

The name of the tag.

Value string | Aws_CF_FunctionString

The value of the tag.

DocumentRequires object
Name string | Aws_CF_FunctionString

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

Version string | Aws_CF_FunctionString

The document version required by the current document.