AWS CloudFormationユーザーガイド – 構成要素・概念について

パラメータを指定すると、実行時にあなたが上書きした値は、aws cloudformation describe-stacksコマンドの返り値として表示されます。(Parameter宣言でNoEchoプロパティにtrueを指定して抑制しない限り。) NoEchoプロパティを使う場合、パラメータ値はアスタリスク(*****)として表示されます。(上書きしないパラメータ値は表示されません。)

パラメータは、以下のタイプで宣言される可能性があります。Number(数値)、String(文字列)、CommaDelimitedList(カンマ区切りの文字列)です。String型やNumber型を持つパラメータの場合、AWS CloudFormationはパラメータ値検証のための制約を定義する事が出来ます。

String型の場合、次の制約を定義する事が出来ます。：MinLength(最小文字列長)、MaxLength(最大文字列長)、Default(デフォルト値)、AllowedValues(許可された値)、AllowedPattern(許可された文字列パターン)

パラメータ制約の詳細については、Parameters Declarationをご参照ください。

全てのパラメータ値は、テンプレートJSONの文字列として指定される事に注意してください。つまりNumberパラメータ値も引用符で囲む必要があります。例えば、 以下例のMyNumberのデフォルト値は数値を指定し、それを引用符で囲んでいます。

"Parameters" : {
    "MyNumber" : {
      "Type" : "Number",
      "Default" : "10",
      "MinValue" : "1"
    }
}

パラメータはResourcesセクション及びOutputsセクションで間接参照する事ができるので、あなたがリソース(Resource)やリソースプロパティ(Resource Property)、参照や関数(function)、アウトプット値に対する値として宣言したどんなパラメータでも使う事が出来ます。以下InstanceTypeパラメータの宣言例では、列挙型の値：t1.micro, m1.small, and m1.largeのデフォルト値としてm1.smallを宣言しています。

"Parameters" : {
    "InstanceType" : {
      "Type" : "String",
      "Default" : "t1.micro",
      "AllowedValues" : ["t1.micro", "m1.small", "m1.large"],
      "Description" : "Enter t1.micro, m1.small, or m1.large. Default is t1.micro."
    }
}

もしコマンドラインで値を上書きしたい場合、実行コマンドは以下のようになります。(見易さを優先して適宜改行を入れていますが実際は1行です)

aws cloudformation create-stack
    --stack-name TestStack
    --template-body file:///home/local/MyTemplate.template
    --parameters ParameterKey=InstanceType,ParameterValue=m1.large

もしパラメータが複数ある場合、スペースでparam-valueのペアを区切ります。例えば、MyTemplate.templateは2つのパラメータ値を必要とする、と仮定します。その際、あなたは以下のようなコマンドを使用して、テンプレートに基づいたスタックを作成する事が出来ます。

[javascrpit] aws cloudformation create-stack --stack-name TestStack --template-body file:///home/local/MyTemplate.template --parameters ParameterKey=MyName,ParameterValue=Joe ParameterKey=MyValue,ParameterValue=10 [/javascrpit]

このケースでは、パラメータ名を間違えた場合にAWS CloudFormationはスタックを作成しないという事に注意してください。これは、テンプレートがパラメータを含まなかった、という事を意味します。

サンプルテンプレートの殆どは、Parametersセクションを宣言しています(Example Templatesを参照)。また、パラメータセクションのフォーマットに関する技術的詳細については、Parameters Declarationをご参照ください。

マッピング(Mappings)

マッピング(Mappings)は、テンプレート中の条件パラメータ値に指定する事が出来ます。組み込み関数Fn::FindInMapを使った場合は、これらはCaseステートメントやルックアップテーブルのように動作します。

Mappingsセクション(省略可能)では、1つまたは複数のマッピング情報を定義します。各マッピングは、テンプレート内で一意の論理名を持ち、1つ以上のキー属性の組を定義しています。各属性は、リテラル文字列orリテラル文字列の配列で無ければなりません。パラメータ(Patemeter)、擬似パラメータ(Pseudo Parameter)、組み込み関数(intrinsic function)に対してマッピングを使う事は出来ません。必要な数分、条件付きマッピングキーを宣言すると共に、どのキーがデフォルトであるかを宣言する事が出来ます。以下例では、Mappingsセクションにて、リージョン名：特定のAmazonマシンイメージ(AMI)にマッピングした4件の情報を持つマップを宣言しています。

"Mappings" : {
"RegionMap" : {
    "us-east-1" : {
      "AMI" : "ami-76f0061f"
    },
    "us-west-1" : {
      "AMI" : "ami-655a0a20"
    },
    "eu-west-1" : {
      "AMI" : "ami-7fd4e10b"
    },
    "ap-southeast-1" : {
      "AMI" : "ami-72621c20"
    }
  }
}

Resourceプロパティ又はOutputに対してマッピング属性値を代入したい場合、Fn::FindInMap関数を使用します(詳細はFn::FindInMapを参照)。マッピングセクションの形式に関する技術的な詳細はMappings Declaration をご参照ください。

擬似パラメータ(Pseudo Parameters)

擬似パラメータ(Pseudo Parameters)はAWS CloudFormationが利用者のために用意したパラメータです。テンプレート内で宣言する事無く、それらを使用する事が出来ます。AWS CloudFormationは、パラメータ名または論理リソース名をとして使うかも知れないであろうあらゆる場所で使える、幾つかの擬似パラメータを宣言しています。

以下の擬似パラメータがAWS CluodFormationでサポートされています。

リソース(Resources)

