CloudFormation リソース仕様

AWS CloudFormation リソース仕様は、CloudFormation でサポートされるリソースとプロパティを定義する JSON 形式のテキストファイルです。ドキュメントは機械による読み取り可能な、厳密に指定された仕様です。これを使用して CloudFormation テンプレートを作成するためのツールを構築できます。例えば、仕様を使用して、統合開発環境 (IDE) で CloudFormation テンプレートの自動入力および検証機能を構築できます。

リソース仕様は、単一のファイルとしてまとめることも、1 つのファイルに 1 つのリソースタイプの定義を含む一連のファイルとしてまとめることもできます。単一ファイルおよび分割されたファイルには、同一の情報が含まれています。ツールおよび実装に応じて、1 つのファイルまたは複数のファイルを使用します。

リソース仕様をダウンロードするには、次の表を参照してください。

リソースの可用性はリージョンによって異なります。特定のリージョン内でのリソースの可用性を確認するには、そのリージョンのリソース仕様を参照してください。

リージョン名	リージョン	[単一ファイル]	すべてのファイル
米国東部 (オハイオ)	us-east-2	.json	.zip
米国東部 (バージニア北部)	us-east-1	.json	.zip
米国西部 (北カリフォルニア)	us-west-1	.json	.zip
米国西部 (オレゴン)	us-west-2	.json	.zip
アフリカ (ケープタウン)	af-south-1	.json	.zip
アジアパシフィック (香港)	ap-east-1	.json	.zip
アジアパシフィック (ハイデラバード)	ap-south-2	.json	.zip
アジアパシフィック (ジャカルタ)	ap-southeast-3	.json	.zip
アジアパシフィック (マレーシア)	ap-southeast-5	.json	.zip
アジアパシフィック (メルボルン)	ap-southeast-4	.json	.zip
アジアパシフィック (ムンバイ)	ap-south-1	.json	.zip
アジアパシフィック (大阪)	ap-northeast-3	.json	.zip
アジアパシフィック (ソウル)	ap-northeast-2	.json	.zip
アジアパシフィック (シンガポール)	ap-southeast-1	.json	.zip
アジアパシフィック (シドニー)	ap-southeast-2	.json	.zip
アジアパシフィック (東京)	ap-northeast-1	.json	.zip
カナダ (中部)	ca-central-1	.json	.zip
カナダ西部 (カルガリー)	ca-west-1	.json	.zip
中国 (北京)	cn-north-1	.json	.zip
中国 (寧夏)	cn-northwest-1	.json	.zip
欧州 (フランクフルト)	eu-central-1	.json	.zip
欧州 (アイルランド)	eu-west-1	.json	.zip
欧州 (ロンドン)	eu-west-2	.json	.zip
欧州 (ミラノ)	eu-south-1	.json	.zip
欧州 (パリ)	eu-west-3	.json	.zip
欧州 (スペイン)	eu-south-2	.json	.zip
欧州 (ストックホルム)	eu-north-1	.json	.zip
欧州 (チューリッヒ)	eu-central-2	.json	.zip
イスラエル (テルアビブ)	il-central-1	.json	.zip
中東 (バーレーン)	me-south-1	.json	.zip
中東 (アラブ首長国連邦)	me-central-1	.json	.zip
南米 (サンパウロ)	sa-east-1	.json	.zip
AWS GovCloud (米国東部)	us-gov-east-1	.json	.zip
AWS GovCloud (米国西部)	us-gov-west-1	.json	.zip

次の例は、AWS Key Management Service キーリソース (AWS::KMS::Key) の仕様を示します。これは AWS::KMS::Key リソースのプロパティ、どのプロパティが必須か、各プロパティで許可されている値の型、更新動作を示しています。仕様の詳細については、「仕様の形式」を参照してください。

    "AWS::KMS::Key": {
      "Attributes": {
        "Arn": {
          "PrimitiveType": "String"
        }
      },
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
      "Properties": {
        "Description": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "EnableKeyRotation": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "Enabled": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "KeyPolicy": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy",
          "PrimitiveType": "Json",
          "Required": true,
          "UpdateType": "Mutable"
        },
        "KeyUsage": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Immutable"
        }
      }
    }