Class CfnDocument

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDocument

Implements

IInspectable

IDocumentRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDocument : CfnResource, IInspectable, IDocumentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDocument Inherits CfnResource Implements IInspectable, IDocumentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support 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(Construct, string, ICfnDocumentProps)

Create a new AWS::SSM::Document.

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	The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .
CfnPropertyNames	The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .
Content	The content for the new SSM document in JSON or YAML.
DocumentFormat	Specify the document format for the request.
DocumentRef	A reference to a Document resource.
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

ArnForDocument(IDocumentRef)	The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .
FromDocumentName(Construct, string, string)	Creates a new IDocumentRef from a documentName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDocument(object)	Checks whether the given object is a CfnDocument.
RenderProperties(IDictionary<string, object>)	The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

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

Construct identifier for this resource (unique in its scope).

props ICfnDocumentProps

Resource properties.

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

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

Type union: either IResolvable or (either IResolvable or CfnDocument.IAttachmentsSourceProperty)[]

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

CfnProperties

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

CfnPropertyNames

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

Content

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

public virtual object Content { get; set; }

Property Value

object

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

DocumentFormat

Specify the document format for the request.

public virtual string? DocumentFormat { get; set; }

Property Value

string

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

DocumentRef

A reference to a Document resource.

public virtual IDocumentReference DocumentRef { get; }

Property Value

IDocumentReference

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

DocumentType

The type of document to create.

public virtual string? DocumentType { get; set; }

Property Value

string

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

Name

A name for the SSM document.

public virtual string? Name { get; set; }

Property Value

string

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

Requires

A list of SSM documents required by a document.

public virtual object? Requires { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDocument.IDocumentRequiresProperty)[]

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

TagsRaw

AWS CloudFormation resource tags to apply to the document.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

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

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

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

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

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

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

Methods

ArnForDocument(IDocumentRef)

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

public static string ArnForDocument(IDocumentRef resource)

Parameters

resource IDocumentRef

Returns

string

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support 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)
             });

FromDocumentName(Construct, string, string)

Creates a new IDocumentRef from a documentName.

public static IDocumentRef FromDocumentName(Construct scope, string id, string documentName)

Parameters

scope Construct

id string

documentName string

Returns

IDocumentRef

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

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.

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

IsCfnDocument(object)

Checks whether the given object is a CfnDocument.

public static bool IsCfnDocument(object x)

Parameters

x object

Returns

bool

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

RenderProperties(IDictionary<string, object>)

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

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

CloudformationResource: AWS::SSM::Document

ExampleMetadata: infused

Implements

IInspectable

IDocumentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable