メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::SSM::Parameter

AWS::SSM::Parameter リソースは、パラメータストアで 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

パラメーターの名前。名前には aws または ssm をプレフィックスとして使用しないでください。

Required: No

Type: String

更新に伴う要件: 置換

Description

システムに追加するパラメータに関する情報。

Required: No

Type: String

更新に伴う要件: 中断はありません。

Type

パラメータのタイプ。有効な値には次のようなものがあります。String または StringList です。

注記

AWS CloudFormation は SecureString パラメータタイプをサポートしていません。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

Value

パラメータ値。値は別のパラメータを入れ子にしてはなりません。値の中で {{}} は使用しないでください。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

AllowedPattern

パラメーター値を検証するために使用される正規表現。たとえば、数値に制限された値を持つ文字列型の場合、次のように指定できます。AllowedPattern=^\d+$

Required: No

Type: String

更新に伴う要件: 中断はありません。

戻り値

参照番号

AWS::SSM::Parameter リソースの論理 ID を組み込み Ref 関数に渡すと、関数は SSM パラメータの名前を返します。たとえば、ssm-myparameter-ABCNPH3XCAO6 と指定します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Type

パラメータのタイプを返します。有効な値は String または StringList です。

Value

設定パラメーターの値を返します。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

SSM パラメータ (文字列) の例

以下の例では、スニペットがパラメータストアで 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}$"

このページの内容: