AWS::EC2::Instance

EC2 インスタンスを指定します。

インスタンスに Elastic IP アドレスがアタッチされた場合、AWS CloudFormation はそのインスタンスを更新した後、Elastic IP アドレスを再度アタッチします。スタックを更新する方法の詳細については、「AWS CloudFormation スタックの更新」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON


{
  "Type" : "AWS::EC2::Instance",
  "Properties" : {
      "AdditionalInfo" : String,
      "Affinity" : String,
      "AvailabilityZone" : String,
      "BlockDeviceMappings" : [ BlockDeviceMapping, ... ],
      "CpuOptions" : CpuOptions,
      "CreditSpecification" : CreditSpecification,
      "DisableApiTermination" : Boolean,
      "EbsOptimized" : Boolean,
      "ElasticGpuSpecifications" : [ ElasticGpuSpecification, ... ],
      "ElasticInferenceAccelerators" : [ ElasticInferenceAccelerator, ... ],
      "HibernationOptions" : HibernationOptions,
      "HostId" : String,
      "HostResourceGroupArn" : String,
      "IamInstanceProfile" : String,
      "ImageId" : String,
      "InstanceInitiatedShutdownBehavior" : String,
      "InstanceType" : String,
      "Ipv6AddressCount" : Integer,
      "Ipv6Addresses" : [ InstanceIpv6Address, ... ],
      "KernelId" : String,
      "KeyName" : String,
      "LaunchTemplate" : LaunchTemplateSpecification,
      "LicenseSpecifications" : [ LicenseSpecification, ... ],
      "Monitoring" : Boolean,
      "NetworkInterfaces" : [ NetworkInterface, ... ],
      "PlacementGroupName" : String,
      "PrivateIpAddress" : String,
      "RamdiskId" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SecurityGroups" : [ String, ... ],
      "SourceDestCheck" : Boolean,
      "SsmAssociations" : [ SsmAssociation, ... ],
      "SubnetId" : String,
      "Tags" : [ Tag, ... ],
      "Tenancy" : String,
      "UserData" : String,
      "Volumes" : [ Volume, ... ]
    }
}

YAML


Type: AWS::EC2::Instance
Properties: 
  AdditionalInfo: String
  Affinity: String
  AvailabilityZone: String
  BlockDeviceMappings: 
    - BlockDeviceMapping
  CpuOptions: 
    CpuOptions
  CreditSpecification: 
    CreditSpecification
  DisableApiTermination: Boolean
  EbsOptimized: Boolean
  ElasticGpuSpecifications: 
    - ElasticGpuSpecification
  ElasticInferenceAccelerators: 
    - ElasticInferenceAccelerator
  HibernationOptions: 
    HibernationOptions
  HostId: String
  HostResourceGroupArn: String
  IamInstanceProfile: String
  ImageId: String
  InstanceInitiatedShutdownBehavior: String
  InstanceType: String
  Ipv6AddressCount: Integer
  Ipv6Addresses: 
    - InstanceIpv6Address
  KernelId: String
  KeyName: String
  LaunchTemplate: 
    LaunchTemplateSpecification
  LicenseSpecifications: 
    - LicenseSpecification
  Monitoring: Boolean
  NetworkInterfaces: 
    - NetworkInterface
  PlacementGroupName: String
  PrivateIpAddress: String
  RamdiskId: String
  SecurityGroupIds: 
    - String
  SecurityGroups: 
    - String
  SourceDestCheck: Boolean
  SsmAssociations: 
    - SsmAssociation
  SubnetId: String
  Tags: 
    - Tag
  Tenancy: String
  UserData: String
  Volumes: 
    - Volume

プロパティ

AdditionalInfo

このプロパティは内部使用のために予約されています。これを使用すると、スタックは次のエラーで失敗します: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX)。

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

Affinity

インスタンスが専用ホストに関連付けられているかどうかを示します。常に起動時と同じホストでインスタンスを再起動する場合は、host を指定します。インスタンスを任意の使用可能なホストで再起動するが、最後に実行されたホストでの起動を試みる場合は (ベストエフォートベース)、default を指定します。

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

AvailabilityZone

インスタンスのアベイラビリティーゾーン。

指定しない場合、リージョンの負荷分散基準に基づいて、アベイラビリティーゾーンが自動的に選択されます。

このパラメータは、DescribeImageAttribute でサポートされていません。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

BlockDeviceMappings

起動時にインスタンスにアタッチするブロックデバイスを定義するブロックデバイスマッピングのエントリ。

デフォルトでは、AMI のブロックデバイスマッピングで指定されたブロックデバイスが使用されます。AMI ブロックデバイスマッピングを上書きするには、インスタンスブロックデバイスマッピングを使用します。ルートボリュームの場合は、ボリュームサイズ、ボリュームタイプ、ボリューム暗号化設定、DeleteOnTermination 設定のみを上書きできます。インスタンスの実行が開始した後では、アタッチした EBS ボリュームの DeleteOnTermination 設定のみを変更できます。

必須: いいえ

タイプ: BlockDeviceMapping のリスト

Update requires: Some interruptions

CpuOptions

インスタンスの CPU オプション。

必須: いいえ

タイプ: CpuOptions

Update requires: Replacement

CreditSpecification

バースト可能なパフォーマンスインスタンスの CPU 使用率のクレジットオプション。有効な値は、standard および unlimited です。起動後にこの属性を変更するには、ModifyInstanceCreditSpecification を使用します。詳細については、『Amazon Elastic Compute Cloud ユーザーガイド』の「バースト可能パフォーマンスインスタンス」を参照してください。

デフォルト: standard（T2 インスタンス）または unlimited（T3/T3a インスタンス）

必須: いいえ

タイプ: CreditSpecification

Update requires: No interruption

DisableApiTermination

このパラメータを true に設定した場合は、Amazon EC2 コンソール、CLI、または API を使用してインスタンスを終了できません。それ以外の場合は可能です。起動後にこの属性を変更するには、ModifyInstanceAttribute を使用します。また、InstanceInitiatedShutdownBehavior を terminate に設定した場合は、インスタンスから shutdown コマンドを実行してインスタンスを終了できます。

デフォルト: false

必須: いいえ

タイプ: ブール値

Update requires: No interruption

EbsOptimized

インスタンスが Amazon EBS I/O 用に最適化されているかどうかを示します。この最適化により、Amazon EBS への専用のスループット、および最適な Amazon EBS I/O パフォーマンスを得るための最適化された設定スタックが提供されます。この最適化は、すべてのインスタンスタイプで使用できるわけではありません。EBS 最適化インスタンスをする場合は、追加料金が適用されます。

デフォルト: false

必須: いいえ

タイプ: ブール値

Update requires: Some interruptions

ElasticGpuSpecifications

インスタンスに関連付ける Elastic GPU。Elastic GPU はアプリケーションのグラフィックパフォーマンスを加速化するために Windows インスタンスにアタッチできる GPU リソースです。詳細については、Amazon Elastic Compute Cloud ユーザーガイドの「Amazon EC2 Elastic GPU」を参照してください。

必須: いいえ

タイプ: ElasticGpuSpecification のリスト

Update requires: Replacement

ElasticInferenceAccelerators

インスタンスに関連付ける Elastic Inference アクセラレーター。Elastic Inference アクセラレーターは、深層学習 (DL) の推論ワークロードを加速するために Amazon EC2 インスタンスにアタッチできるリソースです。

同じリクエストで異なる世代のアクセラレーターを指定することはできません。

必須: いいえ

タイプ: ElasticInferenceAccelerator のリスト

Update requires: Replacement

HibernationOptions

インスタンスの休止が有効であるかどうかを示します。詳細については、『Amazon Elastic Compute Cloud ユーザーガイド』の「インスタンスの休止」を参照してください。

必須: いいえ

タイプ: HibernationOptions

Update requires: Replacement

HostId

Affinity プロパティにホストを指定した場合は、インスタンスが関連付けられた専用ホストの ID。ID を指定しなかった場合、Amazon EC2 はアカウント内の互換性のある使用可能な任意の専用ホストでインスタンスを起動します。このタイプの起動は、ターゲットを絞らない起動と呼ばれます。ターゲットを絞らない起動の場合、インスタンスを正常に移動するには、互換性のある使用可能な専用ホストが必要です。

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

HostResourceGroupArn

