Class CfnDocument
The AWS::SSM::Document
resource creates a Systems Manager (SSM) document in AWS Systems Manager .
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocument : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDocument
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
This document d efines the actions that Systems Manager performs on your AWS resources.
This resource does not support AWS CloudFormation drift detection.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
CloudformationResource: AWS::SSM::Document
ExampleMetadata: infused
Examples
Application application;
CfnDocument document;
new SourcedConfiguration(this, "MySourcedConfiguration", new SourcedConfigurationProps {
Application = application,
Location = ConfigurationSource.FromCfnDocument(document)
});
Synopsis
Constructors
CfnDocument(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDocument(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDocument(Construct, String, ICfnDocumentProps) |
Properties
Attachments | A list of key-value pairs that describe attachments to a version of a document. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDocument(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDocument(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDocument(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDocument(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDocument(Construct, String, ICfnDocumentProps)
public CfnDocument(Construct scope, string id, ICfnDocumentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- 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
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Content
The content for the new SSM document in JSON or YAML.
public virtual object Content { get; set; }
Property Value
System.Object
DocumentFormat
Specify the document format for the request.
public virtual string DocumentFormat { get; set; }
Property Value
System.String
DocumentType
The type of document to create.
public virtual string DocumentType { get; set; }
Property Value
System.String
Name
A name for the SSM document.
public virtual string Name { get; set; }
Property Value
System.String
Requires
A list of SSM documents required by a document.
public virtual object Requires { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
AWS CloudFormation resource tags to apply to the document.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TargetType
Specify a target type to define the kinds of resources the document can run on.
public virtual string TargetType { get; set; }
Property Value
System.String
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
System.String
VersionName
An optional field specifying the version of the artifact you are creating with the document.
public virtual string VersionName { get; set; }
Property Value
System.String
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>