pulumi-aws-kotlin/com.pulumi.aws.ssm.kotlin/DocumentArgs

DocumentArgs

data class DocumentArgs(val attachmentsSources: Output<List<DocumentAttachmentsSourceArgs>>? = null, val content: Output<String>? = null, val documentFormat: Output<String>? = null, val documentType: Output<String>? = null, val name: Output<String>? = null, val permissions: Output<Map<String, String>>? = null, val tags: Output<Map<String, String>>? = null, val targetType: Output<String>? = null, val versionName: Output<String>? = null) : ConvertibleToJava<DocumentArgs>

Provides an SSM Document resource

NOTE on updating SSM documents: Only documents with a schema version of 2.0 or greater can update their content once created, see SSM Schema Features. To update a document with an older schema version you must recreate the resource. Not all document types support a schema version of 2.0 or greater. Refer to SSM document schema features and examples for information about which schema versions are supported for the respective document_type.

Example Usage

Create an ssm document in JSON format

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Document;
import com.pulumi.aws.ssm.DocumentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foo = new Document("foo", DocumentArgs.builder()
            .content("""
  {
    "schemaVersion": "1.2",
    "description": "Check ip configuration of a Linux instance.",
    "parameters": {
    },
    "runtimeConfig": {
      "aws:runShellScript": {
        "properties": [
          {
            "id": "0.aws:runShellScript",
            "runCommand": ["ifconfig"]
          }
        ]
      }
    }
  }
            """)
            .documentType("Command")
            .build());
    }
}

Create an ssm document in YAML format

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Document;
import com.pulumi.aws.ssm.DocumentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foo = new Document("foo", DocumentArgs.builder()
            .content("""
schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
            """)
            .documentFormat("YAML")
            .documentType("Command")
            .build());
    }
}

Permissions

The permissions attribute specifies how you want to share the document. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID. The permissions mapping supports the following:

type - The permission type for the document. The permission type can be Share.
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.

Import

SSM Documents can be imported using the name, e.g.,

$ pulumi import aws:ssm/document:Document example example

The attachments_source argument does not have an SSM API method for reading the attachment information detail after creation. If the argument is set in the provider configuration on an imported resource, this provider will always show a difference. To workaround this behavior, either omit the argument from the configuration or use ignoreChanges to hide the difference, e.g. terraform resource "aws_ssm_document" "test" { name = "test_document" document_type = "Package" attachments_source { key = "SourceUrl" values = "s3://${aws_s3_bucket.object_bucket.bucket}/test.zip" }

There is no AWS SSM API for reading attachments_source info directly

lifecycle { ignore_changes = attachments_source } }

Constructors

DocumentArgs

constructor(attachmentsSources: Output<List<DocumentAttachmentsSourceArgs>>? = null, content: Output<String>? = null, documentFormat: Output<String>? = null, documentType: Output<String>? = null, name: Output<String>? = null, permissions: Output<Map<String, String>>? = null, tags: Output<Map<String, String>>? = null, targetType: Output<String>? = null, versionName: Output<String>? = null)