インスタンスを起動するホストリソースグループの ARN。ホストリソースグループ ARN を指定する場合は、Tenancy パラメータを省略するか、または host に設定します。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

IamInstanceProfile

IAM インスタンスプロファイル。プロパティ値については、Amazon EC2 API リファレンスの「IamInstanceProfileSpecification」を参照してください。

必須: いいえ

タイプ: 文字列

Update requires: No interruption

ImageId

AMI の ID。AMI ID はインスタンスを起動するために必要であり、ここでまたは起動テンプレートで指定する必要があります。

必須: 条件付き

タイプ: 文字列

Update requires: Replacement

InstanceInitiatedShutdownBehavior

インスタンスからシャットダウンを開始するときに、インスタンスを停止または終了するかどうかを示します (システムシャットダウンを行うオペレーションシステムコマンドを使用)。

デフォルト: stop

必須: いいえ

タイプ: 文字列

許可された値: stop | terminate

Update requires: No interruption

InstanceType

インスタンスタイプ。詳細については、『Amazon Elastic Compute Cloud ユーザーガイド』の「インスタンスタイプ」を参照してください。

デフォルト: m1.small

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

Ipv6AddressCount

[EC2-VPC] プライマリネットワークインターフェイスに関連付ける IPv6 アドレスの数。Amazon EC2 ではサブネットの範囲から IPv6 アドレスが選択されます。同じリクエストで、このオプションと、特定の IPv6 アドレスを割り当てるオプションを指定することはできません。起動するインスタンスの最小数を指定した場合は、このオプションを指定できます。

同じリクエストでこのオプションとネットワークインターフェイスオプションを指定することはできません。

必須: いいえ

タイプ: 整数

Update requires: Replacement

Ipv6Addresses

[EC2-VPC] プライマリネットワークインターフェイスに関連付けるサブネットの範囲の IPv6 アドレス。同じリクエストで、このオプションと、多数の IPv6 アドレスを割り当てるオプションを指定することはできません。起動するインスタンスの最小数を指定した場合は、このオプションを指定できません。

同じリクエストでこのオプションとネットワークインターフェイスオプションを指定することはできません。

必須: いいえ

タイプ: InstanceIpv6Address のリスト

Update requires: Replacement

KernelId

カーネルの ID。

重要

カーネルと RAM ディスクではなく PV-GRUB を使用することをお勧めします。詳細については、Amazon Elastic Compute Cloud ユーザーガイドの「PV-GRUB」を参照してください。

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

KeyName

キーペアの名前。CreateKeyPair または ImportKeyPair を使用してキーペアを作成できます。

重要

キーペアを指定しない場合は、ユーザーが別の方法でログインすることを許可するように設定された AMI を選択した場合を除き、インスタンスに接続することはできません。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

LaunchTemplate

インスタンスの起動に使用する起動テンプレート。AWS CloudFormation テンプレートで指定したパラメータはすべて、起動テンプレート内の同じパラメータを上書きします。起動テンプレートの名前または ID のいずれかを指定できますが、両方を指定することはできません。

必須: いいえ

タイプ: LaunchTemplateSpecification

Update requires: Replacement

LicenseSpecifications

ライセンス設定。

必須: いいえ

タイプ: LicenseSpecification のリスト

Update requires: Replacement

Monitoring

インスタンスに対して詳細モニタリングを有効にするかどうかを指定します。

必須: いいえ

タイプ: ブール値

Update requires: No interruption

NetworkInterfaces

インスタンスに関連付るネットワークインターフェイス。

注記

ネットワークインターフェイスを示すためにこのプロパティを使用する場合、新しいインターフェイスを貼り付ける前に初期のインターフェイスを終了し、正しく機能するためにそのインスタンスの更新ができるようにしてください。

このリソースにパブリック IP アドレスが割り当てられており、同じテンプレートに定義されている VPC が関連付けられている場合は、DependsOn 属性を使用して VPC ゲートウェイのアタッチメントへの依存関係を宣言する必要があります。

必須: いいえ

タイプ: NetworkInterface のリスト

Update requires: Replacement

PlacementGroupName

起動したインスタンスの配置先となる既存のプレイスメントグループの名前 (クラスターインスタンスの場合)。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

