Table of Contents

Class CfnDocument

Namespace
Amazon.CDK.AWS.SSM
Assembly
Amazon.CDK.AWS.SSM.dll

A CloudFormation AWS::SSM::Document.

public class CfnDocument : CfnResource, IInspectable
Inheritance
CfnDocument
Implements
IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSM;

             var content;

             var cfnDocument = new CfnDocument(this, "MyCfnDocument", new CfnDocumentProps {
                 Content = content,

                 // the properties below are optional
                 Attachments = new [] { new AttachmentsSourceProperty {
                     Key = "key",
                     Name = "name",
                     Values = new [] { "values" }
                 } },
                 DocumentFormat = "documentFormat",
                 DocumentType = "documentType",
                 Name = "name",
                 Requires = new [] { new DocumentRequiresProperty {
                     Name = "name",
                     Version = "version"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetType = "targetType",
                 UpdateMethod = "updateMethod",
                 VersionName = "versionName"
             });

Remarks

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.

CloudformationResource: AWS::SSM::Document

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html

ExampleMetadata: fixture=_generated

Constructors

CfnDocument(Construct, string, ICfnDocumentProps)

Create a new AWS::SSM::Document.

public CfnDocument(Construct scope, string id, ICfnDocumentProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnDocumentProps
  • resource properties.

Properties

Attachments

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

public virtual object? Attachments { get; set; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties 

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Content

The content for the new SSM document in JSON or YAML.

public virtual object Content { get; set; }

Property Value

object

Remarks

For more information about the schemas for SSM document content, see SSM document schema features and examples in the AWS Systems Manager User Guide .

This parameter also supports <code>String</code> data types.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

DocumentFormat

Specify the document format for the request.

public virtual string? DocumentFormat { get; set; }

Property Value

string

Remarks

JSON is the default format.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat

DocumentType

The type of document to create.

public virtual string? DocumentType { get; set; }

Property Value

string

Remarks

Allowed Values : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

Name

A name for the SSM document.

public virtual string? Name { get; set; }

Property Value

string

Remarks

You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name

    Requires

    A list of SSM documents required by a document.

    public virtual object? Requires { get; set; }

    Property Value

    object

    Remarks

    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 ? in the AWS AppConfig User Guide .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

    Tags

    AWS CloudFormation resource tags to apply to the document.

    public virtual TagManager Tags { get; }

    Property Value

    TagManager

    Remarks

    Use tags to help you identify and categorize resources.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

    TargetType

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

    public virtual string? TargetType { get; set; }

    Property Value

    string

    Remarks

    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 in the AWS CloudFormation User Guide .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype

    UpdateMethod

    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.

    public virtual string? UpdateMethod { get; set; }

    Property Value

    string

    Remarks

    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.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod

    VersionName

    An optional field specifying the version of the artifact you are creating with the document.

    public virtual string? VersionName { get; set; }

    Property Value

    string

    Remarks

    For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    public virtual void Inspect(TreeInspector inspector)

    Parameters

    inspector TreeInspector
    • tree inspector to collect and process attributes.

    RenderProperties(IDictionary<string, object>) 

    protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

    Parameters

    props IDictionary<string, object>

    Returns

    IDictionary<string, object>