← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Source code

getDocument

Gets the contents of the specified Systems Manager document.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Aws.Ssm.GetDocument.InvokeAsync(new Aws.Ssm.GetDocumentArgs
        {
            Name = "AWS-GatherSoftwareInventory",
            DocumentFormat = "YAML",
        }));
        this.Content = foo.Apply(foo => foo.Content);
    }

    [Output("content")]
    public Output<string> Content { get; set; }
}

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 {
		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
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = Output.of(SsmFunctions.getDocument(GetDocumentArgs.builder()
            .name("AWS-GatherSoftwareInventory")
            .documentFormat("YAML")
            .build()));

        ctx.export("content", foo.apply(getDocumentResult -> getDocumentResult.content()));
    }
}

import pulumi
import pulumi_aws as aws

foo = aws.ssm.get_document(name="AWS-GatherSoftwareInventory",
    document_format="YAML")
pulumi.export("content", foo.content)

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);

variables:
  foo:
    Fn::Invoke:
      Function: aws:ssm:getDocument
      Arguments:
        name: AWS-GatherSoftwareInventory
        documentFormat: YAML
outputs:
  content: ${foo.content}

Using getDocument

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDocument(args: GetDocumentArgs, opts?: InvokeOptions): Promise<GetDocumentResult>
function getDocumentOutput(args: GetDocumentOutputArgs, opts?: InvokeOptions): Output<GetDocumentResult>

def get_document(document_format: Optional[str] = None,
                 document_version: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDocumentResult
def get_document_output(document_format: Optional[pulumi.Input[str]] = None,
                 document_version: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDocumentResult]

func LookupDocument(ctx *Context, args *LookupDocumentArgs, opts ...InvokeOption) (*LookupDocumentResult, error)
func LookupDocumentOutput(ctx *Context, args *LookupDocumentOutputArgs, opts ...InvokeOption) LookupDocumentResultOutput

> Note: This function is named LookupDocument in the Go SDK.

public static class GetDocument 
{
    public static Task<GetDocumentResult> InvokeAsync(GetDocumentArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentResult> Invoke(GetDocumentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: aws:ssm/getDocument:getDocument
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string: The name of the Systems Manager document.
DocumentFormat string: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
DocumentVersion string: The document version for which you want information.

Name string: The name of the Systems Manager document.
DocumentFormat string: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
DocumentVersion string: The document version for which you want information.

name String: The name of the Systems Manager document.
documentFormat String: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
documentVersion String: The document version for which you want information.

name string: The name of the Systems Manager document.
documentFormat string: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
documentVersion string: The document version for which you want information.

name str: The name of the Systems Manager document.
document_format str: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
document_version str: The document version for which you want information.

name String: The name of the Systems Manager document.
documentFormat String: Returns the document in the specified format. The document format can be either JSON, YAML and TEXT. JSON is the default format.
documentVersion String: The document version for which you want information.

getDocument Result

The following output properties are available:

Arn string: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
Content string: The contents of the document.
DocumentType string: The type of the document.
Id string: The provider-assigned unique ID for this managed resource.
Name string
DocumentFormat string
DocumentVersion string

Arn string: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
Content string: The contents of the document.
DocumentType string: The type of the document.
Id string: The provider-assigned unique ID for this managed resource.
Name string
DocumentFormat string
DocumentVersion string

arn String: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
content String: The contents of the document.
documentType String: The type of the document.
id String: The provider-assigned unique ID for this managed resource.
name String
documentFormat String
documentVersion String

arn string: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
content string: The contents of the document.
documentType string: The type of the document.
id string: The provider-assigned unique ID for this managed resource.
name string
documentFormat string
documentVersion string

arn str: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
content str: The contents of the document.
document_type str: The type of the document.
id str: The provider-assigned unique ID for this managed resource.
name str
document_format str
document_version str

arn String: The ARN of the document. If the document is an AWS managed document, this value will be set to the name of the document instead.
content String: The contents of the document.
documentType String: The type of the document.
id String: The provider-assigned unique ID for this managed resource.
name String
documentFormat String
documentVersion String

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.