ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / local / jetapps / var / lib / aws / lib / python2.7 / site-packages / awscli / examples / ec2

**To launch an instance in EC2-Classic**

This example launches a single instance of type ``c3.large``.

The key pair and security group, named ``MyKeyPair`` and ``MySecurityGroup``, must exist.

Command::

aws ec2 run-instances --image-id ami-1a2b3c4d --count 1 --instance-type c3.large --key-name MyKeyPair --security-groups MySecurityGroup

Output::

{
      "OwnerId": "123456789012",
      "ReservationId": "r-08626e73c547023b1",
      "Groups": [
          {
              "GroupName": "MySecurityGroup",
              "GroupId": "sg-903004f8"
          }
      ],
      "Instances": [
          {
              "Monitoring": {
                  "State": "disabled"
              },
              "PublicDnsName": null,
              "RootDeviceType": "ebs",
              "State": {
                  "Code": 0,
                  "Name": "pending"
              },
              "EbsOptimized": false,
              "LaunchTime": "2018-05-10T08:03:30.000Z",
              "ProductCodes": [],
              "CpuOptions": {
                "CoreCount": 1, 
                "ThreadsPerCore": 2
              }, 
              "StateTransitionReason": null, 
              "InstanceId": "i-1234567890abcdef0",
              "ImageId": "ami-1a2b3c4d",
              "PrivateDnsName": null,
              "KeyName": "MyKeyPair",
              "SecurityGroups": [
                  {
                      "GroupName": "MySecurityGroup",
                      "GroupId": "sg-903004f8"
                  }
              ],
              "ClientToken": null,
              "InstanceType": "c3.large",
              "NetworkInterfaces": [],
              "Placement": {
                  "Tenancy": "default",
                  "GroupName": null,
                  "AvailabilityZone": "us-east-1b"
              },
              "Hypervisor": "xen",
              "BlockDeviceMappings": [],
              "Architecture": "x86_64",
              "StateReason": {
                  "Message": "pending",
                  "Code": "pending"
              },
              "RootDeviceName": "/dev/sda1",
              "VirtualizationType": "hvm",
              "AmiLaunchIndex": 0
          }
      ]
  }

**To launch an instance in EC2-VPC**

This example launches a single instance of type ``t2.micro`` into the specified subnet.

The key pair named ``MyKeyPair`` and the security group sg-1a2b3c4d must exist.

Command::

aws ec2 run-instances --image-id ami-abc12345 --count 1 --instance-type t2.micro --key-name MyKeyPair --security-group-ids sg-1a2b3c4d --subnet-id subnet-6e7f829e

Output::

