Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ssm
  5. getDocument

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssm.getDocument

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.

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>
Copy
def get_document(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDocumentResult
def get_document_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDocumentResult]
Copy
func LookupDocument(ctx *Context, args *LookupDocumentArgs, opts ...InvokeOption) (*LookupDocumentResult, error)
func LookupDocumentOutput(ctx *Context, args *LookupDocumentOutputArgs, opts ...InvokeOption) LookupDocumentResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
public static Output<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:ssm:getDocument
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
A name for the Systems Manager document.
Name This property is required. string
A name for the Systems Manager document.
name This property is required. String
A name for the Systems Manager document.
name This property is required. string
A name for the Systems Manager document.
name This property is required. str
A name for the Systems Manager document.
name This property is required. String
A name for the Systems Manager document.

getDocument Result

The following output properties are available:

Content object

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

DocumentFormat Pulumi.AwsNative.Ssm.DocumentFormat
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
Requires List<Pulumi.AwsNative.Ssm.Outputs.DocumentRequires>
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
TargetType string
Specify a target type to define the kinds of resources the document can run on.
VersionName string
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
Content interface{}

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

DocumentFormat DocumentFormat
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
Requires []DocumentRequires
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
Tags Tag
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
TargetType string
Specify a target type to define the kinds of resources the document can run on.
VersionName string
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
content Object

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

documentFormat DocumentFormat
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
requires List<DocumentRequires>
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
tags List<Tag>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
targetType String
Specify a target type to define the kinds of resources the document can run on.
versionName String
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
content any

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

documentFormat DocumentFormat
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
requires DocumentRequires[]
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
tags Tag[]
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
targetType string
Specify a target type to define the kinds of resources the document can run on.
versionName string
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
content Any

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

document_format DocumentFormat
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
requires Sequence[DocumentRequires]
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
tags Sequence[root_Tag]
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
target_type str
Specify a target type to define the kinds of resources the document can run on.
version_name str
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
content Any

The content for the Systems Manager document in JSON, YAML or String format.

Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

documentFormat "YAML" | "JSON" | "TEXT"
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
requires List<Property Map>
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
tags List<Property Map>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
targetType String
Specify a target type to define the kinds of resources the document can run on.
versionName String
An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.

Supporting Types

DocumentFormat

DocumentRequires

Name string
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
Version string
The document version required by the current document.
Name string
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
Version string
The document version required by the current document.
name String
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
version String
The document version required by the current document.
name string
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
version string
The document version required by the current document.
name str
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
version str
The document version required by the current document.
name String
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
version String
The document version required by the current document.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native