Interface ICfnDocumentProps
Properties for defining a CfnDocument
.
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public interface ICfnDocumentProps
Syntax (vb)
Public Interface ICfnDocumentProps
Remarks
Link: 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.
virtual object Attachments { get; }
Property Value
System.Object
Remarks
Content
The content for the new SSM document in JSON or YAML.
object Content { get; }
Property Value
System.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 String
data types.
DocumentFormat
Specify the document format for the request.
virtual string DocumentFormat { get; }
Property Value
System.String
Remarks
JSON is the default format.
DocumentType
The type of document to create.
virtual string DocumentType { get; }
Property Value
System.String
Remarks
Allowed Values : ApplicationConfigurationSchema
| Automation
| Automation.ChangeTemplate
| Command
| DeploymentStrategy
| Package
| Policy
| Session
Name
A name for the SSM document.
virtual string Name { get; }
Property Value
System.String
Remarks
You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
Requires
A list of SSM documents required by a document.
virtual object Requires { get; }
Property Value
System.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 .
Tags
AWS CloudFormation resource tags to apply to the document.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Use tags to help you identify and categorize resources.
TargetType
Specify a target type to define the kinds of resources the document can run on.
virtual string TargetType { get; }
Property Value
System.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 .
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.
virtual string UpdateMethod { get; }
Property Value
System.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.
VersionName
An optional field specifying the version of the artifact you are creating with the document.
virtual string VersionName { get; }
Property Value
System.String
Remarks
For example, Release12.1
. This value is unique across all versions of a document, and can't be changed.