{
    "Instances": [
        {
            "Monitoring": {
                "State": "disabled"
            }, 
            "PublicDnsName": "", 
            "StateReason": {
                "Message": "pending", 
                "Code": "pending"
            }, 
            "State": {
                "Code": 0, 
                "Name": "pending"
            }, 
            "EbsOptimized": false, 
            "LaunchTime": "2018-05-10T08:05:20.000Z", 
            "PrivateIpAddress": "10.0.0.157", 
            "ProductCodes": [], 
            "VpcId": "vpc-11223344", 
            "CpuOptions": {
                "CoreCount": 1, 
                "ThreadsPerCore": 1
            }, 
            "StateTransitionReason": "", 
            "InstanceId": "i-1231231230abcdef0", 
            "ImageId": "ami-abc12345", 
            "PrivateDnsName": "ip-10-0-0-157.ec2.internal", 
            "SecurityGroups": [
                {
                    "GroupName": "MySecurityGroup", 
                    "GroupId": "sg-1a2b3c4d"
                }
            ], 
            "ClientToken": "", 
            "SubnetId": "subnet-6e7f829e", 
            "InstanceType": "t2.micro", 
            "NetworkInterfaces": [
                {
                    "Status": "in-use", 
                    "MacAddress": "0a:ab:58:e0:67:e2", 
                    "SourceDestCheck": true, 
                    "VpcId": "vpc-11223344", 
                    "Description": "", 
                    "NetworkInterfaceId": "eni-95c6390b", 
                    "PrivateIpAddresses": [
                        {
                            "PrivateDnsName": "ip-10-0-0-157.ec2.internal", 
                            "Primary": true, 
                            "PrivateIpAddress": "10.0.0.157"
                        }
                    ], 
                    "PrivateDnsName": "ip-10-0-0-157.ec2.internal", 
                    "Attachment": {
                        "Status": "attaching", 
                        "DeviceIndex": 0, 
                        "DeleteOnTermination": true, 
                        "AttachmentId": "eni-attach-bf87ca1f", 
                        "AttachTime": "2018-05-10T08:05:20.000Z"
                    }, 
                    "Groups": [
                        {
                            "GroupName": "MySecurityGroup", 
                            "GroupId": "sg-1a2b3c4d"
                        }
                    ], 
                    "Ipv6Addresses": [], 
                    "OwnerId": "123456789012", 
                    "SubnetId": "subnet-6e7f829e", 
                    "PrivateIpAddress": "10.0.0.157"
                }
            ], 
            "SourceDestCheck": true, 
            "Placement": {
                "Tenancy": "default", 
                "GroupName": "", 
                "AvailabilityZone": "us-east-1a"
            }, 
            "Hypervisor": "xen", 
            "BlockDeviceMappings": [], 
            "Architecture": "x86_64", 
            "RootDeviceType": "ebs", 
            "RootDeviceName": "/dev/xvda", 
            "VirtualizationType": "hvm", 
            "AmiLaunchIndex": 0
        }
    ], 
    "ReservationId": "r-02a3f596d91211712", 
    "Groups": [], 
    "OwnerId": "123456789012"
  }

The following example requests a public IP address for an instance that you're launching into a nondefault subnet:

Command::

aws ec2 run-instances --image-id ami-c3b8d6aa --count 1 --instance-type t2.medium --key-name MyKeyPair --security-group-ids sg-903004f8 --subnet-id subnet-6e7f829e --associate-public-ip-address

**To launch an instance using a block device mapping**

Add the following parameter to your ``run-instances`` command to specify block devices::

--block-device-mappings file://mapping.json

To add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100, specify the following in mapping.json::

[
    {
      "DeviceName": "/dev/sdh",
      "Ebs": {
        "VolumeSize": 100
      }
    }
  ]

To add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``, specify the following in mapping.json::

[
    {
      "DeviceName": "/dev/sdc",
      "VirtualName": "ephemeral1"
    }
  ]

To omit a device specified by the AMI used to launch the instance (for example, ``/dev/sdf``), specify the following in mapping.json::

[
    {
      "DeviceName": "/dev/sdf",
      "NoDevice": ""
    }
  ]

You can view only the Amazon EBS volumes in your block device mapping using the console or the ``describe-instances`` command. To view all volumes, including the instance store volumes, use the following command.

Command::

curl http://169.254.169.254/latest/meta-data/block-device-mapping/

Output::

ami
  ephemeral1

Note that ``ami`` represents the root volume. To get details about the instance store volume ``ephemeral1``, use the following command.

Command::

curl http://169.254.169.254/latest/meta-data/block-device-mapping/ephemeral1

Output::

sdc

**To launch an instance with a modified block device mapping**

You can change individual characteristics of existing AMI block device mappings to suit your needs. Perhaps you want to use an existing AMI, but you want a larger root volume than the usual 8 GiB. Or, you would like to use a General Purpose (SSD) volume for an AMI that currently uses a Magnetic volume.

Use the ``describe-images`` command with the image ID of the AMI you want to use to find its existing block device mapping. You should see a block device mapping in the output::

{
    "DeviceName": "/dev/sda1",
    "Ebs": {
      "DeleteOnTermination": true,
      "SnapshotId": "snap-1234567890abcdef0",
      "VolumeSize": 8,
      "VolumeType": "standard",
      "Encrypted": false
    }
  }

You can modify the above mapping by changing the individual parameters. For example, to launch an instance with a modified block device mapping, add the following parameter to your ``run-instances`` command to change the above mapping's volume size and type::

