Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::SSM::Parameter

The AWS::SSM::Parameter resource creates an Amazon EC2 Systems Manager (SSM) parameter in Parameter Store.

Syntax

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

JSON

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

YAML

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

Properties

Name

The name of the parameter. Names must not be prefixed with aws or ssm.

Required: No

Type: String

Update requires: Replacement

Description

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

Required: No

Type: String

Update requires: No interruption

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 the Parameter Store.

JSON

Copy
{ "Description": "Create SSM Parameter", "Resources": { "BasicParameter": { "Type": "AWS::SSM::Parameter", "Properties": { "Name": "command", "Type": "String", "Value": "date", "Description": "SSM Parameter for running date command." } } } }

YAML

Copy
Description: "Create SSM Parameter" Resources: BasicParameter: Type: "AWS::SSM::Parameter" Properties: Name: "command" Type: "String" Value: "date" Description: "SSM Parameter for running date command."

SSM Parameter (StringList) Example

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

JSON

Copy
{ "Description": "Create SSM Parameter", "Resources": { "BasicParameter": { "Type": "AWS::SSM::Parameter", "Properties": { "Name": "commands", "Type": "StringList", "Value": "date,ls", "Description": "SSM Parameter of type StringList." } } } }

YAML

Copy
Description: "Create SSM Parameter" Resources: BasicParameter: Type: "AWS::SSM::Parameter" Properties: Name: "commands" Type: "StringList" Value: "date,ls" Description: "SSM Parameter of type StringList."