AWS CloudFormation
User Guide (API 版本 2010-05-15)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

AWS::SSM::Parameter

AWS::SSM::Parameter 资源在 Parameter Store 中创建 Amazon EC2 Systems Manager (SSM) 参数。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

Name

参数的名称。名称不能以 awsssm 作为前缀。

Required: No

Type: String

更新要求替换

Description

有关要添加到系统的参数的信息。

Required: No

Type: String

更新要求无需中断

Type

参数的类型。有效值包括:StringStringList

注意

AWS CloudFormation 不支持 SecureString 参数类型。

Required: Yes

Type: String

更新要求无需中断

Value

参数值。值不能嵌套另一个参数。不要在值中使用 {{}}

Required: Yes

Type: String

更新要求无需中断

AllowedPattern

用于验证参数值有效性的正则表达式。例如,对于值限制为数字的字符串类型,您可以指定如下表达式:AllowedPattern=^\d+$

Required: No

Type: String

更新要求无需中断

返回值

Ref

当您将 AWS::SSM::Parameter 资源的逻辑 ID 传递给内部函数 Ref 时,该函数返回 SSM 参数的名称。例如:ssm-myparameter-ABCNPH3XCAO6

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

Type

返回参数的类型。有效值为 StringStringList

Value

返回参数值。

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

示例

SSM 参数 (字符串) 示例

以下示例代码段在 Parameter Store 中创建一个 SSM 参数。

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 参数 (StringList) 示例

以下示例创建一个 StringList 类型的 SSM 参数。

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}$"

本页内容: