aws:runInstances – Amazon EC2 インスタンスの起動 - AWS Systems Manager

aws:runInstances – Amazon EC2 インスタンスの起動

新しい Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを起動します。

注記

aws:runInstances アクションは、自動スロットリング再試行をサポートしています。詳細については、「スロットリングされたオペレーションの自動再試行の設定」を参照してください。

Input

このアクションでは、ほとんどの API パラメータがサポートされています。詳細については、RunInstances API ドキュメントを参照してください。

YAML
name: launchInstance
action: aws:runInstances
maxAttempts: 3
timeoutSeconds: 1200
onFailure: Abort
inputs:
  ImageId: ami-12345678
  InstanceType: t2.micro
  MinInstanceCount: 1
  MaxInstanceCount: 1
  IamInstanceProfileName: myRunCmdRole
  TagSpecifications:
  - ResourceType: instance
    Tags:
    - Key: LaunchedBy
      Value: SSMAutomation
    - Key: Category
      Value: HighAvailabilityFleetHost
JSON
{
   "name":"launchInstance",
   "action":"aws:runInstances",
   "maxAttempts":3,
   "timeoutSeconds":1200,
   "onFailure":"Abort",
   "inputs":{
      "ImageId":"ami-12345678",
      "InstanceType":"t2.micro",
      "MinInstanceCount":1,
      "MaxInstanceCount":1,
      "IamInstanceProfileName":"myRunCmdRole",
      "TagSpecifications":[
         {
            "ResourceType":"instance",
            "Tags":[
               {
                  "Key":"LaunchedBy",
                  "Value":"SSMAutomation"
               },
               {
                  "Key":"Category",
                  "Value":"HighAvailabilityFleetHost"
               }
            ]
         }
      ]
   }
}
AdditionalInfo

リザーブド。

型: 文字列

必須: いいえ

BlockDeviceMappings

インスタンスのブロックデバイス。

型: MapList

必須: いいえ

ClientToken

リクエストの多重実行を禁止するための識別子。

型: 文字列

必須: いいえ

DisableApiTermination

インスタンス API の終了をオンまたはオフにします。

タイプ: ブール値

必須: いいえ

EbsOptimized

Amazon Elastic Block Store (Amazon EBS) 最適化をオンまたはオフにします。

タイプ: ブール値

必須: いいえ

IamInstanceProfileArn

インスタンスの AWS Identity and Access Management (IAM) インスタンスプロファイルの Amazon リソースネーム (ARN)。

型: 文字列

必須: いいえ

IamInstanceProfileName

インスタンスの IAM インスタンスプロファイルの名前。

型: 文字列

必須: いいえ

ImageId

Amazon Machine Image (AMI) の ID。

型: 文字列

必須: はい

InstanceInitiatedShutdownBehavior

システムのシャットダウン時にインスタンスを停止するか終了するかを示します。

型: 文字列

必須: いいえ

InstanceType

インスタンスタイプ。

注記

インスタンスタイプの値が指定されていない場合は、インスタンスタイプ m1.small を使用します。

型: 文字列

必須: いいえ

KernelId

カーネルの ID。

型: 文字列

必須: いいえ

KeyName

キーペアの名前。

型: 文字列

必須: いいえ

MaxInstanceCount

起動するインスタンスの最大数。

型: 文字列

必須: いいえ

MetadataOptions

インスタンスのメタデータオプション。詳細については、「InstanceMetadataOptionsRequest」を参照してください。

型: StringMap

必須: いいえ

MinInstanceCount

起動するインスタンスの最小数。

型: 文字列

必須: いいえ

Monitoring

詳細モニタリングをオンまたはオフにします。

タイプ: ブール値

必須: いいえ

NetworkInterfaces

ネットワークインターフェイス。

型: MapList

必須: いいえ

Placement

インスタンスのプレイスメント。

型: StringMap

必須: いいえ

PrivateIpAddress

プライマリ IPv4 アドレス。

型: 文字列

必須: いいえ

RamdiskId

RAM ディスクの ID。

型: 文字列

必須: いいえ

SecurityGroupIds

インスタンスのセキュリティグループの ID。

タイプ: StringList

必須: いいえ

SecurityGroups

インスタンスのセキュリティグループの名前。

タイプ: StringList

必須: いいえ

SubnetId

サブネット ID。

型: 文字列

必須: いいえ

TagSpecifications

タグは、起動中のリソースに適用されます。起動時にインスタンスとボリュームにのみタグを付けることができます。指定されたタグは、すべてのインスタンス、または起動時に作成されたボリュームに適用されます。インスタンスを起動した後にタグを付けるには、aws:createTags – AWS リソースのタグを作成する アクションを使用します。

タイプ: MapList (詳細については、「TagSpecification」を参照してください)。

必須: いいえ

UserData

文字列リテラル値として渡されるスクリプト。リテラル値を入力する場合、Base64 エンコードである必要があります。

型: 文字列

必須: いいえ

Output
InstanceIds

インスタンスの ID。

InstanceStates

インスタンスの現在の状態。