CfnDocumentProps

class aws_cdk.aws_ssm.CfnDocumentProps(*, attachments=None, content, document_format=None, document_type=None, name=None, requires=None, tags=None, target_type=None, version_name=None)

Bases: object

Properties for defining a AWS::SSM::Document.

Parameters
  • attachments (Union[IResolvable, Sequence[Union[IResolvable, AttachmentsSourceProperty]], None]) – AWS::SSM::Document.Attachments.

  • content (Any) – AWS::SSM::Document.Content.

  • document_format (Optional[str]) – AWS::SSM::Document.DocumentFormat.

  • document_type (Optional[str]) – AWS::SSM::Document.DocumentType.

  • name (Optional[str]) – AWS::SSM::Document.Name.

  • requires (Union[IResolvable, Sequence[Union[IResolvable, DocumentRequiresProperty]], None]) – AWS::SSM::Document.Requires.

  • tags (Optional[Sequence[CfnTag]]) – AWS::SSM::Document.Tags.

  • target_type (Optional[str]) – AWS::SSM::Document.TargetType.

  • version_name (Optional[str]) – AWS::SSM::Document.VersionName.

Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

# content is of type object

cfn_document_props = ssm.CfnDocumentProps(
    content=content,

    # the properties below are optional
    attachments=[ssm.CfnDocument.AttachmentsSourceProperty(
        key="key",
        name="name",
        values=["values"]
    )],
    document_format="documentFormat",
    document_type="documentType",
    name="name",
    requires=[ssm.CfnDocument.DocumentRequiresProperty(
        name="name",
        version="version"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_type="targetType",
    version_name="versionName"
)

Attributes

attachments

AWS::SSM::Document.Attachments.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AttachmentsSourceProperty]], None]

content

AWS::SSM::Document.Content.

Link

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

Return type

Any

document_format

AWS::SSM::Document.DocumentFormat.

Link

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

Return type

Optional[str]

document_type

AWS::SSM::Document.DocumentType.

Link

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

Return type

Optional[str]

name

AWS::SSM::Document.Name.

Link

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

Return type

Optional[str]

requires

AWS::SSM::Document.Requires.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DocumentRequiresProperty]], None]

tags

AWS::SSM::Document.Tags.

Link

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

Return type

Optional[List[CfnTag]]

target_type

AWS::SSM::Document.TargetType.

Link

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

Return type

Optional[str]

version_name

AWS::SSM::Document.VersionName.

Link

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

Return type

Optional[str]