Amazon Config · JSON Structure

Config Template Ssm Document Details Structure

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API. You can also provide the DocumentVersion.

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

Type: object Properties: 2 Required: 1
AuditingComplianceConfiguration ManagementGovernanceSecurity

TemplateSSMDocumentDetails is a JSON Structure definition published by Amazon Config, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DocumentName DocumentVersion

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-structure/config-template-ssm-document-details-structure.json",
  "name": "TemplateSSMDocumentDetails",
  "description": "<p>This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the <code>DocumentName</code> in the <a href=\"https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html\">PutConformancePack API</a>. You can also provide the <code>DocumentVersion</code>.</p> <p>The <code>TemplateSSMDocumentDetails</code> object contains the name of the SSM document and the version of the SSM document.</p>",
  "type": "object",
  "properties": {
    "DocumentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SSMDocumentName"
        },
        {
          "description": "The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN."
        }
      ]
    },
    "DocumentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SSMDocumentVersion"
        },
        {
          "description": "<p>The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.</p> <note> <p>This field is optional.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "DocumentName"
  ]
}