AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SSM::Document

CfnDocument

The `AWS::SSM::Document` resource creates a Systems Manager (SSM) document in AWS Systems Manager . This document defines the actions that Systems Manager performs on your AWS resources. > This resource does not support CloudFormation drift detection.

Import

import { CfnDocument } from 'aws-cdk-lib/aws-ssm';

Or use the module namespace:

import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.CfnDocument

Properties

Configuration passed to the constructor as CfnDocumentProps.

contentRequired
any

The content for the new SSM document in JSON or YAML. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide* . > This parameter also supports `String` data types.

attachmentsOptional
IResolvable | IResolvable | AttachmentsSourceProperty[]

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

documentFormatOptional
string

Specify the document format for the request. `JSON` is the default format.

Default: - "JSON"

documentTypeOptional
string

The type of document to create.

nameOptional
string

A name for the SSM document. > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: > > - `aws` > - `amazon` > - `amzn` > - `AWSEC2` > - `AWSConfigRemediation` > - `AWSSupport`

requiresOptional
IResolvable | IResolvable | DocumentRequiresProperty[]

A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS 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 AWS AppConfig ?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

tagsOptional
CfnTag[]

AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.

targetTypeOptional
string

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 [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide* .

updateMethodOptional
string

If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version.

Default: - "Replace"

versionNameOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter