ステップ 1: AWS CloudFormation テンプレートをダウンロードする

PDF

AWS CloudFormation テンプレートを使用して、ポートフォリオと製品を設定およびプロビジョニングできます。これらのテンプレートは、JSON または YAML でフォーマットできるテキストファイルで、プロビジョニングするリソースを説明します。詳細については、AWS CloudFormation ユーザーガイドの「テンプレート フォーマット」を参照してください。 AWS CloudFormation エディタまたは任意のテキストエディタを使用して、テンプレートを作成および保存できます。このチュートリアルでは、開始するためのシンプルなテンプレートが用意されています。このテンプレートでは、SSH アクセス用に設定された 1 つの Linux インスタンスを起動します。

注記

AWS CloudFormation テンプレートを使用するには、特別なアクセス許可が必要です。作業を開始する前に、正しい権限があることを確認してください。詳細については、入門ライブラリ の前提条件を参照してください。

テンプレートのダウンロード

このチュートリアルのサンプルテンプレート、development-environment.template は https://awsdocs.s3.amazonaws.com/servicecatalog/development-environment.template で利用可能です。

テンプレートの概要

サンプルテンプレートのテキストは次のとおりです。

{
  "AWSTemplateFormatVersion" : "2010-09-09",

  "Description" : "AWS Service Catalog sample template. Creates an Amazon EC2 instance 
                    running the Amazon Linux AMI. The AMI is chosen based on the region 
                    in which the stack is run. This example creates an EC2 security 
                    group for the instance to give you SSH access. **WARNING** This 
                    template creates an Amazon EC2 instance. You will be billed for the AWS resources used if you create a stack from this template.",

  "Parameters" : {
    "KeyName": {
      "Description" : "Name of an existing EC2 key pair for SSH access to the EC2 instance.",
      "Type": "AWS::EC2::KeyPair::KeyName"
    },

    "InstanceType" : {
      "Description" : "EC2 instance type.",
      "Type" : "String",
      "Default" : "t2.micro",
      "AllowedValues" : [ "t2.micro", "t2.small", "t2.medium", "m3.medium", "m3.large", 
        "m3.xlarge", "m3.2xlarge" ]
    },

    "SSHLocation" : {
      "Description" : "The IP address range that can SSH to the EC2 instance.",
      "Type": "String",
      "MinLength": "9",
      "MaxLength": "18",
      "Default": "0.0.0.0/0",
      "AllowedPattern": "(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})/(\\d{1,2})",
      "ConstraintDescription": "Must be a valid IP CIDR range of the form x.x.x.x/x."
   }
  },

  "Metadata" : {
    "AWS::CloudFormation::Interface" : {
      "ParameterGroups" : [{
        "Label" : {"default": "Instance configuration"},
        "Parameters" : ["InstanceType"]
      },{
        "Label" : {"default": "Security configuration"},
        "Parameters" : ["KeyName", "SSHLocation"]
      }],
      "ParameterLabels" : {
        "InstanceType": {"default": "Server size:"},
        "KeyName": {"default": "Key pair:"},
        "SSHLocation": {"default": "CIDR range:"}
      }
    }
  },

  "Mappings" : {
    "AWSRegionArch2AMI" : {
      "us-east-1"      : { "HVM64" : "ami-08842d60" },
      "us-west-2"      : { "HVM64" : "ami-8786c6b7" },
      "us-west-1"      : { "HVM64" : "ami-cfa8a18a" },
      "eu-west-1"      : { "HVM64" : "ami-748e2903" },
      "ap-southeast-1" : { "HVM64" : "ami-d6e1c584" },
      "ap-northeast-1" : { "HVM64" : "ami-35072834" },
      "ap-southeast-2" : { "HVM64" : "ami-fd4724c7" },
      "sa-east-1"      : { "HVM64" : "ami-956cc688" },
      "cn-north-1"     : { "HVM64" : "ami-ac57c595" },
      "eu-central-1"   : { "HVM64" : "ami-b43503a9" }
    }

  },

  "Resources" : {
    "EC2Instance" : {
      "Type" : "AWS::EC2::Instance",
      "Properties" : {
        "InstanceType" : { "Ref" : "InstanceType" },
        "SecurityGroups" : [ { "Ref" : "InstanceSecurityGroup" } ],
        "KeyName" : { "Ref" : "KeyName" },
        "ImageId" : { "Fn::FindInMap" : [ "AWSRegionArch2AMI", { "Ref" : "AWS::Region" }, "HVM64" ] }
      }
    },

    "InstanceSecurityGroup" : {
      "Type" : "AWS::EC2::SecurityGroup",
      "Properties" : {
        "GroupDescription" : "Enable SSH access via port 22",
        "SecurityGroupIngress" : [ {
          "IpProtocol" : "tcp",
          "FromPort" : "22",
          "ToPort" : "22",
          "CidrIp" : { "Ref" : "SSHLocation"}
        } ]
      }
    }
  },

  "Outputs" : {
    "PublicDNSName" : {
      "Description" : "Public DNS name of the new EC2 instance",
      "Value" : { "Fn::GetAtt" : [ "EC2Instance", "PublicDnsName" ] }
    },
    "PublicIPAddress" : {
      "Description" : "Public IP address of the new EC2 instance",
      "Value" : { "Fn::GetAtt" : [ "EC2Instance", "PublicIp" ] }
    }
  }
}

テンプレートのリソース

テンプレートでは、製品の起動時に作成されるリソースを宣言します。次のセクションがあります。

• AWSTemplateFormatVersion (オプション) – このテンプレートの作成に使用されたAWS テンプレート形式のバージョン。最新のテンプレートの形式バージョンは 2010-09-09 であり、現時点で唯一の有効な値です。

• 説明 (オプション) – テンプレートの説明。

• パラメータ (オプション) – 製品を起動するためにユーザーが指定する必要があるパラメータ。各パラメータについて、テンプレートには、入力する値が一致する必要がある説明と制約が含まれます。制約の詳細については、「AWS Service Catalog 制約の使用」を参照してください。

  KeyName パラメータを使用すると、エンドユーザーが AWS Service Catalog を使用して製品を起動するときに指定する必要がある Amazon Elastic Compute Cloud (Amazon EC2) キーペア名を指定できます。次のステップでキーペアを作成します。

• メタデータ (オプション) – テンプレートに関する追加情報を提供するオブジェクト。AWS::CloudFormation::Interface キーは、エンドユーザーのコンソールビューにパラメータがどのように表示されるかを定義します。ParameterGroups プロパティは、パラメータのグループ化の方法と、それらのグループの見出しを定義します。ParameterLabels プロパティはフレンドリなパラメータ名を定義します。このテンプレートに基づいた製品を起動するパラメータをユーザーが指定すると、エンドユーザーコンソールビューには、見出し Server size: に Instance configuration というラベルのパラメータが表示され、見出し Key pair: に CIDR range: および Security configuration というラベルのパラメータが表示されます。

• マッピング (オプション) – ルックアップ テーブルと同様に、条件付きパラメーター値の指定に使用できるキーと関連する値のマッピング。「リソース」セクションと「出力」セクションで Fn::FindInMap 組み込み関数を使用すると、キーを対応する値と照合できます。上記のテンプレートには、 AWS リージョンのリストと、各 に対応する Amazon マシンイメージ (AMI) が含まれています。 はこのマッピング AWS Service Catalog を使用して、ユーザーが で選択した AWS リージョンに基づいて使用する AMI を決定します AWS Management Console。

• リソース (必須) — スタックリソースとそのプロパティ。テンプレートの「リソース」セクションと「出力」セクションでリソースを参照できます。上記のテンプレートでは、Amazon Linux を実行する EC2 インスタンスと、そのインスタンスへの SSH アクセスを許可するセキュリティ グループを指定します。EC2 インスタンスリソースの [プロパティ] セクションでは、ユーザーが入力した情報を使用して、SSH アクセス用のインスタンスタイプとキー名を構成します。

  AWS CloudFormation は、現在の AWS リージョンを使用して、前に定義したマッピングから AMI ID を選択し、セキュリティグループを割り当てます。セキュリティグループは、ユーザーが指定する CIDR IP アドレス範囲からポート 22 でインバウンドアクセスを許可するように設定されます。

• 出力 (オプション) – 製品の発売が完了したことをユーザーに通知するテキスト。提供されたテンプレートは、起動されたインスタンスのパブリック DNS 名を取得し、それをユーザーに表示します。ユーザーが SSH を使用してインスタンスに接続するためには、DNS 名が必要です。

  テンプレートの構造の詳細については、AWS CloudFormation ユーザーガイド の「テンプレートリファレンス」を参照してください。