getDocument function
Gets the contents of the specified Systems Manager document.
Example Usage
To get the contents of the document owned by AWS.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = aws.ssm.getDocument({
name: "AWS-GatherSoftwareInventory",
documentFormat: "YAML",
});
export const content = foo.then(foo => foo.content);
import pulumi
import pulumi_aws as aws
foo = aws.ssm.get_document(name="AWS-GatherSoftwareInventory",
document_format="YAML")
pulumi.export("content", foo.content)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.Ssm.GetDocument.Invoke(new()
{
Name = "AWS-GatherSoftwareInventory",
DocumentFormat = "YAML",
});
return new Dictionary<string, object?>
{
["content"] = foo.Apply(getDocumentResult => getDocumentResult.Content),
};
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
foo, err := ssm.LookupDocument(ctx, &ssm.LookupDocumentArgs{
Name: "AWS-GatherSoftwareInventory",
DocumentFormat: pulumi.StringRef("YAML"),
}, nil)
if err != nil {
return err
}
ctx.Export("content", foo.Content)
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssm_getdocument" "foo" {
name = "AWS-GatherSoftwareInventory"
document_format = "YAML"
}
output "content" {
value = data.aws_ssm_getdocument.foo.content
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.SsmFunctions;
import com.pulumi.aws.ssm.inputs.GetDocumentArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
final var foo = SsmFunctions.getDocument(GetDocumentArgs.builder()
.name("AWS-GatherSoftwareInventory")
.documentFormat("YAML")
.build());
ctx.export("content", foo.content());
}
}
variables:
foo:
fn::invoke:
function: aws:ssm:getDocument
arguments:
name: AWS-GatherSoftwareInventory
documentFormat: YAML
outputs:
content: ${foo.content}
To get the contents of the custom document.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.ssm.getDocument({
name: testAwsSsmDocument.name,
documentFormat: "JSON",
});
import pulumi
import pulumi_aws as aws
test = aws.ssm.get_document(name=test_aws_ssm_document["name"],
document_format="JSON")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = Aws.Ssm.GetDocument.Invoke(new()
{
Name = testAwsSsmDocument.Name,
DocumentFormat = "JSON",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssm.LookupDocument(ctx, &ssm.LookupDocumentArgs{
Name: testAwsSsmDocument.Name,
DocumentFormat: pulumi.StringRef("JSON"),
}, nil)
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssm_getdocument" "test" {
name = testAwsSsmDocument.name
document_format = "JSON"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.SsmFunctions;
import com.pulumi.aws.ssm.inputs.GetDocumentArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
final var test = SsmFunctions.getDocument(GetDocumentArgs.builder()
.name(testAwsSsmDocument.name())
.documentFormat("JSON")
.build());
}
}
variables:
test:
fn::invoke:
function: aws:ssm:getDocument
arguments:
name: ${testAwsSsmDocument.name}
documentFormat: JSON
args Arguments passed to this invoke. Arguments for getDocument.
options Invoke options controlling this call.
Implementation
Future<GetDocumentResult> getDocument(
GetDocumentArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:ssm/getDocument:getDocument',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetDocumentResult.fromMap(result);
}