Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ssm
  5. getParameter

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssm.getParameter

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store. To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify. To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see Managing Access Using Policies in the User Guide. For information about valid values for parameters, see About requirements and constraints for parameter names in the User Guide and PutParameter in the API Reference.

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

> 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)
}
Copy
public static CompletableFuture<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
public static Output<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:ssm:getParameter
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
Name This property is required. string
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
name This property is required. String
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
name This property is required. string
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
name This property is required. str
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
name This property is required. String
The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

getParameter Result

The following output properties are available:

DataType Pulumi.AwsNative.Ssm.ParameterDataType
The data type of the parameter, such as text or aws:ec2:image. The default is text.
Type Pulumi.AwsNative.Ssm.ParameterType
The type of parameter.
Value string
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
DataType ParameterDataType
The data type of the parameter, such as text or aws:ec2:image. The default is text.
Type ParameterType
The type of parameter.
Value string
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
dataType ParameterDataType
The data type of the parameter, such as text or aws:ec2:image. The default is text.
type ParameterType
The type of parameter.
value String
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
dataType ParameterDataType
The data type of the parameter, such as text or aws:ec2:image. The default is text.
type ParameterType
The type of parameter.
value string
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
data_type ParameterDataType
The data type of the parameter, such as text or aws:ec2:image. The default is text.
type ParameterType
The type of parameter.
value str
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
dataType "text" | "aws:ec2:image"
The data type of the parameter, such as text or aws:ec2:image. The default is text.
type "String" | "StringList"
The type of parameter.
value String
The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Supporting Types

ParameterDataType

ParameterType

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native