Paws::EC2::RunInstances - Arguments for method RunInstances on Paws::EC2
This class represents the parameters used for calling the method RunInstances on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method RunInstances.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RunInstances.
my $ec2 = Paws->service('EC2'); my $Reservation = $ec2->RunInstances( MaxCount => 1, MinCount => 1, AdditionalInfo => 'MyString', # OPTIONAL BlockDeviceMappings => [ { DeviceName => 'MyString', Ebs => { DeleteOnTermination => 1, # OPTIONAL Encrypted => 1, # OPTIONAL Iops => 1, KmsKeyId => 'MyString', SnapshotId => 'MyString', VolumeSize => 1, VolumeType => 'standard', # values: standard, io1, gp2, sc1, st1; OPTIONAL }, # OPTIONAL NoDevice => 'MyString', VirtualName => 'MyString', }, ... ], # OPTIONAL CapacityReservationSpecification => { CapacityReservationPreference => 'open', # values: open, none; OPTIONAL CapacityReservationTarget => { CapacityReservationId => 'MyString', } , # OPTIONAL }, # OPTIONAL ClientToken => 'MyString', # OPTIONAL CpuOptions => { CoreCount => 1, ThreadsPerCore => 1, }, # OPTIONAL CreditSpecification => { CpuCredits => 'MyString', }, # OPTIONAL DisableApiTermination => 1, # OPTIONAL DryRun => 1, # OPTIONAL EbsOptimized => 1, # OPTIONAL ElasticGpuSpecification => [ { Type => 'MyString', }, ... ], # OPTIONAL ElasticInferenceAccelerators => [ { Type => 'MyString', }, ... ], # OPTIONAL HibernationOptions => { Configured => 1, # OPTIONAL }, # OPTIONAL IamInstanceProfile => { Arn => 'MyString', Name => 'MyString', }, # OPTIONAL ImageId => 'MyString', # OPTIONAL InstanceInitiatedShutdownBehavior => 'stop', # OPTIONAL InstanceMarketOptions => { MarketType => 'spot', # values: spot; OPTIONAL SpotOptions => { BlockDurationMinutes => 1, InstanceInterruptionBehavior => 'hibernate', # values: hibernate, stop, terminate; OPTIONAL MaxPrice => 'MyString', SpotInstanceType => 'one-time', # values: one-time, persistent; OPTIONAL ValidUntil => '1970-01-01T01:00:00', # OPTIONAL }, # OPTIONAL }, # OPTIONAL InstanceType => 't1.micro', # OPTIONAL Ipv6AddressCount => 1, # OPTIONAL Ipv6Addresses => [ { Ipv6Address => 'MyString', }, ... ], # OPTIONAL KernelId => 'MyString', # OPTIONAL KeyName => 'MyString', # OPTIONAL LaunchTemplate => { LaunchTemplateId => 'MyString', LaunchTemplateName => 'MyString', Version => 'MyString', }, # OPTIONAL LicenseSpecifications => [ { LicenseConfigurationArn => 'MyString', }, ... ], # OPTIONAL Monitoring => { Enabled => 1, # OPTIONAL }, # OPTIONAL NetworkInterfaces => [ { AssociatePublicIpAddress => 1, # OPTIONAL DeleteOnTermination => 1, # OPTIONAL Description => 'MyString', DeviceIndex => 1, Groups => [ 'MyString', ... ], # OPTIONAL Ipv6AddressCount => 1, Ipv6Addresses => [ { Ipv6Address => 'MyString', }, ... ], NetworkInterfaceId => 'MyString', PrivateIpAddress => 'MyString', PrivateIpAddresses => [ { Primary => 1, # OPTIONAL PrivateIpAddress => 'MyString', }, ... ], # OPTIONAL SecondaryPrivateIpAddressCount => 1, SubnetId => 'MyString', }, ... ], # OPTIONAL Placement => { Affinity => 'MyString', AvailabilityZone => 'MyString', GroupName => 'MyString', HostId => 'MyString', PartitionNumber => 1, SpreadDomain => 'MyString', Tenancy => 'default', # values: default, dedicated, host; OPTIONAL }, # OPTIONAL PrivateIpAddress => 'MyString', # OPTIONAL RamdiskId => 'MyString', # OPTIONAL SecurityGroupIds => [ 'MyString', ... ], # OPTIONAL SecurityGroups => [ 'MyString', ... ], # OPTIONAL SubnetId => 'MyString', # OPTIONAL TagSpecifications => [ { ResourceType => 'customer-gateway' , # values: customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, image, instance, internet-gateway, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway; OPTIONAL Tags => [ { Key => 'MyString', Value => 'MyString', }, ... ], # OPTIONAL }, ... ], # OPTIONAL UserData => 'MyString', # OPTIONAL ); # Results: my $Groups = $Reservation->Groups; my $Instances = $Reservation->Instances; my $OwnerId = $Reservation->OwnerId; my $RequesterId = $Reservation->RequesterId; my $ReservationId = $Reservation->ReservationId; # Returns a L<Paws::EC2::Reservation> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/RunInstances
Reserved.
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
open
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Constraints: Maximum 64 ASCII characters
The CPU options for the instance. For more information, see Optimizing CPU Options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the Amazon Elastic Compute Cloud User Guide.
The credit option for CPU usage of the instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the Amazon Elastic Compute Cloud User Guide.
standard
unlimited
Default: standard (T2 instances) or unlimited (T3 instances)
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
true
false
InstanceInitiatedShutdownBehavior
terminate
Default: false
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
DryRunOperation
UnauthorizedOperation
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
An elastic GPU to associate with the instance.
An elastic inference accelerator.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the Amazon Elastic Compute Cloud User Guide.
The IAM instance profile.
The ID of the AMI, which you can get by calling DescribeImages. An AMI is required to launch an instance and must be specified here or in a launch template.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
stop
Valid values are: "stop", "terminate"
"stop"
"terminate"
The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
hibernate
The instance type. For more information, see Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
m1.small
Valid values are: "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.12xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.12xlarge", "r5a.24xlarge", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.12xlarge", "r5d.24xlarge", "r5d.metal", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.18xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.18xlarge", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "cg1.4xlarge", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.12xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.12xlarge", "m5a.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.12xlarge", "m5d.24xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge"
"t1.micro"
"t2.nano"
"t2.micro"
"t2.small"
"t2.medium"
"t2.large"
"t2.xlarge"
"t2.2xlarge"
"t3.nano"
"t3.micro"
"t3.small"
"t3.medium"
"t3.large"
"t3.xlarge"
"t3.2xlarge"
"m1.small"
"m1.medium"
"m1.large"
"m1.xlarge"
"m3.medium"
"m3.large"
"m3.xlarge"
"m3.2xlarge"
"m4.large"
"m4.xlarge"
"m4.2xlarge"
"m4.4xlarge"
"m4.10xlarge"
"m4.16xlarge"
"m2.xlarge"
"m2.2xlarge"
"m2.4xlarge"
"cr1.8xlarge"
"r3.large"
"r3.xlarge"
"r3.2xlarge"
"r3.4xlarge"
"r3.8xlarge"
"r4.large"
"r4.xlarge"
"r4.2xlarge"
"r4.4xlarge"
"r4.8xlarge"
"r4.16xlarge"
"r5.large"
"r5.xlarge"
"r5.2xlarge"
"r5.4xlarge"
"r5.12xlarge"
"r5.24xlarge"
"r5.metal"
"r5a.large"
"r5a.xlarge"
"r5a.2xlarge"
"r5a.4xlarge"
"r5a.12xlarge"
"r5a.24xlarge"
"r5d.large"
"r5d.xlarge"
"r5d.2xlarge"
"r5d.4xlarge"
"r5d.12xlarge"
"r5d.24xlarge"
"r5d.metal"
"x1.16xlarge"
"x1.32xlarge"
"x1e.xlarge"
"x1e.2xlarge"
"x1e.4xlarge"
"x1e.8xlarge"
"x1e.16xlarge"
"x1e.32xlarge"
"i2.xlarge"
"i2.2xlarge"
"i2.4xlarge"
"i2.8xlarge"
"i3.large"
"i3.xlarge"
"i3.2xlarge"
"i3.4xlarge"
"i3.8xlarge"
"i3.16xlarge"
"i3.metal"
"hi1.4xlarge"
"hs1.8xlarge"
"c1.medium"
"c1.xlarge"
"c3.large"
"c3.xlarge"
"c3.2xlarge"
"c3.4xlarge"
"c3.8xlarge"
"c4.large"
"c4.xlarge"
"c4.2xlarge"
"c4.4xlarge"
"c4.8xlarge"
"c5.large"
"c5.xlarge"
"c5.2xlarge"
"c5.4xlarge"
"c5.9xlarge"
"c5.18xlarge"
"c5d.large"
"c5d.xlarge"
"c5d.2xlarge"
"c5d.4xlarge"
"c5d.9xlarge"
"c5d.18xlarge"
"c5n.large"
"c5n.xlarge"
"c5n.2xlarge"
"c5n.4xlarge"
"c5n.9xlarge"
"c5n.18xlarge"
"cc1.4xlarge"
"cc2.8xlarge"
"g2.2xlarge"
"g2.8xlarge"
"g3.4xlarge"
"g3.8xlarge"
"g3.16xlarge"
"g3s.xlarge"
"cg1.4xlarge"
"p2.xlarge"
"p2.8xlarge"
"p2.16xlarge"
"p3.2xlarge"
"p3.8xlarge"
"p3.16xlarge"
"p3dn.24xlarge"
"d2.xlarge"
"d2.2xlarge"
"d2.4xlarge"
"d2.8xlarge"
"f1.2xlarge"
"f1.4xlarge"
"f1.16xlarge"
"m5.large"
"m5.xlarge"
"m5.2xlarge"
"m5.4xlarge"
"m5.12xlarge"
"m5.24xlarge"
"m5a.large"
"m5a.xlarge"
"m5a.2xlarge"
"m5a.4xlarge"
"m5a.12xlarge"
"m5a.24xlarge"
"m5d.large"
"m5d.xlarge"
"m5d.2xlarge"
"m5d.4xlarge"
"m5d.12xlarge"
"m5d.24xlarge"
"h1.2xlarge"
"h1.4xlarge"
"h1.8xlarge"
"h1.16xlarge"
"z1d.large"
"z1d.xlarge"
"z1d.2xlarge"
"z1d.3xlarge"
"z1d.6xlarge"
"z1d.12xlarge"
"u-6tb1.metal"
"u-9tb1.metal"
"u-12tb1.metal"
"a1.medium"
"a1.large"
"a1.xlarge"
"a1.2xlarge"
"a1.4xlarge"
[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the Amazon Elastic Compute Cloud User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
The license configurations.
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
MinCount
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in the Amazon EC2 FAQ.
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in the Amazon EC2 General FAQ.
The monitoring for the instance.
One or more network interfaces.
The placement for the instance.
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
The ID of the RAM disk.
One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
[EC2-VPC] The ID of the subnet to launch the instance into.
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) and Adding User Data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data) (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
This class forms part of Paws, documenting arguments for method RunInstances in Paws::EC2
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.