Interface ICfnDocumentProps

Properties for defining a CfnDocument.

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDocumentProps

Syntax (vb)

Public Interface ICfnDocumentProps

Remarks

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

ExampleMetadata: fixture=_generated

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 cfnDocumentProps = 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"
             };

Synopsis

Properties

Attachments	A list of key-value pairs that describe attachments to a version of a document.
Content	The content for the new SSM document in JSON or YAML.
DocumentFormat	Specify the document format for the request.
DocumentType	The type of document to create.
Name	A name for the SSM document.
Requires	A list of SSM documents required by a document.
Tags	AWS CloudFormation resource tags to apply to the document.
TargetType	Specify a target type to define the kinds of resources the document can run on.
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.
VersionName	An optional field specifying the version of the artifact you are creating with the document.

Properties

Attachments

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

object? Attachments { get; }

Property Value

object

Remarks

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

Content

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

object Content { get; }

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.

See: 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.

string? DocumentFormat { get; }

Property Value

string

Remarks

JSON is the default format.

Default: - "JSON"

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

DocumentType

The type of document to create.

string? DocumentType { get; }

Property Value

string

Remarks

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

Name

A name for the SSM document.

string? Name { get; }

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:

See: 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.

object? Requires { get; }

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 .

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

TargetType

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

string? TargetType { get; }

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 .

See: 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.

string? UpdateMethod { get; }

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.

Default: - "Replace"

See: 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.

string? VersionName { get; }

Property Value

string

Remarks

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

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