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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ssm.Document("foo", {
    name: "test_document",
    documentType: "Command",
    content: `  {
    "schemaVersion": "1.2",
    "description": "Check ip configuration of a Linux instance.",
    "parameters": {
    },
    "runtimeConfig": {
      "aws:runShellScript": {
        "properties": [
          {
            "id": "0.aws:runShellScript",
            "runCommand": ["ifconfig"]
          }
        ]
      }
    }
  }
`,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
foo = aws.ssm.Document("foo",
    name="test_document",
    document_type="Command",
    content="""  {
    "schemaVersion": "1.2",
    "description": "Check ip configuration of a Linux instance.",
    "parameters": {
    },
    "runtimeConfig": {
      "aws:runShellScript": {
        "properties": [
          {
            "id": "0.aws:runShellScript",
            "runCommand": ["ifconfig"]
          }
        ]
      }
    }
  }
""")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var foo = new Aws.Ssm.Document("foo", new()
    {
        Name = "test_document",
        DocumentType = "Command",
        Content = @"  {
    ""schemaVersion"": ""1.2"",
    ""description"": ""Check ip configuration of a Linux instance."",
    ""parameters"": {
    },
    ""runtimeConfig"": {
      ""aws:runShellScript"": {
        ""properties"": [
          {
            ""id"": ""0.aws:runShellScript"",
            ""runCommand"": [""ifconfig""]
          }
        ]
      }
    }
  }
",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewDocument(ctx, "foo", &ssm.DocumentArgs{
			Name:         pulumi.String("test_document"),
			DocumentType: pulumi.String("Command"),
			Content: pulumi.String(`  {
    "schemaVersion": "1.2",
    "description": "Check ip configuration of a Linux instance.",
    "parameters": {
    },
    "runtimeConfig": {
      "aws:runShellScript": {
        "properties": [
          {
            "id": "0.aws:runShellScript",
            "runCommand": ["ifconfig"]
          }
        ]
      }
    }
  }
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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()
            .name("test_document")
            .documentType("Command")
            .content("""
  {
    "schemaVersion": "1.2",
    "description": "Check ip configuration of a Linux instance.",
    "parameters": {
    },
    "runtimeConfig": {
      "aws:runShellScript": {
        "properties": [
          {
            "id": "0.aws:runShellScript",
            "runCommand": ["ifconfig"]
          }
        ]
      }
    }
  }
            """)
            .build());
    }
}
Content copied to clipboard
resources:
  foo:
    type: aws:ssm:Document
    properties:
      name: test_document
      documentType: Command
      content: |2
          {
            "schemaVersion": "1.2",
            "description": "Check ip configuration of a Linux instance.",
            "parameters": {
            },
            "runtimeConfig": {
              "aws:runShellScript": {
                "properties": [
                  {
                    "id": "0.aws:runShellScript",
                    "runCommand": ["ifconfig"]
                  }
                ]
              }
            }
          }
Content copied to clipboard

Create an ssm document in YAML format

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ssm.Document("foo", {
    name: "test_document",
    documentFormat: "YAML",
    documentType: "Command",
    content: `schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
`,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
foo = aws.ssm.Document("foo",
    name="test_document",
    document_format="YAML",
    document_type="Command",
    content="""schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
""")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var foo = new Aws.Ssm.Document("foo", new()
    {
        Name = "test_document",
        DocumentFormat = "YAML",
        DocumentType = "Command",
        Content = @"schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewDocument(ctx, "foo", &ssm.DocumentArgs{
			Name:           pulumi.String("test_document"),
			DocumentFormat: pulumi.String("YAML"),
			DocumentType:   pulumi.String("Command"),
			Content: pulumi.String(`schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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()
            .name("test_document")
            .documentFormat("YAML")
            .documentType("Command")
            .content("""
schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
  'aws:runShellScript':
    properties:
      - id: '0.aws:runShellScript'
        runCommand:
          - ifconfig
            """)
            .build());
    }
}
Content copied to clipboard
resources:
  foo:
    type: aws:ssm:Document
    properties:
      name: test_document
      documentFormat: YAML
      documentType: Command
      content: |
        schemaVersion: '1.2'
        description: Check ip configuration of a Linux instance.
        parameters: {}
        runtimeConfig:
          'aws:runShellScript':
            properties:
              - id: '0.aws:runShellScript'
                runCommand:
                  - ifconfig
Content copied to clipboard

Import

Using pulumi import, import SSM Documents using the name. For example:

$ pulumi import aws:ssm/document:Document example example
Content copied to clipboard

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 Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignore_changes to hide the difference. For example:

Constructors

Link copied to clipboard
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)

Properties

Link copied to clipboard
val attachmentsSources: Output<List<DocumentAttachmentsSourceArgs>>? = null

One or more configuration blocks describing attachments sources to a version of a document. See attachments_source block below for details.

Link copied to clipboard
val content: Output<String>? = null

The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

Link copied to clipboard
val documentFormat: Output<String>? = null

The format of the document. Valid values: JSON, TEXT, YAML.

Link copied to clipboard
val documentType: Output<String>? = null

The type of the document. For a list of valid values, see the API Reference.

Link copied to clipboard
val name: Output<String>? = null

The name of the document.

Link copied to clipboard
val permissions: Output<Map<String, String>>? = null

Additional permissions to attach to the document. See Permissions below for details.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of tags to assign to the object. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val targetType: Output<String>? = null

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference.

Link copied to clipboard
val versionName: Output<String>? = null

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Functions

Link copied to clipboard
open override fun toJava(): DocumentArgs