AWSEC2RunInstancesRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSEC2Model.h
AWSEC2Model.m

Overview

Contains the parameters for RunInstances.

Required parameters: [ImageId, MinCount, MaxCount]

  additionalInfo

Reserved.

@property (nonatomic, strong) NSString *additionalInfo

Declared In

AWSEC2Model.h

  blockDeviceMappings

The block device mapping.

@property (nonatomic, strong) NSArray<AWSEC2BlockDeviceMapping*> *blockDeviceMappings

Declared In

AWSEC2Model.h

  clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

@property (nonatomic, strong) NSString *clientToken

Declared In

AWSEC2Model.h

  disableApiTermination

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

@property (nonatomic, strong) NSNumber *disableApiTermination

Declared In

AWSEC2Model.h

  dryRun

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.

@property (nonatomic, strong) NSNumber *dryRun

Declared In

AWSEC2Model.h

  ebsOptimized

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

@property (nonatomic, strong) NSNumber *ebsOptimized

Declared In

AWSEC2Model.h

  iamInstanceProfile

The IAM instance profile.

@property (nonatomic, strong) AWSEC2IamInstanceProfileSpecification *iamInstanceProfile

Declared In

AWSEC2Model.h

  imageId

The ID of the AMI, which you can get by calling DescribeImages.

@property (nonatomic, strong) NSString *imageId

Declared In

AWSEC2Model.h

  instanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

@property (nonatomic, assign) AWSEC2ShutdownBehavior instanceInitiatedShutdownBehavior

Declared In

AWSEC2Model.h

  instanceType

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

@property (nonatomic, assign) AWSEC2InstanceType instanceType

Declared In

AWSEC2Model.h

  kernelId

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

@property (nonatomic, strong) NSString *kernelId

Declared In

AWSEC2Model.h

  keyName

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.

@property (nonatomic, strong) NSString *keyName

Declared In

AWSEC2Model.h

  maxCount

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.

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 in the Amazon EC2 FAQ.

@property (nonatomic, strong) NSNumber *maxCount

Declared In

AWSEC2Model.h

  minCount

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 in the Amazon EC2 General FAQ.

@property (nonatomic, strong) NSNumber *minCount

Declared In

AWSEC2Model.h

  monitoring

The monitoring for the instance.

@property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled *monitoring

Declared In

AWSEC2Model.h

  networkInterfaces

One or more network interfaces.

@property (nonatomic, strong) NSArray<AWSEC2InstanceNetworkInterfaceSpecification*> *networkInterfaces

Declared In

AWSEC2Model.h

  placement

The placement for the instance.

@property (nonatomic, strong) AWSEC2Placement *placement

Declared In

AWSEC2Model.h

  privateIpAddress

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

@property (nonatomic, strong) NSString *privateIpAddress

Declared In

AWSEC2Model.h

  ramdiskId

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

@property (nonatomic, strong) NSString *ramdiskId

Declared In

AWSEC2Model.h

  securityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

@property (nonatomic, strong) NSArray<NSString*> *securityGroupIds

Declared In

AWSEC2Model.h

  securityGroups

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

@property (nonatomic, strong) NSArray<NSString*> *securityGroups

Declared In

AWSEC2Model.h

  subnetId

[EC2-VPC] The ID of the subnet to launch the instance into.

@property (nonatomic, strong) NSString *subnetId

Declared In

AWSEC2Model.h

  userData

Data to configure the instance, or a script to run during instance launch. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). For API calls, the text must be base64-encoded. For command line tools, the encoding is performed for you, and you can load the text from a file.

@property (nonatomic, strong) NSString *userData

Declared In

AWSEC2Model.h