Commands

build

Build SSM Documents from Dox in DOX_DIRECTORY.

If DOX_DIRECTORY (absolute or relative) is omitted, ./dox is used.

Usage

$ ssm-dox build [OPTIONS] [DOX_DIRECTORY]

Options

-o, --output TEXT  path where built files should be placed
                   [default: ./ssm_documents]

Example

$ ssm-dox build
$ ssm-dox build ./dox
$ ssm-dox build ./dox --output ./ssm_documents

---

check

Compare Dox in to SSM Documents to ensure the match.

If DOX_DIRECTORY (absolute or relative) is omitted, ./dox is used. If DOCUMENTS_DIRECTORY (absolute or relative) is omitted, ./ssm_documents is used.

Usage

$ ssm-dox check [OPTIONS] [DOX_DIRECTORY] [DOCUMENTS_DIRECTORY]

Example

$ ssm-dox check
$ ssm-dox check ./dox
$ ssm-dox check ./dox ./ssm_documents

---

publish

Publish SSM Documents from DOCUMENTS_DIRECTORY to an S3 BUCKET.

If DOCUMENTS_DIRECTORY (absolute or relative) is omitted, ./ssm_documents is used.

Usage

$ ssm-dox publish [OPTIONS] BUCKET [DOCUMENTS_DIRECTORY]

Options

-p, --prefix TEXT  prefix to append to S3 Object key  [default: dev]
--profile TEXT     AWS profile name
--region TEXT      AWS region where the bucket is located
-h, --help         Show this message and exit.

Example

$ ssm-dox publish example-bucket
$ ssm-dox publish example-bucket ./ssm_documents --prefix latest
$ ssm-dox publish example-bucket ./ssm_documents --region us-east-1