--block-device-mappings file://mapping.json

Where mapping.json contains the following::

[
    {
      "DeviceName": "/dev/sda1",
      "Ebs": {
        "DeleteOnTermination": true,
        "SnapshotId": "snap-1234567890abcdef0", 
        "VolumeSize": 100,
        "VolumeType": "gp2"
      }
    }
  ]

**To launch an instance with user data**

You can launch an instance and specify user data that performs instance configuration, or that runs a script. The user data needs to be passed as normal string, base64 encoding is handled internally. The following example passes user data in a file called ``my_script.txt`` that contains a configuration script for your instance. The script runs at launch.

Command::

aws ec2 run-instances --image-id ami-abc1234 --count 1 --instance-type m4.large --key-name keypair --user-data file://my_script.txt --subnet-id subnet-abcd1234 --security-group-ids sg-abcd1234

For more information about launching instances, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*.

.. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html

**To launch an instance with an instance profile**

This example shows the use of the ``iam-instance-profile`` option to specify an `IAM instance profile`_ by name.

.. _`IAM instance profile`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

Command::

aws ec2 run-instances --iam-instance-profile Name=MyInstanceProfile --image-id ami-1a2b3c4d --count 1 --instance-type t2.micro --key-name MyKeyPair --security-groups MySecurityGroup

**To launch an instance with tags**

You can launch an instance and specify tags for the instance, volumes, or both. The following example applies a tag with a key of ``webserver`` and value of ``production`` to the instance. The command also applies a tag with a key of ``cost-center`` and a value of ``cc123`` to any EBS volume that's created (in this case, the root volume).

Command::

aws ec2 run-instances --image-id ami-abc12345 --count 1 --instance-type t2.micro --key-name MyKeyPair --subnet-id subnet-6e7f829e --tag-specifications 'ResourceType=instance,Tags=[{Key=webserver,Value=production}]' 'ResourceType=volume,Tags=[{Key=cost-center,Value=cc123}]' 
  
**To launch an instance with the credit option for CPU usage of ``unlimited``**
  
You can launch a burstable performance instance (T2 and T3) and specify the credit option for CPU usage for the instance. If you do not specify the credit option, a T2 instance launches with the default ``standard`` credit option and a T3 instance launches with the default ``unlimited`` credit option. The following example launches a t2.micro instance with the ``unlimited`` credit option.
  
Command::
  
  aws ec2 run-instances --image-id ami-abc12345 --count 1 --instance-type t2.micro --key-name MyKeyPair --credit-specification CpuCredits=unlimited
  
**To launch an instance into a partition placement group**
  
You can launch an instance into a partition placement group without specifying the partition. In this example, the partition placement group is named ``HDFS-Group-A``.
  
Command::
  
  aws ec2 run-instances --placement "GroupName = HDFS-Group-A"
  
**To launch an instance into a specific partition of a partition placement group**
  
You can launch an instance into a specific partition of a partition placement group by specifying the partition number. In this example, the partition placement group is named ``HDFS-Group-A`` and the partition number is ``3``.
  
Command::
  
  aws ec2 run-instances --placement "GroupName = HDFS-Group-A, PartitionNumber = 3"

