Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Systems Manager Resource Types Reference » AWS::SSM::Parameter

AWS::SSM::Parameter

The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store.

For information about valid values for parameters, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide and PutParameter in the AWS Systems Manager API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSM::Parameter",
  "Properties" : {
    "AllowedPattern" : String,
    "Description" : String,
    "Name" : String,
    "Type" : String,
    "Value" : String
  }
}

YAML

Type: "AWS::SSM::Parameter"
Properties: 
  AllowedPattern: String
  Description: String
  Name: String
  Type: String
  Value: String

Properties

AllowedPattern

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+$

Required: No

Type: String

Update requires: No interruption

Description

Information about the parameter that you want to add to the system.

Required: No

Type: String

Update requires: No interruption

Name

The name of the parameter.

For information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

Required: No

Type: String

Update requires: Replacement

Type

The type of parameter. Valid values include the following: String or StringList.

Note

AWS CloudFormation doesn't support the SecureString parameter type.

Required: Yes

Type: String

Update requires: No interruption

Value

The parameter value. Value must not nest another parameter. Do not use {{}} in the value.

Required: Yes

Type: String

Update requires: No interruption

Return Value

Ref

When you pass the logical ID of an AWS::SSM::Parameter resource to the intrinsic Ref function, the function returns the Name of the SSM parameter. For example, ssm-myparameter-ABCNPH3XCAO6.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

Type

Returns the type of the parameter. Valid values are String or StringList.

Value

Returns the value of the parameter.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Examples

SSM Parameter (String) Example

The following example snippet creates an SSM parameter in Parameter Store.

JSON

{
   "Description": "Create SSM Parameter",
   "Resources": {
      "BasicParameter": {
         "Type": "AWS::SSM::Parameter",
         "Properties": {
            "Name": "command",
            "Type": "String",
            "Value": "date",
            "Description": "SSM Parameter for running date command.",
            "AllowedPattern" : "^[a-zA-Z]{1,10}$"
         }
      }
   }
}

YAML

Description: "Create SSM Parameter"
Resources:
  BasicParameter:
    Type: "AWS::SSM::Parameter"
    Properties:
      Name: "command"
      Type: "String"
      Value: "date"
      Description: "SSM Parameter for running date command."
      AllowedPattern: "^[a-zA-Z]{1,10}$"

SSM Parameter (StringList) Example

The following example creates an SSM parameter with a StringList type.

JSON

{
   "Description": "Create SSM Parameter",
   "Resources": {
      "BasicParameter": {
         "Type": "AWS::SSM::Parameter",
         "Properties": {
            "Name": "commands",
            "Type": "StringList",
            "Value": "date,ls",
            "Description": "SSM Parameter of type StringList.",
            "AllowedPattern" : "^[a-zA-Z]{1,10}$"
         }
      }
   }
}

YAML

Description: "Create SSM Parameter"
Resources:
  BasicParameter:
    Type: "AWS::SSM::Parameter"
    Properties:
      Name: "commands"
      Type: "StringList"
      Value: "date,ls"
      Description: "SSM Parameter of type StringList."
      AllowedPattern: "^[a-zA-Z]{1,10}$"