AWS Native v0.63.0, May 25 23

aws-native.ssm.getDocument

Explore with Pulumi AI

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>

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]

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-native:ssm:getDocument
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: A name for the Systems Manager document.

Name string: A name for the Systems Manager document.

name String: A name for the Systems Manager document.

name string: A name for the Systems Manager document.

name str: A name for the Systems Manager document.

name String: A name for the Systems Manager document.

getDocument Result

The following output properties are available:

Attachments List<Pulumi.AwsNative.SSM.Outputs.DocumentAttachmentsSource>: A list of key and value pairs that describe attachments to a version of a document.
Content object: The content for the Systems Manager document in JSON, YAML or String format.
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.SSM.Outputs.DocumentTag>: 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.
UpdateMethod Pulumi.AwsNative.SSM.DocumentUpdateMethod: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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.

Attachments []DocumentAttachmentsSource: A list of key and value pairs that describe attachments to a version of a document.
Content interface{}: The content for the Systems Manager document in JSON, YAML or String format.
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 []DocumentTag: 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.
UpdateMethod DocumentUpdateMethod: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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.

attachments List<DocumentAttachmentsSource>: A list of key and value pairs that describe attachments to a version of a document.
content Object: The content for the Systems Manager document in JSON, YAML or String format.
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<DocumentTag>: 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.
updateMethod DocumentUpdateMethod: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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.

attachments DocumentAttachmentsSource[]: A list of key and value pairs that describe attachments to a version of a document.
content any: The content for the Systems Manager document in JSON, YAML or String format.
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 DocumentTag[]: 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.
updateMethod DocumentUpdateMethod: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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.

attachments Sequence[DocumentAttachmentsSource]: A list of key and value pairs that describe attachments to a version of a document.
content Any: The content for the Systems Manager document in JSON, YAML or String format.
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[DocumentTag]: 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.
update_method DocumentUpdateMethod: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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.

attachments List<Property Map>: A list of key and value pairs that describe attachments to a version of a document.
content Any: The content for the Systems Manager document in JSON, YAML or String format.
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.
updateMethod "Replace" | "NewVersion": Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
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

DocumentAttachmentsSource

Key Pulumi.AwsNative.SSM.DocumentAttachmentsSourceKey: The key of a key-value pair that identifies the location of an attachment to a document.
Name string: The name of the document attachment file.
Values List<string>: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

Key DocumentAttachmentsSourceKey: The key of a key-value pair that identifies the location of an attachment to a document.
Name string: The name of the document attachment file.
Values []string: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

key DocumentAttachmentsSourceKey: The key of a key-value pair that identifies the location of an attachment to a document.
name String: The name of the document attachment file.
values List<String>: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

key DocumentAttachmentsSourceKey: The key of a key-value pair that identifies the location of an attachment to a document.
name string: The name of the document attachment file.
values string[]: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

key DocumentAttachmentsSourceKey: The key of a key-value pair that identifies the location of an attachment to a document.
name str: The name of the document attachment file.
values Sequence[str]: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

key "SourceUrl" | "S3FileUrl" | "AttachmentReference": The key of a key-value pair that identifies the location of an attachment to a document.
name String: The name of the document attachment file.
values List<String>: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

DocumentAttachmentsSourceKey

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.

DocumentTag

Key string: The name of the tag.
Value string: The value of the tag.

Key string: The name of the tag.
Value string: The value of the tag.

key String: The name of the tag.
value String: The value of the tag.

key string: The name of the tag.
value string: The value of the tag.

key str: The name of the tag.
value str: The value of the tag.

key String: The name of the tag.
value String: The value of the tag.

DocumentUpdateMethod

Package Details

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