AWSEC2RunInstancesRequest

Objective-C

@interface AWSEC2RunInstancesRequest

Swift

class AWSEC2RunInstancesRequest

  • Reserved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable additionalInfo;

    Swift

    var additionalInfo: String? { get set }

  • The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

    Declaration

    Objective-C

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

    Swift

    var blockDeviceMappings: [AWSEC2BlockDeviceMapping]? { get set }

  • 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).

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2CapacityReservationSpecification *_Nullable capacityReservationSpecification;

    Swift

    var capacityReservationSpecification: AWSEC2CapacityReservationSpecification? { get set }

  • Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

    For more information, see Ensuring Idempotency.

    Constraints: Maximum 64 ASCII characters

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientToken;

    Swift

    var clientToken: String? { get set }

  • The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2CpuOptionsRequest *_Nullable cpuOptions;

    Swift

    var cpuOptions: AWSEC2CpuOptionsRequest? { get set }

  • The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

    Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

    For T3 instances with host tenancy, only standard is supported.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2CreditSpecificationRequest *_Nullable creditSpecification;

    Swift

    var creditSpecification: AWSEC2CreditSpecificationRequest? { get set }

  • Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable disableApiStop;

    Swift

    var disableApiStop: NSNumber? { get set }

  • 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 after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

    Default: false

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable disableApiTermination;

    Swift

    var disableApiTermination: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }

  • 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.

    Default: false

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable ebsOptimized;

    Swift

    var ebsOptimized: NSNumber? { get set }

  • An elastic GPU to associate with the instance.

    Amazon Elastic Graphics reached end of life on January 8, 2024.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ElasticGpuSpecification *> *_Nullable elasticGpuSpecification;

    Swift

    var elasticGpuSpecification: [AWSEC2ElasticGpuSpecification]? { get set }

  • An elastic inference accelerator to associate with the instance.

    Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ElasticInferenceAccelerator *> *_Nullable elasticInferenceAccelerators;

    Swift

    var elasticInferenceAccelerators: [AWSEC2ElasticInferenceAccelerator]? { get set }

  • If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enablePrimaryIpv6;

    Swift

    var enablePrimaryIpv6: NSNumber? { get set }

  • Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

    You can’t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2EnclaveOptionsRequest *_Nullable enclaveOptions;

    Swift

    var enclaveOptions: AWSEC2EnclaveOptionsRequest? { get set }

  • Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

    You can’t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2HibernationOptionsRequest *_Nullable hibernationOptions;

    Swift

    var hibernationOptions: AWSEC2HibernationOptionsRequest? { get set }

  • The name or Amazon Resource Name (ARN) of an IAM instance profile.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2IamInstanceProfileSpecification *_Nullable iamInstanceProfile;

    Swift

    var iamInstanceProfile: AWSEC2IamInstanceProfileSpecification? { get set }

  • The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageId;

    Swift

    var imageId: String? { get set }

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

    Default: stop

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ShutdownBehavior instanceInitiatedShutdownBehavior;

    Swift

    var instanceInitiatedShutdownBehavior: AWSEC2ShutdownBehavior { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceMarketOptionsRequest *_Nullable instanceMarketOptions;

    Swift

    var instanceMarketOptions: AWSEC2InstanceMarketOptionsRequest? { get set }

  • The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceType instanceType;

    Swift

    var instanceType: AWSEC2InstanceType { get set }

  • The 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.

    You cannot specify this option and the network interfaces option in the same request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable ipv6AddressCount;

    Swift

    var ipv6AddressCount: NSNumber? { get set }

  • The 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.

    You cannot specify this option and the network interfaces option in the same request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2InstanceIpv6Address *> *_Nullable ipv6Addresses;

    Swift

    var ipv6Addresses: [AWSEC2InstanceIpv6Address]? { get set }

  • 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 EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kernelId;

    Swift

    var kernelId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyName;

    Swift

    var keyName: String? { get set }

  • The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2LaunchTemplateSpecification *_Nullable launchTemplate;

    Swift

    var launchTemplate: AWSEC2LaunchTemplateSpecification? { get set }

  • The license configurations.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2LicenseConfigurationRequest *> *_Nullable licenseSpecifications;

    Swift

    var licenseSpecifications: [AWSEC2LicenseConfigurationRequest]? { get set }

  • The maintenance and recovery options for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceMaintenanceOptionsRequest *_Nullable maintenanceOptions;

    Swift

    var maintenanceOptions: AWSEC2InstanceMaintenanceOptionsRequest? { get set }

  • The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count.

    Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxCount;

    Swift

    var maxCount: NSNumber? { get set }

  • The metadata options for the instance. For more information, see Instance metadata and user data.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceMetadataOptionsRequest *_Nullable metadataOptions;

    Swift

    var metadataOptions: AWSEC2InstanceMetadataOptionsRequest? { get set }

  • The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.

    Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable minCount;

    Swift

    var minCount: NSNumber? { get set }

  • Specifies whether detailed monitoring is enabled for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled *_Nullable monitoring;

    Swift

    var monitoring: AWSEC2RunInstancesMonitoringEnabled? { get set }

  • The network interfaces to associate with the instance.

    Declaration

    Objective-C

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

    Swift

    var networkInterfaces: [AWSEC2InstanceNetworkInterfaceSpecification]? { get set }

  • The placement for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2Placement *_Nullable placement;

    Swift

    var placement: AWSEC2Placement? { get set }

  • The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2PrivateDnsNameOptionsRequest *_Nullable privateDnsNameOptions;

    Swift

    var privateDnsNameOptions: AWSEC2PrivateDnsNameOptionsRequest? { get set }

  • 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.

    You cannot specify this option and the network interfaces option in the same request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable privateIpAddress;

    Swift

    var privateIpAddress: String? { get set }

  • The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ramdiskId;

    Swift

    var ramdiskId: String? { get set }

  • The IDs of the security groups. You can create a security group using CreateSecurityGroup.

    If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    Declaration

    Objective-C

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

    Swift

    var securityGroupIds: [String]? { get set }

  • [Default VPC] The names of the security groups.

    If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

    Default: Amazon EC2 uses the default security group.

    Declaration

    Objective-C

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

    Swift

    var securityGroups: [String]? { get set }

  • The ID of the subnet to launch the instance into.

    If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable subnetId;

    Swift

    var subnetId: String? { get set }

  • The tags to apply to the resources that are created during instance launch.

    You can specify tags for the following resources only:

    • Instances

    • Volumes

    • Spot Instance requests

    • Network interfaces

    To tag a resource after it has been created, see CreateTags.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;

    Swift

    var tagSpecifications: [AWSEC2TagSpecification]? { get set }

  • The user data script to make available to the instance. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide. 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. User data is limited to 16 KB.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userData;

    Swift

    var userData: String? { get set }