actionSSM

create_document

Creates a Systems Manager (SSM) document

Activity as code

Below are the details and signature of the activity Python module.

Typeaction
Modulechaosaws.ssm.actions
Namecreate_document
Returnmapping

Usage

JSON

{
  "name": "create-document",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.ssm.actions",
    "func": "create_document",
    "arguments": {
      "path_content": "",
      "name": ""
    }
  }
}

YAML

name: create-document
provider:
  arguments:
    name: ""
    path_content: ""
  func: create_document
  module: chaosaws.ssm.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
namestringYesDocument Name
path_contentstringYesContentLocal path to the content of the document
version_namestringnullNoVersion Name
document_typestringnullNoDocument Type
document_formatstringnullNoDocument Format

An SSM document defines the actions that SSM performs on your managed instances.

More information about SSM documents:

Signature

def create_document(
        path_content: str,
        name: str,
        version_name: str = None,
        document_type: str = None,
        document_format: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass