CfnDocumentProps

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

Bases: object

Properties for defining a CfnDocument.

Parameters
  • content (Any) – The content for the new SSM document in JSON or YAML. .. epigraph:: This parameter also supports String data types.

  • attachments (Union[IResolvable, Sequence[Union[IResolvable, AttachmentsSourceProperty, Dict[str, Any]]], None]) – A list of key-value pairs that describe attachments to a version of a document.

  • document_format (Optional[str]) – Specify the document format for the request. JSON is the default format.

  • document_type (Optional[str]) – The type of document to create. Allowed Values : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

  • name (Optional[str]) – A name for the SSM document. .. epigraph:: You can’t use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: - aws- - amazon - amzn

  • requires (Union[IResolvable, Sequence[Union[IResolvable, DocumentRequiresProperty, Dict[str, Any]]], None]) – A list of SSM documents required by a document. 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.

  • target_type (Optional[str]) – Specify a target type to define the kinds of resources the document can run on. 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 .

  • update_method (Optional[str]) – 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. 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.

  • version_name (Optional[str]) – An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1 . This value is unique across all versions of a document, and can’t be changed.

Link

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

ExampleMetadata

fixture=_generated

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: Any

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",
    update_method="updateMethod",
    version_name="versionName"
)

Attributes

attachments

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

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

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

This parameter also supports String data types.

Link

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

Return type

Any

document_format

Specify the document format for the request.

JSON is the default format.

Link

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

Return type

Optional[str]

document_type

The type of document to create.

Allowed Values : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

Link

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

Return type

Optional[str]

name

A name for the SSM document.

You can’t use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Link

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

Return type

Optional[str]

requires

A list of SSM documents required by a document.

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 .

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 CloudFormation resource tags to apply to the document.

Use tags to help you identify and categorize resources.

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

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

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 .

Link

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

Return type

Optional[str]

update_method

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.

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.

Link

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

Return type

Optional[str]

version_name

An optional field specifying the version of the artifact you are creating with the document.

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

Link

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

Return type

Optional[str]