github.com/nevins-b/terraform@v0.3.8-0.20170215184714-bbae22007d5a/website/source/docs/providers/aws/r/ssm_document.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_ssm_document"
     4  sidebar_current: "docs-aws-resource-ssm-document"
     5  description: |-
     6    Provides an SSM Document resource
     7  ---
     8  
     9  # aws\_ssm\_document
    10  
    11  Provides an SSM Document resource
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "aws_ssm_document" "foo" {
    17    name    = "test_document"
    18    document_type = "Command"
    19    content = <<DOC
    20    {
    21      "schemaVersion": "1.2",
    22      "description": "Check ip configuration of a Linux instance.",
    23      "parameters": {
    24  
    25      },
    26      "runtimeConfig": {
    27        "aws:runShellScript": {
    28          "properties": [
    29            {
    30              "id": "0.aws:runShellScript",
    31              "runCommand": ["ifconfig"]
    32            }
    33          ]
    34        }
    35      }
    36    }
    37  DOC
    38  }
    39  ```
    40  
    41  ## Argument Reference
    42  
    43  The following arguments are supported:
    44  
    45  * `name` - (Required) The name of the document.
    46  * `content` - (Required) The json content of the document.
    47  * `document_type` - (Required) The type of the document. Valid document types include: `Command`, `Policy` and `Automation`
    48  * `permission` - (Optional) Additional Permissions to attach to the document. See [Permissions](#permissions) below for details.
    49  
    50  ## Attributes Reference
    51  
    52  The following attributes are exported:
    53  
    54  * `name` - The name of the document.
    55  * `content` -  The json content of the document.
    56  * `created_date` - The date the document was created.
    57  * `description` - The description of the document.
    58  * `document_type` - The type of document created.
    59  * `default_version` - The default version of the document.
    60  * `hash` - The sha1 or sha256 of the document content
    61  * `hash_type` - "Sha1" "Sha256". The hashing algorithm used when hashing the content.
    62  * `latest_version` - The latest version of the document.
    63  * `owner` - The AWS user account of the person who created the document.
    64  * `status` - "Creating", "Active" or "Deleting". The current status of the document.
    65  * `parameter` - The parameters that are available to this document.
    66  * `permission` - The permissions of how this document should be shared.
    67  * `platform_types` - A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
    68  
    69  ## Permissions
    70  
    71  The permission attribute specifies how you want to share the document. If you share a document privately,
    72  you must specify the AWS user account IDs for those people who can use the document. If you share a document
    73  publicly, you must specify All as the account ID.
    74  
    75  The permission mapping support the following:
    76  
    77  * `type` - The permission type for the document. The permission type can be `Share`.
    78  * `account_ids` - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or `All`.