getParameter function
Provides an SSM Parameter data source.
Example Usage
Default
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = aws.ssm.getParameter({
name: "foo",
});
import pulumi
import pulumi_aws as aws
foo = aws.ssm.get_parameter(name="foo")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.Ssm.GetParameter.Invoke(new()
{
Name = "foo",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssm_getparameter" "foo" {
name = "foo"
}
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.GetParameterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getParameter(GetParameterArgs.builder()
.name("foo")
.build());
}
}
variables:
foo:
fn::invoke:
function: aws:ssm:getParameter
arguments:
name: foo
With version
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = aws.ssm.getParameter({
name: "foo:3",
});
import pulumi
import pulumi_aws as aws
foo = aws.ssm.get_parameter(name="foo:3")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.Ssm.GetParameter.Invoke(new()
{
Name = "foo:3",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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:3",
}, nil)
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssm_getparameter" "foo" {
name = "foo:3"
}
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.GetParameterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getParameter(GetParameterArgs.builder()
.name("foo:3")
.build());
}
}
variables:
foo:
fn::invoke:
function: aws:ssm:getParameter
arguments:
name: foo:3
> Note: The unencrypted value of a SecureString will be stored in the raw state as plain-text.
args Arguments passed to this invoke. Arguments for getParameter.
options Invoke options controlling this call.
Implementation
Future<GetParameterResult> getParameter(
GetParameterArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:ssm/getParameter:getParameter',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetParameterResult.fromMap(result);
}