AWS Classic v5.41.0, May 15 23

aws.ssm.getParametersByPath

Explore with Pulumi AI

Provides SSM Parameters by path.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var foo = Aws.Ssm.GetParametersByPath.Invoke(new()
    {
        Path = "/foo",
    });

});

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.GetParametersByPath(ctx, &ssm.GetParametersByPathArgs{
			Path: "/foo",
		}, nil)
		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.SsmFunctions;
import com.pulumi.aws.ssm.inputs.GetParametersByPathArgs;
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) {
        final var foo = SsmFunctions.getParametersByPath(GetParametersByPathArgs.builder()
            .path("/foo")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

foo = aws.ssm.get_parameters_by_path(path="/foo")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = aws.ssm.getParametersByPath({
    path: "/foo",
});

variables:
  foo:
    fn::invoke:
      Function: aws:ssm:getParametersByPath
      Arguments:
        path: /foo

Using getParametersByPath

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 getParametersByPath(args: GetParametersByPathArgs, opts?: InvokeOptions): Promise<GetParametersByPathResult>
function getParametersByPathOutput(args: GetParametersByPathOutputArgs, opts?: InvokeOptions): Output<GetParametersByPathResult>

def get_parameters_by_path(path: Optional[str] = None,
                           recursive: Optional[bool] = None,
                           with_decryption: Optional[bool] = None,
                           opts: Optional[InvokeOptions] = None) -> GetParametersByPathResult
def get_parameters_by_path_output(path: Optional[pulumi.Input[str]] = None,
                           recursive: Optional[pulumi.Input[bool]] = None,
                           with_decryption: Optional[pulumi.Input[bool]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetParametersByPathResult]

func GetParametersByPath(ctx *Context, args *GetParametersByPathArgs, opts ...InvokeOption) (*GetParametersByPathResult, error)
func GetParametersByPathOutput(ctx *Context, args *GetParametersByPathOutputArgs, opts ...InvokeOption) GetParametersByPathResultOutput

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

public static class GetParametersByPath 
{
    public static Task<GetParametersByPathResult> InvokeAsync(GetParametersByPathArgs args, InvokeOptions? opts = null)
    public static Output<GetParametersByPathResult> Invoke(GetParametersByPathInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetParametersByPathResult> getParametersByPath(GetParametersByPathArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:ssm/getParametersByPath:getParametersByPath
  arguments:
    # arguments dictionary

The following arguments are supported:

Path string: Prefix path of the parameter.
Recursive bool: Whether to recursively return parameters under path. Defaults to false.
WithDecryption bool: Whether to return decrypted SecureString value. Defaults to true.

Path string: Prefix path of the parameter.
Recursive bool: Whether to recursively return parameters under path. Defaults to false.
WithDecryption bool: Whether to return decrypted SecureString value. Defaults to true.

path String: Prefix path of the parameter.
recursive Boolean: Whether to recursively return parameters under path. Defaults to false.
withDecryption Boolean: Whether to return decrypted SecureString value. Defaults to true.

path string: Prefix path of the parameter.
recursive boolean: Whether to recursively return parameters under path. Defaults to false.
withDecryption boolean: Whether to return decrypted SecureString value. Defaults to true.

path str: Prefix path of the parameter.
recursive bool: Whether to recursively return parameters under path. Defaults to false.
with_decryption bool: Whether to return decrypted SecureString value. Defaults to true.

path String: Prefix path of the parameter.
recursive Boolean: Whether to recursively return parameters under path. Defaults to false.
withDecryption Boolean: Whether to return decrypted SecureString value. Defaults to true.

getParametersByPath Result

The following output properties are available:

Arns List<string>
Id string: The provider-assigned unique ID for this managed resource.
Names List<string>
Path string
Types List<string>
Values List<string>
Recursive bool
WithDecryption bool

Arns []string
Id string: The provider-assigned unique ID for this managed resource.
Names []string
Path string
Types []string
Values []string
Recursive bool
WithDecryption bool

arns List<String>
id String: The provider-assigned unique ID for this managed resource.
names List<String>
path String
types List<String>
values List<String>
recursive Boolean
withDecryption Boolean

arns string[]
id string: The provider-assigned unique ID for this managed resource.
names string[]
path string
types string[]
values string[]
recursive boolean
withDecryption boolean

arns Sequence[str]
id str: The provider-assigned unique ID for this managed resource.
names Sequence[str]
path str
types Sequence[str]
values Sequence[str]
recursive bool
with_decryption bool

arns List<String>
id String: The provider-assigned unique ID for this managed resource.
names List<String>
path String
types List<String>
values List<String>
recursive Boolean
withDecryption Boolean

Package Details

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

aws.ssm.getParametersByPath

Example Usage

Using getParametersByPath

getParametersByPath Result

Package Details

On this page