Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ssm
  5. Parameter

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssm.Parameter

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 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.

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "command",
        Type = AwsNative.Ssm.ParameterType.String,
        Value = "date",
        Description = "SSM Parameter for running date command.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
        Tags = 
        {
            { "environment", "DEV" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("command"),
			Type:           ssm.ParameterTypeString,
			Value:          pulumi.String("date"),
			Description:    pulumi.String("SSM Parameter for running date command."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("DEV"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="command",
    type=aws_native.ssm.ParameterType.STRING,
    value="date",
    description="SSM Parameter for running date command.",
    allowed_pattern="^[a-zA-Z]{1,10}$",
    tags={
        "environment": "DEV",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "command",
    type: aws_native.ssm.ParameterType.String,
    value: "date",
    description: "SSM Parameter for running date command.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
    tags: {
        environment: "DEV",
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "command",
        Type = AwsNative.Ssm.ParameterType.String,
        Value = "date",
        Description = "SSM Parameter for running date command.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
        Tags = 
        {
            { "environment", "DEV" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("command"),
			Type:           ssm.ParameterTypeString,
			Value:          pulumi.String("date"),
			Description:    pulumi.String("SSM Parameter for running date command."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("DEV"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="command",
    type=aws_native.ssm.ParameterType.STRING,
    value="date",
    description="SSM Parameter for running date command.",
    allowed_pattern="^[a-zA-Z]{1,10}$",
    tags={
        "environment": "DEV",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "command",
    type: aws_native.ssm.ParameterType.String,
    value: "date",
    description: "SSM Parameter for running date command.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
    tags: {
        environment: "DEV",
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "commands",
        Type = AwsNative.Ssm.ParameterType.StringList,
        Value = "date,ls",
        Description = "SSM Parameter of type StringList.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("commands"),
			Type:           ssm.ParameterTypeStringList,
			Value:          pulumi.String("date,ls"),
			Description:    pulumi.String("SSM Parameter of type StringList."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="commands",
    type=aws_native.ssm.ParameterType.STRING_LIST,
    value="date,ls",
    description="SSM Parameter of type StringList.",
    allowed_pattern="^[a-zA-Z]{1,10}$")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "commands",
    type: aws_native.ssm.ParameterType.StringList,
    value: "date,ls",
    description: "SSM Parameter of type StringList.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "commands",
        Type = AwsNative.Ssm.ParameterType.StringList,
        Value = "date,ls",
        Description = "SSM Parameter of type StringList.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("commands"),
			Type:           ssm.ParameterTypeStringList,
			Value:          pulumi.String("date,ls"),
			Description:    pulumi.String("SSM Parameter of type StringList."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="commands",
    type=aws_native.ssm.ParameterType.STRING_LIST,
    value="date,ls",
    description="SSM Parameter of type StringList.",
    allowed_pattern="^[a-zA-Z]{1,10}$")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "commands",
    type: aws_native.ssm.ParameterType.StringList,
    value: "date,ls",
    description: "SSM Parameter of type StringList.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "command",
        Type = AwsNative.Ssm.ParameterType.String,
        Value = "date",
        Tier = AwsNative.Ssm.ParameterTier.Advanced,
        Policies = "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
        Description = "SSM Parameter for running date command.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
        Tags = 
        {
            { "environment", "DEV" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("command"),
			Type:           ssm.ParameterTypeString,
			Value:          pulumi.String("date"),
			Tier:           ssm.ParameterTierAdvanced,
			Policies:       pulumi.String("[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"),
			Description:    pulumi.String("SSM Parameter for running date command."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("DEV"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="command",
    type=aws_native.ssm.ParameterType.STRING,
    value="date",
    tier=aws_native.ssm.ParameterTier.ADVANCED,
    policies="[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
    description="SSM Parameter for running date command.",
    allowed_pattern="^[a-zA-Z]{1,10}$",
    tags={
        "environment": "DEV",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "command",
    type: aws_native.ssm.ParameterType.String,
    value: "date",
    tier: aws_native.ssm.ParameterTier.Advanced,
    policies: "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
    description: "SSM Parameter for running date command.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
    tags: {
        environment: "DEV",
    },
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var basicParameter = new AwsNative.Ssm.Parameter("basicParameter", new()
    {
        Name = "command",
        Type = AwsNative.Ssm.ParameterType.String,
        Value = "date",
        Tier = AwsNative.Ssm.ParameterTier.Advanced,
        Policies = "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
        Description = "SSM Parameter for running date command.",
        AllowedPattern = "^[a-zA-Z]{1,10}$",
        Tags = 
        {
            { "environment", "DEV" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ssm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewParameter(ctx, "basicParameter", &ssm.ParameterArgs{
			Name:           pulumi.String("command"),
			Type:           ssm.ParameterTypeString,
			Value:          pulumi.String("date"),
			Tier:           ssm.ParameterTierAdvanced,
			Policies:       pulumi.String("[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"),
			Description:    pulumi.String("SSM Parameter for running date command."),
			AllowedPattern: pulumi.String("^[a-zA-Z]{1,10}$"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("DEV"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

basic_parameter = aws_native.ssm.Parameter("basicParameter",
    name="command",
    type=aws_native.ssm.ParameterType.STRING,
    value="date",
    tier=aws_native.ssm.ParameterTier.ADVANCED,
    policies="[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
    description="SSM Parameter for running date command.",
    allowed_pattern="^[a-zA-Z]{1,10}$",
    tags={
        "environment": "DEV",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicParameter = new aws_native.ssm.Parameter("basicParameter", {
    name: "command",
    type: aws_native.ssm.ParameterType.String,
    value: "date",
    tier: aws_native.ssm.ParameterTier.Advanced,
    policies: "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]",
    description: "SSM Parameter for running date command.",
    allowedPattern: "^[a-zA-Z]{1,10}$",
    tags: {
        environment: "DEV",
    },
});

    Coming soon!

    Create Parameter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Parameter(name: string, args: ParameterArgs, opts?: CustomResourceOptions);
    @overload
def Parameter(resource_name: str,
              args: ParameterArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Parameter(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              type: Optional[ParameterType] = None,
              value: Optional[str] = None,
              allowed_pattern: Optional[str] = None,
              data_type: Optional[ParameterDataType] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              policies: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              tier: Optional[ParameterTier] = None)
    func NewParameter(ctx *Context, name string, args ParameterArgs, opts ...ResourceOption) (*Parameter, error)
    public Parameter(string name, ParameterArgs args, CustomResourceOptions? opts = null)
    public Parameter(String name, ParameterArgs args)
public Parameter(String name, ParameterArgs args, CustomResourceOptions options)

    type: aws-native:ssm:Parameter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ParameterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ParameterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ParameterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Parameter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Parameter resource accepts the following input properties:

    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.
    AllowedPattern string
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    DataType Pulumi.AwsNative.Ssm.ParameterDataType
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    Description string
    Information about the parameter.
    Name 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
    Policies string
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    Tags Dictionary<string, string>
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    Tier Pulumi.AwsNative.Ssm.ParameterTier
    The parameter tier.
    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.
    AllowedPattern string
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    DataType ParameterDataType
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    Description string
    Information about the parameter.
    Name 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
    Policies string
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    Tags map[string]string
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    Tier ParameterTier
    The parameter tier.
    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.
    allowedPattern String
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    dataType ParameterDataType
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    description String
    Information about the parameter.
    name 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
    policies String
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    tags Map<String,String>
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    tier ParameterTier
    The parameter tier.
    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.
    allowedPattern string
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    dataType ParameterDataType
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    description string
    Information about the parameter.
    name 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
    policies string
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    tags {[key: string]: string}
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    tier ParameterTier
    The parameter tier.
    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.
    allowed_pattern str
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    data_type ParameterDataType
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    description str
    Information about the parameter.
    name 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
    policies str
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    tags Mapping[str, str]
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    tier ParameterTier
    The parameter tier.
    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.
    allowedPattern String
    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
    dataType "text" | "aws:ec2:image"
    The data type of the parameter, such as text or aws:ec2:image. The default is text.
    description String
    Information about the parameter.
    name 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
    policies String
    Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
    tags Map<String>
    Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
    tier "Standard" | "Advanced" | "Intelligent-Tiering"
    The parameter tier.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Parameter resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ParameterDataType, ParameterDataTypeArgs

    Text
    text
    Awsec2image
    aws:ec2:image
    ParameterDataTypeText
    text
    ParameterDataTypeAwsec2image
    aws:ec2:image
    Text
    text
    Awsec2image
    aws:ec2:image
    Text
    text
    Awsec2image
    aws:ec2:image
    TEXT
    text
    AWSEC2IMAGE
    aws:ec2:image
    "text"
    text
    "aws:ec2:image"
    aws:ec2:image

    ParameterTier, ParameterTierArgs

    Standard
    Standard
    Advanced
    Advanced
    IntelligentTiering
    Intelligent-Tiering
    ParameterTierStandard
    Standard
    ParameterTierAdvanced
    Advanced
    ParameterTierIntelligentTiering
    Intelligent-Tiering
    Standard
    Standard
    Advanced
    Advanced
    IntelligentTiering
    Intelligent-Tiering
    Standard
    Standard
    Advanced
    Advanced
    IntelligentTiering
    Intelligent-Tiering
    STANDARD
    Standard
    ADVANCED
    Advanced
    INTELLIGENT_TIERING
    Intelligent-Tiering
    "Standard"
    Standard
    "Advanced"
    Advanced
    "Intelligent-Tiering"
    Intelligent-Tiering

    ParameterType, ParameterTypeArgs

    String
    String
    StringList
    StringList
    ParameterTypeString
    String
    ParameterTypeStringList
    StringList
    String
    String
    StringList
    StringList
    String
    String
    StringList
    StringList
    STRING
    String
    STRING_LIST
    StringList
    "String"
    String
    "StringList"
    StringList

    Package Details

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

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

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native