PrivateIpAddress

[EC2-VPC] プライマリ IPv4 アドレス。サブネットの IPv4 アドレス範囲の値を指定する必要があります。

プライマリとして指定できるプライベート IP アドレスは 1 つだけです。ネットワークインターフェイス仕様でプライベート IP アドレスをプライマリ IP アドレスとして指定するオプションを指定した場合、このオプションは指定できません。リクエストで複数のインスタンスを起動している場合は、このオプションを指定できません。

同じリクエストでこのオプションとネットワークインターフェイスオプションを指定することはできません。

置き換えが要求される更新をインスタンスに対して行った場合は、新しいプライベート IP アドレスを割り当てる必要があります。置き換え時は、新しいインスタンスが AWS CloudFormation によって作成されます。ただし、スタックが正常に更新されるまで古いインスタンスは削除されません。スタックの更新に失敗した場合、AWS CloudFormation は、以前正常に動作していたときの状態にスタックをロールバックするために、古いインスタンスを使用します。古いインスタンスと新しいインスタンスに同じプライベート IP アドレスを割り当てることはできません。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

RamdiskId

選択する RAM ディスクの ID。一部のカーネルでは起動時に別途ドライバーが必要となります。RAM ディスクを指定する必要があるかどうかについては、カーネルの要件を確認してください。カーネル要件を確認するには、AWS リソースセンターでカーネル ID を検索します。

重要

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

SecurityGroupIds

セキュリティグループの ID。CreateSecurityGroup を使用してセキュリティグループを作成できます。

ネットワークインターフェイスを指定する場合、ネットワークインターフェイスの一部としてセキュリティグループを指定する必要があります。

必須: 条件付き

タイプ: 文字列のリスト

Update requires: Some interruptions

SecurityGroups

[EC2-Classic、デフォルト VPC] セキュリティグループの名前。デフォルト以外の VPC の場合は、代わりにセキュリティグループ ID を使用する必要があります。

同じリクエストでこのオプションとネットワークインターフェイスオプションを指定することはできません。このリストには、既存の Amazon EC2 セキュリティグループの名前のほか、テンプレートで作成した AWS::EC2::SecurityGroup リソースのリファレンスを含めることもできます。

デフォルト: Amazon EC2 はデフォルトのセキュリティグループを使用します。

必須: いいえ

タイプ: 文字列のリスト

Update requires: Replacement

SourceDestCheck

VPC で起動されたインスタンスが NAT を実行できるようにするかどうかを指定します。これにより、インスタンスの送信元/送信先チェックを有効にするかどうかを制御します。true はチェックが有効であることを示し、false は無効であることを示します。インスタンスが NAT を実行するには、値が false である必要があります。詳細については、Amazon Virtual Private Cloud ユーザーガイドの「NAT インスタンス」を参照してください。

必須: いいえ

タイプ: ブール値

Update requires: No interruption

SsmAssociations

このインスタンスに関連付ける AWS Systems Manager の SSM ドキュメントとパラメータ値。このプロパティを使用するには、インスタンスの IAM インスタンスプロファイルロールを指定する必要があります。詳細については、AWS Systems Manager ユーザーガイドの「Systems Manager のインスタンスプロファイルを作成する」を参照してください。

注記

現在のところ、インスタンスには 1 個のドキュメントのみ関連付けることができます。

必須: いいえ

タイプ: SsmAssociation のリスト

Update requires: No interruption

SubnetId

[EC2-VPC] インスタンスを起動するサブネットの ID。

ネットワークインターフェイスを指定する場合、ネットワークインターフェイスの一部としてサブネットを指定する必要があります。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

Tags

インスタンスに追加するタグ。これらのタグは、ルートボリュームなどの EBS ボリュームには適用されません。AWS CloudFormation は、インスタンスの起動後にこれらのタグを追加します。

必須: いいえ

タイプ: Tag のリスト

Update requires: No interruption

Tenancy

インスタンスのテナンシー (インスタンスが VPC で実行されている場合)。テナンシーが dedicated であるインスタンスは、シングルテナントのハードウェアで実行されます。

必須: いいえ

タイプ: 文字列

許可された値: dedicated | default | host

Update requires: Some interruptions

UserData

