VaporShell Snippets

1. SSM Document Example.ps1

# Recreation of the example found here: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html

$ssmDocContent = [PSCustomObject]@{
    schemaVersion = "1.2"
    description = "Join instances to an AWS Directory Service domain."
    parameters = @{
        directoryId = @{
            type = "String"
            description = "(Required) The ID of the AWS Directory Service directory."
        }
        directoryName = @{
            type = "String"
            description = "(Required) The name of the directory; for example, test.example.com"
        }
        dnsIpAddresses = @{
            type = "StringList"
            default = @()
            description = "(Optional) The IP addresses of the DNS servers in the directory. Required when DHCP is not configured. Learn more at http://docs.aws.amazon.com/directoryservice/latest/simple-ad/join_get_dns_addresses.html"
            allowedPattern = "((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)"
        }
    }
    runtimeConfig = @{
        "aws:domainJoin" = @{
            properties = @{
                directoryId = "{{ directoryId }}"
                directoryName = "{{ directoryName }}"
                dnsIpAddresses = "{{ dnsIpAddresses }}"
            }
        }
    }
}

$template = Initialize-Vaporshell -Description "AWS Domain Join SSM Doc"
$ssmDoc = New-VSSSMDocument -LogicalId 'document' -Content $ssmDocContent
$template.AddResource($ssmDoc)

$template.ToJson() # Creates the JSON string template seen below
$template.ToYaml() # Creates the YAML string template seen below (if cfn-flip is installed)

2. SSM Document Example - Resulting Template.json

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "Testing SSM docs",
  "Resources": {
    "document": {
      "Type": "AWS::SSM::Document",
      "Properties": {
        "Content": {
          "schemaVersion": "1.2",
          "description": "Join instances to an AWS Directory Service domain.",
          "parameters": {
            "dnsIpAddresses": {
            "allowedPattern": "((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)",
              "description": "(Optional) The IP addresses of the DNS servers in the directory. Required when DHCP is not configured. Learn more at http://docs.aws.amazon.com/directoryservice/latest/simple-ad/join_get_dns_addresses.html",
              "default": [
                
              ],
              "type": "StringList"
            },
            "directoryName": {
              "type": "String",
              "description": "(Required) The name of the directory; for example, test.example.com"
            },
            "directoryId": {
              "type": "String",
              "description": "(Required) The ID of the AWS Directory Service directory."
            }
          },
          "runtimeConfig": {
            "aws:domainJoin": {
              "properties": {
              "dnsIpAddresses": "{{ dnsIpAddresses }}",
              "directoryName": "{{ directoryName }}",
              "directoryId": "{{ directoryId }}"
              }
            }
          }
        }
      }
    }
  }
}

3. SSM Document Example - Resulting Template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Description: Testing SSM docs
Resources:
  document:
    Type: AWS::SSM::Document
    Properties:
      Content:
        schemaVersion: '1.2'
        description: Join instances to an AWS Directory Service domain.
        parameters:
          dnsIpAddresses:
            allowedPattern: ((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
            description: >-
              (Optional) The IP addresses of the DNS servers in the directory. Required
              when DHCP is not configured. Learn more at http://docs.aws.amazon.com/directoryservice/latest/simple-ad/join_get_dns_addresses.html
            default: []
            type: StringList
          directoryName:
            type: String
            description: (Required) The name of the directory; for example, test.example.com
          directoryId:
            type: String
            description: (Required) The ID of the AWS Directory Service directory.
        runtimeConfig:
          aws:domainJoin:
            properties:
              dnsIpAddresses: '{{ dnsIpAddresses }}'
              directoryName: '{{ directoryName }}'
              directoryId: '{{ directoryId }}'

4. Creating the SSM Doc via AWSPowerShell instead.ps1

$ssmDocContent = [PSCustomObject]@{
    schemaVersion = "1.2"
    description = "Join instances to an AWS Directory Service domain."
    parameters = @{
        directoryId = @{
            type = "String"
            description = "(Required) The ID of the AWS Directory Service directory."
        }
        directoryName = @{
            type = "String"
            description = "(Required) The name of the directory; for example, test.example.com"
        }
        dnsIpAddresses = @{
            type = "StringList"
            default = @()
            description = "(Optional) The IP addresses of the DNS servers in the directory. Required when DHCP is not configured. Learn more at http://docs.aws.amazon.com/directoryservice/latest/simple-ad/join_get_dns_addresses.html"
            allowedPattern = "((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)"
        }
    }
    runtimeConfig = @{
        "aws:domainJoin" = @{
            properties = @{
                directoryId = "{{ directoryId }}"
                directoryName = "{{ directoryName }}"
                dnsIpAddresses = "{{ dnsIpAddresses }}"
            }
        }
    }
}

New-SSMDocument -Content ($ssmDocContent | ConvertTo-Json -Depth 10)

This is for schema 1.2, this can easily be modified thanks to your work to 2.2 schema. Just need to figure out if I use AWSPowershell to then upload to AWS or vaporshell has a "publish" type of command for the doc.