[+] ..
[-] purchase-host-reservation.rst [edit]
[-] create-fpga-image.rst [edit]
[-] modify-vpc-endpoint-service-configuration.rst [edit]
[-] describe-spot-fleet-instances.rst [edit]
[-] create-network-interface-permission.rst [edit]
[-] update-security-group-rule-descriptions-egress.rst [edit]
[-] describe-stale-security-groups.rst [edit]
[-] describe-volume-status.rst [edit]
[-] describe-elastic-gpus.rst [edit]
[-] cancel-conversion-task.rst [edit]
[-] get-console-output.rst [edit]
[-] release-address.rst [edit]
[-] create-tags.rst [edit]
[-] revoke-security-group-egress.rst [edit]
[-] delete-volume.rst [edit]
[-] describe-egress-only-internet-gateways.rst [edit]
[-] describe-hosts.rst [edit]
[-] modify-instance-event-start-time.rst [edit]
[-] describe-snapshot-attribute.rst [edit]
[-] enable-volume-io.rst [edit]
[-] modify-volume-attribute.rst [edit]
[-] allocate-hosts.rst [edit]
[-] describe-vpc-classic-link-dns-support.rst [edit]
[-] delete-launch-template-versions.rst [edit]
[-] release-hosts.rst [edit]
[-] authorize-security-group-egress.rst [edit]
[-] restore-address-to-classic.rst [edit]
[-] describe-vpc-classic-link.rst [edit]
[-] disable-vpc-classic-link.rst [edit]
[-] delete-network-interface.rst [edit]
[-] describe-principal-id-format.rst [edit]
[-] delete-internet-gateway.rst [edit]
[-] delete-route.rst [edit]
[-] enable-vpc-classic-link-dns-support.rst [edit]
[-] delete-security-group.rst [edit]
[-] describe-classic-link-instances.rst [edit]
[-] associate-route-table.rst [edit]
[-] describe-scheduled-instance-availability.rst [edit]
[-] replace-network-acl-association.rst [edit]
[-] detach-vpn-gateway.rst [edit]
[-] describe-network-interface-attribute.rst [edit]
[-] modify-vpc-endpoint.rst [edit]
[-] describe-host-reservations.rst [edit]
[-] create-snapshot.rst [edit]
[-] run-instances.rst [edit]
[-] create-network-acl.rst [edit]
[-] deregister-image.rst [edit]
[-] report-instance-status.rst [edit]
[-] describe-instance-attribute.rst [edit]
[-] replace-iam-instance-profile.rst [edit]
[-] modify-vpc-endpoint-connection-notification.rst [edit]
[-] get-reserved-instances-exchange-quote.rst [edit]
[-] describe-route-tables.rst [edit]
[-] update-security-group-rule-descriptions-ingress.rst [edit]
[-] describe-availability-zones.rst [edit]
[-] describe-internet-gateways.rst [edit]
[-] create-security-group.rst [edit]
[-] create-spot-datafeed-subscription.rst [edit]
[-] associate-subnet-cidr-block.rst [edit]
[-] describe-security-groups.rst [edit]
[-] describe-aggregate-id-format.rst [edit]
[-] create-network-acl-entry.rst [edit]
[-] describe-prefix-lists.rst [edit]
[-] delete-vpc-peering-connection.rst [edit]
[-] create-default-subnet.rst [edit]
[-] create-vpn-gateway.rst [edit]
[-] detach-network-interface.rst [edit]
[-] describe-network-acls.rst [edit]
[-] create-default-vpc.rst [edit]
[-] describe-snapshots.rst [edit]
[-] create-vpn-connection.rst [edit]
[-] delete-customer-gateway.rst [edit]
[-] create-vpc-endpoint-connection-notification.rst [edit]
[-] attach-classic-link-vpc.rst [edit]
[-] describe-subnets.rst [edit]
[-] create-instance-export-task.rst [edit]
[-] associate-address.rst [edit]
[-] reboot-instances.rst [edit]
[-] delete-snapshot.rst [edit]
[-] describe-vpc-attribute.rst [edit]
[-] monitor-instances.rst [edit]
[-] create-nat-gateway.rst [edit]
[-] create-vpc-endpoint.rst [edit]
[-] get-password-data.rst [edit]
[-] describe-spot-fleet-requests.rst [edit]
[-] describe-instances.rst [edit]
[-] import-key-pair.rst [edit]
[-] create-subnet.rst [edit]
[-] describe-vpn-connections.rst [edit]
[-] create-volume.rst [edit]
[-] describe-conversion-tasks.rst [edit]
[-] modify-launch-template.rst [edit]
[-] delete-vpn-gateway.rst [edit]
[-] describe-volumes.rst [edit]
[-] delete-launch-template.rst [edit]
[-] associate-iam-instance-profile.rst [edit]
[-] delete-spot-datafeed-subscription.rst [edit]
[-] purchase-reserved-instances-offering.rst [edit]
[-] unassign-private-ip-addresses.rst [edit]
[-] describe-bundle-tasks.rst [edit]
[-] describe-key-pairs.rst [edit]
[-] create-internet-gateway.rst [edit]
[-] describe-spot-fleet-request-history.rst [edit]
[-] create-flow-logs.rst [edit]
[-] purchase-scheduled-instances.rst [edit]
[-] modify-instance-placement.rst [edit]
[-] modify-hosts.rst [edit]
[-] delete-vpc-endpoint-connection-notifications.rst [edit]
[-] enable-vpc-classic-link.rst [edit]
[-] describe-dhcp-options.rst [edit]
[-] modify-instance-attribute.rst [edit]
[-] disable-vpc-classic-link-dns-support.rst [edit]
[-] describe-host-reservation-offerings.rst [edit]
[-] get-host-reservation-purchase-preview.rst [edit]
[-] delete-network-acl.rst [edit]
[-] describe-security-group-references.rst [edit]
[-] replace-route.rst [edit]
[-] reject-vpc-peering-connection.rst [edit]
[-] create-customer-gateway.rst [edit]
[-] describe-id-format.rst [edit]
[-] assign-ipv6-addresses.rst [edit]
[-] delete-subnet.rst [edit]
[-] run-scheduled-instances.rst [edit]
[-] reset-fpga-image-attribute.rst [edit]
[-] modify-id-format.rst [edit]
[-] delete-route-table.rst [edit]
[-] describe-images.rst [edit]
[-] stop-instances.rst [edit]
[-] request-spot-instances.rst [edit]
[-] create-vpc-endpoint-service-configuration.rst [edit]
[-] create-launch-template-version.rst [edit]
[-] describe-flow-logs.rst [edit]
[-] enable-vgw-route-propagation.rst [edit]
[-] describe-account-attributes.rst [edit]
[-] describe-export-tasks.rst [edit]
[-] create-egress-only-internet-gateway.rst [edit]
[-] disable-vgw-route-propagation.rst [edit]
[-] cancel-export-task.rst [edit]
[-] create-image.rst [edit]
[-] describe-image-attribute.rst [edit]
[-] attach-volume.rst [edit]
[-] create-placement-group.rst [edit]
[-] create-launch-template.rst [edit]
[-] modify-vpc-attribute.rst [edit]
[-] delete-vpn-connection-route.rst [edit]
[-] disassociate-subnet-cidr-block.rst [edit]
[-] delete-dhcp-options.rst [edit]
[-] describe-customer-gateways.rst [edit]
[-] disassociate-route-table.rst [edit]
[-] modify-vpc-tenancy.rst [edit]
[-] delete-vpc.rst [edit]
[-] describe-scheduled-instances.rst [edit]
[-] disassociate-vpc-cidr-block.rst [edit]
[-] describe-tags.rst [edit]
[-] attach-internet-gateway.rst [edit]
[-] cancel-bundle-task.rst [edit]
[-] describe-addresses.rst [edit]
[-] modify-subnet-attribute.rst [edit]
[-] bundle-instance.rst [edit]
[-] describe-regions.rst [edit]
[-] reset-image-attribute.rst [edit]
[-] revoke-security-group-ingress.rst [edit]
[-] copy-fpga-image.rst [edit]
[-] reset-instance-attribute.rst [edit]
[-] describe-nat-gateways.rst [edit]
[-] modify-fpga-image-attribute.rst [edit]
[-] reset-snapshot-attribute.rst [edit]
[-] delete-placement-group.rst [edit]
[-] delete-egress-only-internet-gateway.rst [edit]
[-] terminate-instances.rst [edit]
[-] describe-launch-template-versions.rst [edit]
[-] describe-volume-attribute.rst [edit]
[-] create-route.rst [edit]
[-] delete-fpga-image.rst [edit]
[-] associate-vpc-cidr-block.rst [edit]
[-] disassociate-iam-instance-profile.rst [edit]
[-] create-dhcp-options.rst [edit]
[-] modify-instance-credit-specification.rst [edit]
[-] cancel-spot-instance-requests.rst [edit]
[-] delete-vpc-endpoint-service-configurations.rst [edit]
[-] describe-iam-instance-profile-associations.rst [edit]
[-] detach-classic-link-vpc.rst [edit]
[-] delete-network-interface-permission.rst [edit]
[-] create-route-table.rst [edit]
[-] attach-network-interface.rst [edit]
[-] create-network-interface.rst [edit]
[-] detach-volume.rst [edit]
[-] delete-key-pair.rst [edit]
[-] describe-reserved-instances-modifications.rst [edit]
[-] describe-instance-status.rst [edit]
[-] modify-spot-fleet-request.rst [edit]
[-] describe-network-interface-permissions.rst [edit]
[-] describe-fpga-image-attribute.rst [edit]
[-] copy-image.rst [edit]
[-] describe-vpc-peering-connections.rst [edit]
[-] describe-instance-credit-specifications.rst [edit]
[-] modify-snapshot-attribute.rst [edit]
[-] create-key-pair.rst [edit]
[-] attach-vpn-gateway.rst [edit]
[-] describe-placement-groups.rst [edit]
[-] create-vpn-connection-route.rst [edit]
[-] delete-nat-gateway.rst [edit]
[-] replace-route-table-association.rst [edit]
[-] describe-spot-datafeed-subscription.rst [edit]
[-] describe-vpn-gateways.rst [edit]
[-] delete-network-acl-entry.rst [edit]
[-] modify-vpc-endpoint-service-permissions.rst [edit]
[-] unmonitor-instances.rst [edit]
[-] describe-vpcs.rst [edit]
[-] reject-vpc-endpoint-connections.rst [edit]
[-] describe-reserved-instances.rst [edit]
[-] cancel-spot-fleet-requests.rst [edit]
[-] modify-reserved-instances.rst [edit]
[-] describe-vpc-endpoint-services.rst [edit]
[-] describe-identity-id-format.rst [edit]
[-] accept-vpc-endpoint-connections.rst [edit]
[-] describe-spot-instance-requests.rst [edit]
[-] move-address-to-vpc.rst [edit]
[-] describe-moving-addresses.rst [edit]
[-] modify-identity-id-format.rst [edit]
[-] describe-spot-price-history.rst [edit]
[-] describe-launch-templates.rst [edit]
[-] modify-network-interface-attribute.rst [edit]
[-] describe-vpc-endpoint-service-configurations.rst [edit]
[-] describe-vpc-endpoint-service-permissions.rst [edit]
[-] describe-reserved-instances-offerings.rst [edit]
[-] request-spot-fleet.rst [edit]
[-] disassociate-address.rst [edit]
[-] describe-vpc-endpoints.rst [edit]
[-] delete-tags.rst [edit]
[-] create-vpc.rst [edit]
[-] replace-network-acl-entry.rst [edit]
[-] associate-dhcp-options.rst [edit]
[-] accept-reserved-instances-exchange-quote.rst [edit]
[-] register-image.rst [edit]
[-] assign-private-ip-addresses.rst [edit]
[-] modify-image-attribute.rst [edit]
[-] start-instances.rst [edit]
[-] copy-snapshot.rst [edit]
[-] detach-internet-gateway.rst [edit]
[-] authorize-security-group-ingress.rst [edit]
[-] unassign-ipv6-addresses.rst [edit]
[-] confirm-product-instance.rst [edit]
[-] delete-vpn-connection.rst [edit]
[-] get-launch-template-data.rst [edit]
[-] describe-vpc-endpoint-connection-notifications.rst [edit]
[-] accept-vpc-peering-connection.rst [edit]
[-] describe-vpc-endpoint-connections.rst [edit]
[-] delete-vpc-endpoints.rst [edit]
[-] describe-network-interfaces.rst [edit]
[-] delete-flow-logs.rst [edit]
[-] modify-vpc-peering-connection-options.rst [edit]
[-] allocate-address.rst [edit]
[-] describe-fpga-images.rst [edit]
[-] create-vpc-peering-connection.rst [edit]