リソース(Resources)はAWS CloudFormationによって生成・削除されます。それぞれ、テンプレートにはResourceセクションが少なくとも1つ宣言されている必要があります。それぞれのリソースは別々に宣言されます。Resourcesセクションでは同じタイプのリソースを複数指定する事が出来ますが、リソース宣言は同じ型のインスタンスは1つしか作成しません。

各リソースの宣言はテンプレート内で一意の論理名を含み、リソースに対応する型を指定しています。(有効な型名の一覧はResource Property Types Referenceに記載されています)

Resourceセクションで宣言されたリソースは、Propertiesセクションを含んでいます。Propertiesセクションでは、リソースに対するプロパティ(必須・オプション)双方を宣言します。以下例はmyLinuxBundle-2011-12-30のIDを持つAMIイメージを宣言したものです。

"Resources" :{
    "MySimpleImage" : {
        "Type" : "AWS::EC2::Image",
        "Properties" : {
            "ImageId" : "myLinuxBundle-2011-12-30",
        }
    }
} 

論理名MySimpleImageはテンプレート内で参照として、パラメータと同じように使う事が出来ます。Resource プロパティに関する情報は次のセクション、Resource Propertiesに含まれています。

サンプルテンプレートでは全て、Resourceセクションを宣言しています(Example Templatesを参照)。また、Resoureceセクションのフォーマットについての技術的な詳細に関してはResource Declarationをご参照ください。

リソースプロパティ(Resource Properties)

殆どのリソースは、作成するために事前に特定の値を指定する必要とがあります。もしリソースが任意のプロパティの宣言を必要としない場合、Propertiesセクションを省略する事が出来ます。

リソースのPropertiesセクションで宣言されたプロパティはリソースが作成されるための型に固有のものであり、所有リソースに従って宣言されています(AWS Resource Types Referenceを参照)。

以下例では、"MyVolume"と命名された、3つのプロパティを宣言しているリソースの宣言を示しています。

Resources : {
    "MyVolume" : {
        "Type" : "AWS::EC2::Volume",
        "Properties" : {
            "Size" : "4",
            "SnapshotId" : "snap234",
            "AvailabilityZone" : "us-east-1a"
        }
    }
 }
 

リソースのプロパティは、リテラル、パラメータ参照、擬似パラメータ(Pseudo Parameters)、組み込み関数(intrinsic functions)に自らの値を設定する事が出来ます。

サンプルテンプレートの殆どは、1つ以上のプロパティを宣言しています(Example Templatesを参照)。また、Propertiesセクションのフォーマットについての技術的詳細についてはProperties Declarationをご参照ください。

リファレンス(References)

Ref関数を使って、他のリソース、アウトプット、パラメータ、組み込み関数(intrinsic function)等の値を間接参照するためにリソースの論理名を指定する事が出来ます。

例えば、Resourceセクションでは、あなたはHighRestrictionという論理名を持つセキュリティグループのリソースを宣言するかも知れません。その際、別の場所・別のリソース宣言から、別のリソースのプロパティ値としてその要素を"Ref" : "HighRestriction"を使う事で参照出来るようになります。

以下の例では、パラメータ"MyURL"は値http://aws.amazon.comを持った形で宣言されています。その後のセクションでは、値は"Ref" : "MyURL"の形で間接参照されています。

"Parameters" : {
    "MyURL" : {
        "Type" : "String",
        "Default" : "http://aws.amazon.com"
    },

    ...

"Outputs" : {
    "URL" : {
        "Value" : { "Ref" : "MyURL" }
    }
}

間接参照オブジェクトに対してAWS CloudFormationが返す値は、リソースの型(type)に依存します。 それぞれのサポートされている型に対してどのような特定値が返されるかの詳細については、Resource Property Types Referenceをご参照ください。

サンプルデータの多くで、Ref関数を利用しています(Example Templatesを参照)。また、Ref関数についての技術的詳細はRefをご参照ください。

組み込み関数(Intrinsic Functions)

AWS CloudFormationでは実行時までは使用出来ない値を渡すために使用出来る関数を提供しています。使用の際は、Fn::(関数名)という形式でインラインで指定します。

引数は、リテラル文字列、文字列のリスト、パラメータ参照、擬似パラメータ(Pseudo Parameter)、または別の関数から返された値にする事が出来ます。

以下例では、URL出力の値をFn::GetAtt関数によってスタック生成時に取得しています。(URLの)値はMyLoadBalancerという名前のロードバランサによって割り当てられたDNS名の値に基づいています。

"Outputs" : {
    "URL" : {
        "Value" : { "Fn::GetAtt" : [ "MyLoadBalancer", "DNSName" ] }
    }
}

現在、AWS CloudFormationは以下の関数をサポートしています。

サンプルの多くで、組み込み関数を使っています(Example Templatesを参照)。組み込み関数の技術的な詳細については、Function Declarationをご参照ください。

アウトプット(Outputs)

テンプレートのユーザーに渡される情報を宣言するためにOutputセクションでテンプレートを使う事が出来ます。出力はAWS CloudFormationのdescribe-stacksコマンドによって返されます。

出力情報を宣言するために、文字列値またはAWS CloudFormationの関数を使用する事が出来ます。

Outputsセクションの情報は、存在するスタックに対するaws cloudformation describe-stacksのみによって返されます。スタックの作成、またはスタック削除時に失敗した場合、Outputセクションで宣言された値は返される事はありません。以下例では、URLと命名された出力は文字列値http://aws.amazon.com/cloudformationを返します。

"Outputs" : {
    "URL" : {
        "Value" : "http://aws.amazon.com/cloudformation"
    }
}

多くのサンプルではOutputsセクションを宣言しています(Example Templatesを参照)。また、Outputsの技術的詳細についてはOutputs Declarationをご参照ください。