1. Packages
  2. AWS Classic
  3. API Docs
  4. ssm
  5. getParameter

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.ssm.getParameter

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an SSM Parameter data source.

    Example Usage

    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    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 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.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.getParameter(GetParameterArgs.builder()
                .name("foo")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: aws:ssm:getParameter
          Arguments:
            name: foo
    

    Note: The unencrypted value of a SecureString will be stored in the raw state as plain-text.

    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
    Name of the parameter.
    WithDecryption bool

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    Name string
    Name of the parameter.
    WithDecryption bool

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    name String
    Name of the parameter.
    withDecryption Boolean

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    name string
    Name of the parameter.
    withDecryption boolean

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    name str
    Name of the parameter.
    with_decryption bool

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    name String
    Name of the parameter.
    withDecryption Boolean

    Whether to return decrypted SecureString value. Defaults to true.

    In addition to all arguments above, the following attributes are exported:

    getParameter Result

    The following output properties are available:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    InsecureValue string
    Name string
    Type string
    Value string
    Version int
    WithDecryption bool
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    InsecureValue string
    Name string
    Type string
    Value string
    Version int
    WithDecryption bool
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    insecureValue String
    name String
    type String
    value String
    version Integer
    withDecryption Boolean
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    insecureValue string
    name string
    type string
    value string
    version number
    withDecryption boolean
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    insecure_value str
    name str
    type str
    value str
    version int
    with_decryption bool
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    insecureValue String
    name String
    type String
    value String
    version Number
    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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi