AWS Classic

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

getParameter

Provides an SSM Parameter data source.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Aws.Ssm.GetParameter.InvokeAsync(new Aws.Ssm.GetParameterArgs
        {
            Name = "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.LookupParameter(ctx, &ssm.LookupParameterArgs{
			Name: "foo",
		}, nil)
		if err != nil {
			return err
		}
		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.getParameter(GetParameterArgs.builder()
            .name("foo")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

foo = aws.ssm.get_parameter(name="foo")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = pulumi.output(aws.ssm.getParameter({
    name: "foo",
}));
variables:
  foo:
    Fn::Invoke:
      Function: aws:ssm:getParameter
      Arguments:
        name: foo

Using getParameter

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 getParameter(args: GetParameterArgs, opts?: InvokeOptions): Promise<GetParameterResult>
function getParameterOutput(args: GetParameterOutputArgs, opts?: InvokeOptions): Output<GetParameterResult>
def get_parameter(name: Optional[str] = None,
                  with_decryption: Optional[bool] = None,
                  opts: Optional[InvokeOptions] = None) -> GetParameterResult
def get_parameter_output(name: Optional[pulumi.Input[str]] = None,
                  with_decryption: Optional[pulumi.Input[bool]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetParameterResult]
func LookupParameter(ctx *Context, args *LookupParameterArgs, opts ...InvokeOption) (*LookupParameterResult, error)
func LookupParameterOutput(ctx *Context, args *LookupParameterOutputArgs, opts ...InvokeOption) LookupParameterResultOutput

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

public static class GetParameter 
{
    public static Task<GetParameterResult> InvokeAsync(GetParameterArgs args, InvokeOptions? opts = null)
    public static Output<GetParameterResult> Invoke(GetParameterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:ssm/getParameter:getParameter
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of the parameter.

WithDecryption bool

Whether to return decrypted SecureString value. Defaults to true.

Name string

The name of the parameter.

WithDecryption bool

Whether to return decrypted SecureString value. Defaults to true.

name String

The name of the parameter.

withDecryption Boolean

Whether to return decrypted SecureString value. Defaults to true.

name string

The name of the parameter.

withDecryption boolean

Whether to return decrypted SecureString value. Defaults to true.

name str

The name of the parameter.

with_decryption bool

Whether to return decrypted SecureString value. Defaults to true.

name String

The name of the parameter.

withDecryption Boolean

Whether to return decrypted SecureString value. Defaults to true.

getParameter Result

The following output properties are available:

Arn string
Id string

The provider-assigned unique ID for this managed resource.

Name string
Type string
Value string
Version int
WithDecryption bool
Arn string
Id string

The provider-assigned unique ID for this managed resource.

Name string
Type string
Value string
Version int
WithDecryption bool
arn String
id String

The provider-assigned unique ID for this managed resource.

name String
type String
value String
version Integer
withDecryption Boolean
arn string
id string

The provider-assigned unique ID for this managed resource.

name string
type string
value string
version number
withDecryption boolean
arn str
id str

The provider-assigned unique ID for this managed resource.

name str
type str
value str
version int
with_decryption bool
arn String
id String

The provider-assigned unique ID for this managed resource.

name String
type String
value String
version Number
withDecryption Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.