インスタンスで利用可能なユーザーデータ。詳細については、「Linux インスタンスでの起動時のコマンドの実行」 (Linux)、および「ユーザーデータの追加」 (Windows) を参照してください。コマンドラインツールを使用している場合は、base64 エンコードが自動的に実行され、ファイルからテキストを読み込むことができます。それ以外の場合は、base64 でエンコードされたテキストを指定する必要があります。ユーザーデータのサイズの上限は 16 KB です。

必須: いいえ

タイプ: 文字列

Update requires: Some interruptions

Volumes

インスタンスにアタッチするボリューム。

必須: いいえ

タイプ: Volume のリスト

Update requires: No interruption

戻り値

Ref

インスタンス ID をこのリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: 。例: i-1234567890abcdef0。

For more information about using the Ref function, see Ref.

Fn::GetAtt

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

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

AvailabilityZone

指定したインスタンスを起動するアベイラビリティーゾーン。例: us-east-1b。

特定のリージョンに該当するすべてのアベイラビリティーゾーンのリストを取得するには、Fn::GetAZs 組み込み関数を使用します。

PrivateDnsName

指定するインスタンスのプライベート DNS 名。例: ip-10-24-34-0.ec2.internal。

PrivateIp

指定するインスタンスのプライベート IP アドレス。例: 10.24.34.0。

PublicDnsName

指定するインスタンスのパブリック DNS 名。例: ec2-107-20-50-45.compute-1.amazonaws.com。

PublicIp

指定するインスタンスのパブリック IP アドレス。例: 192.0.2.0。

例

EBS ブロックデバイスマッピングを持つ EC2 インスタンス

JSON


"MyEC2Instance" : {
   "Type" : "AWS::EC2::Instance",
   "Properties" : {
      "ImageId" : "ami-79fd7eee",
      "KeyName" : "testkey",
      "BlockDeviceMappings" : [
         {
            "DeviceName" : "/dev/sdm",
            "Ebs" : {
              "VolumeType" : "io1",
              "Iops" : "200",
              "DeleteOnTermination" : "false",
              "VolumeSize" : "20"
            }
          }, 
          {
            "DeviceName" : "/dev/sdk",
            "NoDevice" : {}
          }
      ]
   }
}

YAML


  MyEC2Instance: 
    Type: AWS::EC2::Instance
    Properties: 
      ImageId: "ami-79fd7eee"
      KeyName: "testkey"
      BlockDeviceMappings: 
      - DeviceName: "/dev/sdm"
        Ebs: 
          VolumeType: "io1"
          Iops: "200"
          DeleteOnTermination: "false"
          VolumeSize: "20"
      - DeviceName: "/dev/sdk"
        NoDevice: {}

パブリック IP アドレスの自動割り当て

パブリック IP アドレスをネットワークインターフェイスと関連付けることができるのは、デバイスインデックスが 0 のものであり、新しい (既存のものではない) ネットワークインターフェイスの場合のみです。

JSON


"Ec2Instance" : {
  "Type" : "AWS::EC2::Instance",
  "Properties" : {
    "ImageId" : { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "AMI" ]},
    "KeyName" : { "Ref" : "KeyName" },
    "NetworkInterfaces": [ {
      "AssociatePublicIpAddress": "true",
      "DeviceIndex": "0",
      "GroupSet": [{ "Ref" : "myVPCEC2SecurityGroup" }],
      "SubnetId": { "Ref" : "PublicSubnet" }
    } ]
  }
}

YAML


Ec2Instance: 
  Type: AWS::EC2::Instance
  Properties: 
    ImageId: 
      Fn::FindInMap: 
        - "RegionMap"
        - Ref: "AWS::Region"
        - "AMI"
    KeyName: 
      Ref: "KeyName"
    NetworkInterfaces: 
      - AssociatePublicIpAddress: "true"
        DeviceIndex: "0"
        GroupSet: 
          - Ref: "myVPCEC2SecurityGroup"
        SubnetId: 
          Ref: "PublicSubnet"

以下の資料も参照してください。

Amazon EC2 API リファレンスの「RunInstances」
Amazon EC2 API リファレンスの「EBS 最適化インスタンス」

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS::EC2::Host

AssociationParameter