AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.ssm.Document
Explore with Pulumi AI
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
.
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 beShare
.account_ids
- The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs orAll
.
Example Usage
Create an ssm document in JSON format
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()
{
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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{
Content: pulumi.String(" {\n \"schemaVersion\": \"1.2\",\n \"description\": \"Check ip configuration of a Linux instance.\",\n \"parameters\": {\n\n },\n \"runtimeConfig\": {\n \"aws:runShellScript\": {\n \"properties\": [\n {\n \"id\": \"0.aws:runShellScript\",\n \"runCommand\": [\"ifconfig\"]\n }\n ]\n }\n }\n }\n\n"),
DocumentType: pulumi.String("Command"),
})
if err != nil {
return err
}
return nil
})
}
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());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.ssm.Document("foo",
content=""" {
"schemaVersion": "1.2",
"description": "Check ip configuration of a Linux instance.",
"parameters": {
},
"runtimeConfig": {
"aws:runShellScript": {
"properties": [
{
"id": "0.aws:runShellScript",
"runCommand": ["ifconfig"]
}
]
}
}
}
""",
document_type="Command")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ssm.Document("foo", {
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",
});
resources:
foo:
type: aws:ssm:Document
properties:
content: |2+
{
"schemaVersion": "1.2",
"description": "Check ip configuration of a Linux instance.",
"parameters": {
},
"runtimeConfig": {
"aws:runShellScript": {
"properties": [
{
"id": "0.aws:runShellScript",
"runCommand": ["ifconfig"]
}
]
}
}
}
documentType: Command
Create an ssm document in YAML format
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()
{
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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{
Content: pulumi.String("schemaVersion: '1.2'\ndescription: Check ip configuration of a Linux instance.\nparameters: {}\nruntimeConfig:\n 'aws:runShellScript':\n properties:\n - id: '0.aws:runShellScript'\n runCommand:\n - ifconfig\n\n"),
DocumentFormat: pulumi.String("YAML"),
DocumentType: pulumi.String("Command"),
})
if err != nil {
return err
}
return nil
})
}
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());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.ssm.Document("foo",
content="""schemaVersion: '1.2'
description: Check ip configuration of a Linux instance.
parameters: {}
runtimeConfig:
'aws:runShellScript':
properties:
- id: '0.aws:runShellScript'
runCommand:
- ifconfig
""",
document_format="YAML",
document_type="Command")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ssm.Document("foo", {
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",
});
resources:
foo:
type: aws:ssm:Document
properties:
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
Create Document Resource
new Document(name: string, args: DocumentArgs, opts?: CustomResourceOptions);
@overload
def Document(resource_name: str,
opts: Optional[ResourceOptions] = None,
attachments_sources: Optional[Sequence[DocumentAttachmentsSourceArgs]] = None,
content: Optional[str] = None,
document_format: Optional[str] = None,
document_type: Optional[str] = None,
name: Optional[str] = None,
permissions: Optional[Mapping[str, str]] = None,
tags: Optional[Mapping[str, str]] = None,
target_type: Optional[str] = None,
version_name: Optional[str] = None)
@overload
def Document(resource_name: str,
args: DocumentArgs,
opts: Optional[ResourceOptions] = None)
func NewDocument(ctx *Context, name string, args DocumentArgs, opts ...ResourceOption) (*Document, error)
public Document(string name, DocumentArgs args, CustomResourceOptions? opts = null)
public Document(String name, DocumentArgs args)
public Document(String name, DocumentArgs args, CustomResourceOptions options)
type: aws:ssm:Document
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Document Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Document resource accepts the following input properties:
- Content string
The JSON or YAML content of the document.
- Document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- Attachments
Sources List<Pulumi.Aws. Ssm. Inputs. Document Attachments Source Args> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- Document
Format string The format of the document. Valid document types include:
JSON
andYAML
- Name string
The name of the document.
- Permissions Dictionary<string, string>
Additional Permissions to attach to the document. See Permissions below for details.
- Dictionary<string, string>
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.- Target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- Version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- Content string
The JSON or YAML content of the document.
- Document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- Attachments
Sources []DocumentAttachments Source Args One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- Document
Format string The format of the document. Valid document types include:
JSON
andYAML
- Name string
The name of the document.
- Permissions map[string]string
Additional Permissions to attach to the document. See Permissions below for details.
- map[string]string
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.- Target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- Version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- content String
The JSON or YAML content of the document.
- document
Type String The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- attachments
Sources List<DocumentAttachments Source Args> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- document
Format String The format of the document. Valid document types include:
JSON
andYAML
- name String
The name of the document.
- permissions Map<String,String>
Additional Permissions to attach to the document. See Permissions below for details.
- Map<String,String>
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.- target
Type String 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name String A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- content string
The JSON or YAML content of the document.
- document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- attachments
Sources DocumentAttachments Source Args[] One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- document
Format string The format of the document. Valid document types include:
JSON
andYAML
- name string
The name of the document.
- permissions {[key: string]: string}
Additional Permissions to attach to the document. See Permissions below for details.
- {[key: string]: string}
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.- target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- content str
The JSON or YAML content of the document.
- document_
type str The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- attachments_
sources Sequence[DocumentAttachments Source Args] One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- document_
format str The format of the document. Valid document types include:
JSON
andYAML
- name str
The name of the document.
- permissions Mapping[str, str]
Additional Permissions to attach to the document. See Permissions below for details.
- Mapping[str, str]
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.- target_
type str 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version_
name str A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- content String
The JSON or YAML content of the document.
- document
Type String The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- attachments
Sources List<Property Map> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- document
Format String The format of the document. Valid document types include:
JSON
andYAML
- name String
The name of the document.
- permissions Map<String>
Additional Permissions to attach to the document. See Permissions below for details.
- Map<String>
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.- target
Type String 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name String A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
Outputs
All input properties are implicitly available as output properties. Additionally, the Document resource produces the following output properties:
- Arn string
- Created
Date string The date the document was created.
- Default
Version string The default version of the document.
- Description string
The description of the document.
- Document
Version string The document version.
- Hash string
The sha1 or sha256 of the document content
- Hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- Id string
The provider-assigned unique ID for this managed resource.
- Latest
Version string The latest version of the document.
- Owner string
The AWS user account of the person who created the document.
- Parameters
List<Pulumi.
Aws. Ssm. Outputs. Document Parameter> The parameters that are available to this document.
- Platform
Types List<string> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- Schema
Version string The schema version of the document.
- Status string
"Creating", "Active" or "Deleting". The current status of the document.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Created
Date string The date the document was created.
- Default
Version string The default version of the document.
- Description string
The description of the document.
- Document
Version string The document version.
- Hash string
The sha1 or sha256 of the document content
- Hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- Id string
The provider-assigned unique ID for this managed resource.
- Latest
Version string The latest version of the document.
- Owner string
The AWS user account of the person who created the document.
- Parameters
[]Document
Parameter The parameters that are available to this document.
- Platform
Types []string A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- Schema
Version string The schema version of the document.
- Status string
"Creating", "Active" or "Deleting". The current status of the document.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- created
Date String The date the document was created.
- default
Version String The default version of the document.
- description String
The description of the document.
- document
Version String The document version.
- hash String
The sha1 or sha256 of the document content
- hash
Type String "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- id String
The provider-assigned unique ID for this managed resource.
- latest
Version String The latest version of the document.
- owner String
The AWS user account of the person who created the document.
- parameters
List<Document
Parameter> The parameters that are available to this document.
- platform
Types List<String> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version String The schema version of the document.
- status String
"Creating", "Active" or "Deleting". The current status of the document.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- created
Date string The date the document was created.
- default
Version string The default version of the document.
- description string
The description of the document.
- document
Version string The document version.
- hash string
The sha1 or sha256 of the document content
- hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- id string
The provider-assigned unique ID for this managed resource.
- latest
Version string The latest version of the document.
- owner string
The AWS user account of the person who created the document.
- parameters
Document
Parameter[] The parameters that are available to this document.
- platform
Types string[] A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version string The schema version of the document.
- status string
"Creating", "Active" or "Deleting". The current status of the document.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- created_
date str The date the document was created.
- default_
version str The default version of the document.
- description str
The description of the document.
- document_
version str The document version.
- hash str
The sha1 or sha256 of the document content
- hash_
type str "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- id str
The provider-assigned unique ID for this managed resource.
- latest_
version str The latest version of the document.
- owner str
The AWS user account of the person who created the document.
- parameters
Sequence[Document
Parameter] The parameters that are available to this document.
- platform_
types Sequence[str] A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema_
version str The schema version of the document.
- status str
"Creating", "Active" or "Deleting". The current status of the document.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- created
Date String The date the document was created.
- default
Version String The default version of the document.
- description String
The description of the document.
- document
Version String The document version.
- hash String
The sha1 or sha256 of the document content
- hash
Type String "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- id String
The provider-assigned unique ID for this managed resource.
- latest
Version String The latest version of the document.
- owner String
The AWS user account of the person who created the document.
- parameters List<Property Map>
The parameters that are available to this document.
- platform
Types List<String> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version String The schema version of the document.
- status String
"Creating", "Active" or "Deleting". The current status of the document.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing Document Resource
Get an existing Document resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DocumentState, opts?: CustomResourceOptions): Document
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
attachments_sources: Optional[Sequence[DocumentAttachmentsSourceArgs]] = None,
content: Optional[str] = None,
created_date: Optional[str] = None,
default_version: Optional[str] = None,
description: Optional[str] = None,
document_format: Optional[str] = None,
document_type: Optional[str] = None,
document_version: Optional[str] = None,
hash: Optional[str] = None,
hash_type: Optional[str] = None,
latest_version: Optional[str] = None,
name: Optional[str] = None,
owner: Optional[str] = None,
parameters: Optional[Sequence[DocumentParameterArgs]] = None,
permissions: Optional[Mapping[str, str]] = None,
platform_types: Optional[Sequence[str]] = None,
schema_version: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
target_type: Optional[str] = None,
version_name: Optional[str] = None) -> Document
func GetDocument(ctx *Context, name string, id IDInput, state *DocumentState, opts ...ResourceOption) (*Document, error)
public static Document Get(string name, Input<string> id, DocumentState? state, CustomResourceOptions? opts = null)
public static Document get(String name, Output<String> id, DocumentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Attachments
Sources List<Pulumi.Aws. Ssm. Inputs. Document Attachments Source Args> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- Content string
The JSON or YAML content of the document.
- Created
Date string The date the document was created.
- Default
Version string The default version of the document.
- Description string
The description of the document.
- Document
Format string The format of the document. Valid document types include:
JSON
andYAML
- Document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- Document
Version string The document version.
- Hash string
The sha1 or sha256 of the document content
- Hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- Latest
Version string The latest version of the document.
- Name string
The name of the document.
- Owner string
The AWS user account of the person who created the document.
- Parameters
List<Pulumi.
Aws. Ssm. Inputs. Document Parameter Args> The parameters that are available to this document.
- Permissions Dictionary<string, string>
Additional Permissions to attach to the document. See Permissions below for details.
- Platform
Types List<string> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- Schema
Version string The schema version of the document.
- Status string
"Creating", "Active" or "Deleting". The current status of the document.
- Dictionary<string, string>
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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- Version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- Arn string
- Attachments
Sources []DocumentAttachments Source Args One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- Content string
The JSON or YAML content of the document.
- Created
Date string The date the document was created.
- Default
Version string The default version of the document.
- Description string
The description of the document.
- Document
Format string The format of the document. Valid document types include:
JSON
andYAML
- Document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- Document
Version string The document version.
- Hash string
The sha1 or sha256 of the document content
- Hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- Latest
Version string The latest version of the document.
- Name string
The name of the document.
- Owner string
The AWS user account of the person who created the document.
- Parameters
[]Document
Parameter Args The parameters that are available to this document.
- Permissions map[string]string
Additional Permissions to attach to the document. See Permissions below for details.
- Platform
Types []string A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- Schema
Version string The schema version of the document.
- Status string
"Creating", "Active" or "Deleting". The current status of the document.
- map[string]string
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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- Version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- arn String
- attachments
Sources List<DocumentAttachments Source Args> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- content String
The JSON or YAML content of the document.
- created
Date String The date the document was created.
- default
Version String The default version of the document.
- description String
The description of the document.
- document
Format String The format of the document. Valid document types include:
JSON
andYAML
- document
Type String The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- document
Version String The document version.
- hash String
The sha1 or sha256 of the document content
- hash
Type String "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- latest
Version String The latest version of the document.
- name String
The name of the document.
- owner String
The AWS user account of the person who created the document.
- parameters
List<Document
Parameter Args> The parameters that are available to this document.
- permissions Map<String,String>
Additional Permissions to attach to the document. See Permissions below for details.
- platform
Types List<String> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version String The schema version of the document.
- status String
"Creating", "Active" or "Deleting". The current status of the document.
- Map<String,String>
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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- target
Type String 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name String A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- arn string
- attachments
Sources DocumentAttachments Source Args[] One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- content string
The JSON or YAML content of the document.
- created
Date string The date the document was created.
- default
Version string The default version of the document.
- description string
The description of the document.
- document
Format string The format of the document. Valid document types include:
JSON
andYAML
- document
Type string The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- document
Version string The document version.
- hash string
The sha1 or sha256 of the document content
- hash
Type string "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- latest
Version string The latest version of the document.
- name string
The name of the document.
- owner string
The AWS user account of the person who created the document.
- parameters
Document
Parameter Args[] The parameters that are available to this document.
- permissions {[key: string]: string}
Additional Permissions to attach to the document. See Permissions below for details.
- platform
Types string[] A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version string The schema version of the document.
- status string
"Creating", "Active" or "Deleting". The current status of the document.
- {[key: string]: string}
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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- target
Type string 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name string A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- arn str
- attachments_
sources Sequence[DocumentAttachments Source Args] One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- content str
The JSON or YAML content of the document.
- created_
date str The date the document was created.
- default_
version str The default version of the document.
- description str
The description of the document.
- document_
format str The format of the document. Valid document types include:
JSON
andYAML
- document_
type str The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- document_
version str The document version.
- hash str
The sha1 or sha256 of the document content
- hash_
type str "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- latest_
version str The latest version of the document.
- name str
The name of the document.
- owner str
The AWS user account of the person who created the document.
- parameters
Sequence[Document
Parameter Args] The parameters that are available to this document.
- permissions Mapping[str, str]
Additional Permissions to attach to the document. See Permissions below for details.
- platform_
types Sequence[str] A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema_
version str The schema version of the document.
- status str
"Creating", "Active" or "Deleting". The current status of the document.
- Mapping[str, str]
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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- target_
type str 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version_
name str A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
- arn String
- attachments
Sources List<Property Map> One or more configuration blocks describing attachments sources to a version of a document. Defined below.
- content String
The JSON or YAML content of the document.
- created
Date String The date the document was created.
- default
Version String The default version of the document.
- description String
The description of the document.
- document
Format String The format of the document. Valid document types include:
JSON
andYAML
- document
Type String The type of the document. Valid document types include:
Automation
,Command
,Package
,Policy
, andSession
- document
Version String The document version.
- hash String
The sha1 or sha256 of the document content
- hash
Type String "Sha1" "Sha256". The hashing algorithm used when hashing the content.
- latest
Version String The latest version of the document.
- name String
The name of the document.
- owner String
The AWS user account of the person who created the document.
- parameters List<Property Map>
The parameters that are available to this document.
- permissions Map<String>
Additional Permissions to attach to the document. See Permissions below for details.
- platform
Types List<String> A list of OS platforms compatible with this SSM document, either "Windows" or "Linux".
- schema
Version String The schema version of the document.
- status String
"Creating", "Active" or "Deleting". The current status of the document.
- Map<String>
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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- target
Type String 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 Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
- version
Name String A field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and cannot be changed for an existing document version.
Supporting Types
DocumentAttachmentsSource
DocumentParameter
- Default
Value string - Description string
The description of the document.
- Name string
The name of the document.
- Type string
- Default
Value string - Description string
The description of the document.
- Name string
The name of the document.
- Type string
- default
Value String - description String
The description of the document.
- name String
The name of the document.
- type String
- default
Value string - description string
The description of the document.
- name string
The name of the document.
- type string
- default_
value str - description str
The description of the document.
- name str
The name of the document.
- type str
- default
Value String - description String
The description of the document.
- name String
The name of the document.
- type String
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]
} }
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.