AWS SDK for C++  1.7.349
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::RunInstancesRequest Class Reference

#include <RunInstancesRequest.h>

+ Inheritance diagram for Aws::EC2::Model::RunInstancesRequest:

Public Member Functions

 RunInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< BlockDeviceMapping > & GetBlockDeviceMappings () const
 
bool BlockDeviceMappingsHasBeenSet () const
 
void SetBlockDeviceMappings (const Aws::Vector< BlockDeviceMapping > &value)
 
void SetBlockDeviceMappings (Aws::Vector< BlockDeviceMapping > &&value)
 
RunInstancesRequestWithBlockDeviceMappings (const Aws::Vector< BlockDeviceMapping > &value)
 
RunInstancesRequestWithBlockDeviceMappings (Aws::Vector< BlockDeviceMapping > &&value)
 
RunInstancesRequestAddBlockDeviceMappings (const BlockDeviceMapping &value)
 
RunInstancesRequestAddBlockDeviceMappings (BlockDeviceMapping &&value)
 
const Aws::StringGetImageId () const
 
bool ImageIdHasBeenSet () const
 
void SetImageId (const Aws::String &value)
 
void SetImageId (Aws::String &&value)
 
void SetImageId (const char *value)
 
RunInstancesRequestWithImageId (const Aws::String &value)
 
RunInstancesRequestWithImageId (Aws::String &&value)
 
RunInstancesRequestWithImageId (const char *value)
 
const InstanceTypeGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const InstanceType &value)
 
void SetInstanceType (InstanceType &&value)
 
RunInstancesRequestWithInstanceType (const InstanceType &value)
 
RunInstancesRequestWithInstanceType (InstanceType &&value)
 
int GetIpv6AddressCount () const
 
bool Ipv6AddressCountHasBeenSet () const
 
void SetIpv6AddressCount (int value)
 
RunInstancesRequestWithIpv6AddressCount (int value)
 
const Aws::Vector< InstanceIpv6Address > & GetIpv6Addresses () const
 
bool Ipv6AddressesHasBeenSet () const
 
void SetIpv6Addresses (const Aws::Vector< InstanceIpv6Address > &value)
 
void SetIpv6Addresses (Aws::Vector< InstanceIpv6Address > &&value)
 
RunInstancesRequestWithIpv6Addresses (const Aws::Vector< InstanceIpv6Address > &value)
 
RunInstancesRequestWithIpv6Addresses (Aws::Vector< InstanceIpv6Address > &&value)
 
RunInstancesRequestAddIpv6Addresses (const InstanceIpv6Address &value)
 
RunInstancesRequestAddIpv6Addresses (InstanceIpv6Address &&value)
 
const Aws::StringGetKernelId () const
 
bool KernelIdHasBeenSet () const
 
void SetKernelId (const Aws::String &value)
 
void SetKernelId (Aws::String &&value)
 
void SetKernelId (const char *value)
 
RunInstancesRequestWithKernelId (const Aws::String &value)
 
RunInstancesRequestWithKernelId (Aws::String &&value)
 
RunInstancesRequestWithKernelId (const char *value)
 
const Aws::StringGetKeyName () const
 
bool KeyNameHasBeenSet () const
 
void SetKeyName (const Aws::String &value)
 
void SetKeyName (Aws::String &&value)
 
void SetKeyName (const char *value)
 
RunInstancesRequestWithKeyName (const Aws::String &value)
 
RunInstancesRequestWithKeyName (Aws::String &&value)
 
RunInstancesRequestWithKeyName (const char *value)
 
int GetMaxCount () const
 
bool MaxCountHasBeenSet () const
 
void SetMaxCount (int value)
 
RunInstancesRequestWithMaxCount (int value)
 
int GetMinCount () const
 
bool MinCountHasBeenSet () const
 
void SetMinCount (int value)
 
RunInstancesRequestWithMinCount (int value)
 
const RunInstancesMonitoringEnabledGetMonitoring () const
 
bool MonitoringHasBeenSet () const
 
void SetMonitoring (const RunInstancesMonitoringEnabled &value)
 
void SetMonitoring (RunInstancesMonitoringEnabled &&value)
 
RunInstancesRequestWithMonitoring (const RunInstancesMonitoringEnabled &value)
 
RunInstancesRequestWithMonitoring (RunInstancesMonitoringEnabled &&value)
 
const PlacementGetPlacement () const
 
bool PlacementHasBeenSet () const
 
void SetPlacement (const Placement &value)
 
void SetPlacement (Placement &&value)
 
RunInstancesRequestWithPlacement (const Placement &value)
 
RunInstancesRequestWithPlacement (Placement &&value)
 
const Aws::StringGetRamdiskId () const
 
bool RamdiskIdHasBeenSet () const
 
void SetRamdiskId (const Aws::String &value)
 
void SetRamdiskId (Aws::String &&value)
 
void SetRamdiskId (const char *value)
 
RunInstancesRequestWithRamdiskId (const Aws::String &value)
 
RunInstancesRequestWithRamdiskId (Aws::String &&value)
 
RunInstancesRequestWithRamdiskId (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RunInstancesRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RunInstancesRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RunInstancesRequestAddSecurityGroupIds (const Aws::String &value)
 
RunInstancesRequestAddSecurityGroupIds (Aws::String &&value)
 
RunInstancesRequestAddSecurityGroupIds (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroups () const
 
bool SecurityGroupsHasBeenSet () const
 
void SetSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroups (Aws::Vector< Aws::String > &&value)
 
RunInstancesRequestWithSecurityGroups (const Aws::Vector< Aws::String > &value)
 
RunInstancesRequestWithSecurityGroups (Aws::Vector< Aws::String > &&value)
 
RunInstancesRequestAddSecurityGroups (const Aws::String &value)
 
RunInstancesRequestAddSecurityGroups (Aws::String &&value)
 
RunInstancesRequestAddSecurityGroups (const char *value)
 
const Aws::StringGetSubnetId () const
 
bool SubnetIdHasBeenSet () const
 
void SetSubnetId (const Aws::String &value)
 
void SetSubnetId (Aws::String &&value)
 
void SetSubnetId (const char *value)
 
RunInstancesRequestWithSubnetId (const Aws::String &value)
 
RunInstancesRequestWithSubnetId (Aws::String &&value)
 
RunInstancesRequestWithSubnetId (const char *value)
 
const Aws::StringGetUserData () const
 
bool UserDataHasBeenSet () const
 
void SetUserData (const Aws::String &value)
 
void SetUserData (Aws::String &&value)
 
void SetUserData (const char *value)
 
RunInstancesRequestWithUserData (const Aws::String &value)
 
RunInstancesRequestWithUserData (Aws::String &&value)
 
RunInstancesRequestWithUserData (const char *value)
 
const Aws::StringGetAdditionalInfo () const
 
bool AdditionalInfoHasBeenSet () const
 
void SetAdditionalInfo (const Aws::String &value)
 
void SetAdditionalInfo (Aws::String &&value)
 
void SetAdditionalInfo (const char *value)
 
RunInstancesRequestWithAdditionalInfo (const Aws::String &value)
 
RunInstancesRequestWithAdditionalInfo (Aws::String &&value)
 
RunInstancesRequestWithAdditionalInfo (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
RunInstancesRequestWithClientToken (const Aws::String &value)
 
RunInstancesRequestWithClientToken (Aws::String &&value)
 
RunInstancesRequestWithClientToken (const char *value)
 
bool GetDisableApiTermination () const
 
bool DisableApiTerminationHasBeenSet () const
 
void SetDisableApiTermination (bool value)
 
RunInstancesRequestWithDisableApiTermination (bool value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
RunInstancesRequestWithDryRun (bool value)
 
bool GetEbsOptimized () const
 
bool EbsOptimizedHasBeenSet () const
 
void SetEbsOptimized (bool value)
 
RunInstancesRequestWithEbsOptimized (bool value)
 
const IamInstanceProfileSpecificationGetIamInstanceProfile () const
 
bool IamInstanceProfileHasBeenSet () const
 
void SetIamInstanceProfile (const IamInstanceProfileSpecification &value)
 
void SetIamInstanceProfile (IamInstanceProfileSpecification &&value)
 
RunInstancesRequestWithIamInstanceProfile (const IamInstanceProfileSpecification &value)
 
RunInstancesRequestWithIamInstanceProfile (IamInstanceProfileSpecification &&value)
 
const ShutdownBehaviorGetInstanceInitiatedShutdownBehavior () const
 
bool InstanceInitiatedShutdownBehaviorHasBeenSet () const
 
void SetInstanceInitiatedShutdownBehavior (const ShutdownBehavior &value)
 
void SetInstanceInitiatedShutdownBehavior (ShutdownBehavior &&value)
 
RunInstancesRequestWithInstanceInitiatedShutdownBehavior (const ShutdownBehavior &value)
 
RunInstancesRequestWithInstanceInitiatedShutdownBehavior (ShutdownBehavior &&value)
 
const Aws::Vector< InstanceNetworkInterfaceSpecification > & GetNetworkInterfaces () const
 
bool NetworkInterfacesHasBeenSet () const
 
void SetNetworkInterfaces (const Aws::Vector< InstanceNetworkInterfaceSpecification > &value)
 
void SetNetworkInterfaces (Aws::Vector< InstanceNetworkInterfaceSpecification > &&value)
 
RunInstancesRequestWithNetworkInterfaces (const Aws::Vector< InstanceNetworkInterfaceSpecification > &value)
 
RunInstancesRequestWithNetworkInterfaces (Aws::Vector< InstanceNetworkInterfaceSpecification > &&value)
 
RunInstancesRequestAddNetworkInterfaces (const InstanceNetworkInterfaceSpecification &value)
 
RunInstancesRequestAddNetworkInterfaces (InstanceNetworkInterfaceSpecification &&value)
 
const Aws::StringGetPrivateIpAddress () const
 
bool PrivateIpAddressHasBeenSet () const
 
void SetPrivateIpAddress (const Aws::String &value)
 
void SetPrivateIpAddress (Aws::String &&value)
 
void SetPrivateIpAddress (const char *value)
 
RunInstancesRequestWithPrivateIpAddress (const Aws::String &value)
 
RunInstancesRequestWithPrivateIpAddress (Aws::String &&value)
 
RunInstancesRequestWithPrivateIpAddress (const char *value)
 
const Aws::Vector< ElasticGpuSpecification > & GetElasticGpuSpecification () const
 
bool ElasticGpuSpecificationHasBeenSet () const
 
void SetElasticGpuSpecification (const Aws::Vector< ElasticGpuSpecification > &value)
 
void SetElasticGpuSpecification (Aws::Vector< ElasticGpuSpecification > &&value)
 
RunInstancesRequestWithElasticGpuSpecification (const Aws::Vector< ElasticGpuSpecification > &value)
 
RunInstancesRequestWithElasticGpuSpecification (Aws::Vector< ElasticGpuSpecification > &&value)
 
RunInstancesRequestAddElasticGpuSpecification (const ElasticGpuSpecification &value)
 
RunInstancesRequestAddElasticGpuSpecification (ElasticGpuSpecification &&value)
 
const Aws::Vector< ElasticInferenceAccelerator > & GetElasticInferenceAccelerators () const
 
bool ElasticInferenceAcceleratorsHasBeenSet () const
 
void SetElasticInferenceAccelerators (const Aws::Vector< ElasticInferenceAccelerator > &value)
 
void SetElasticInferenceAccelerators (Aws::Vector< ElasticInferenceAccelerator > &&value)
 
RunInstancesRequestWithElasticInferenceAccelerators (const Aws::Vector< ElasticInferenceAccelerator > &value)
 
RunInstancesRequestWithElasticInferenceAccelerators (Aws::Vector< ElasticInferenceAccelerator > &&value)
 
RunInstancesRequestAddElasticInferenceAccelerators (const ElasticInferenceAccelerator &value)
 
RunInstancesRequestAddElasticInferenceAccelerators (ElasticInferenceAccelerator &&value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
RunInstancesRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
RunInstancesRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
RunInstancesRequestAddTagSpecifications (const TagSpecification &value)
 
RunInstancesRequestAddTagSpecifications (TagSpecification &&value)
 
const LaunchTemplateSpecificationGetLaunchTemplate () const
 
bool LaunchTemplateHasBeenSet () const
 
void SetLaunchTemplate (const LaunchTemplateSpecification &value)
 
void SetLaunchTemplate (LaunchTemplateSpecification &&value)
 
RunInstancesRequestWithLaunchTemplate (const LaunchTemplateSpecification &value)
 
RunInstancesRequestWithLaunchTemplate (LaunchTemplateSpecification &&value)
 
const InstanceMarketOptionsRequestGetInstanceMarketOptions () const
 
bool InstanceMarketOptionsHasBeenSet () const
 
void SetInstanceMarketOptions (const InstanceMarketOptionsRequest &value)
 
void SetInstanceMarketOptions (InstanceMarketOptionsRequest &&value)
 
RunInstancesRequestWithInstanceMarketOptions (const InstanceMarketOptionsRequest &value)
 
RunInstancesRequestWithInstanceMarketOptions (InstanceMarketOptionsRequest &&value)
 
const CreditSpecificationRequestGetCreditSpecification () const
 
bool CreditSpecificationHasBeenSet () const
 
void SetCreditSpecification (const CreditSpecificationRequest &value)
 
void SetCreditSpecification (CreditSpecificationRequest &&value)
 
RunInstancesRequestWithCreditSpecification (const CreditSpecificationRequest &value)
 
RunInstancesRequestWithCreditSpecification (CreditSpecificationRequest &&value)
 
const CpuOptionsRequestGetCpuOptions () const
 
bool CpuOptionsHasBeenSet () const
 
void SetCpuOptions (const CpuOptionsRequest &value)
 
void SetCpuOptions (CpuOptionsRequest &&value)
 
RunInstancesRequestWithCpuOptions (const CpuOptionsRequest &value)
 
RunInstancesRequestWithCpuOptions (CpuOptionsRequest &&value)
 
const CapacityReservationSpecificationGetCapacityReservationSpecification () const
 
bool CapacityReservationSpecificationHasBeenSet () const
 
void SetCapacityReservationSpecification (const CapacityReservationSpecification &value)
 
void SetCapacityReservationSpecification (CapacityReservationSpecification &&value)
 
RunInstancesRequestWithCapacityReservationSpecification (const CapacityReservationSpecification &value)
 
RunInstancesRequestWithCapacityReservationSpecification (CapacityReservationSpecification &&value)
 
const HibernationOptionsRequestGetHibernationOptions () const
 
bool HibernationOptionsHasBeenSet () const
 
void SetHibernationOptions (const HibernationOptionsRequest &value)
 
void SetHibernationOptions (HibernationOptionsRequest &&value)
 
RunInstancesRequestWithHibernationOptions (const HibernationOptionsRequest &value)
 
RunInstancesRequestWithHibernationOptions (HibernationOptionsRequest &&value)
 
const Aws::Vector< LicenseConfigurationRequest > & GetLicenseSpecifications () const
 
bool LicenseSpecificationsHasBeenSet () const
 
void SetLicenseSpecifications (const Aws::Vector< LicenseConfigurationRequest > &value)
 
void SetLicenseSpecifications (Aws::Vector< LicenseConfigurationRequest > &&value)
 
RunInstancesRequestWithLicenseSpecifications (const Aws::Vector< LicenseConfigurationRequest > &value)
 
RunInstancesRequestWithLicenseSpecifications (Aws::Vector< LicenseConfigurationRequest > &&value)
 
RunInstancesRequestAddLicenseSpecifications (const LicenseConfigurationRequest &value)
 
RunInstancesRequestAddLicenseSpecifications (LicenseConfigurationRequest &&value)
 
const InstanceMetadataOptionsRequestGetMetadataOptions () const
 
bool MetadataOptionsHasBeenSet () const
 
void SetMetadataOptions (const InstanceMetadataOptionsRequest &value)
 
void SetMetadataOptions (InstanceMetadataOptionsRequest &&value)
 
RunInstancesRequestWithMetadataOptions (const InstanceMetadataOptionsRequest &value)
 
RunInstancesRequestWithMetadataOptions (InstanceMetadataOptionsRequest &&value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 52 of file RunInstancesRequest.h.

Constructor & Destructor Documentation

◆ RunInstancesRequest()

Aws::EC2::Model::RunInstancesRequest::RunInstancesRequest ( )

Member Function Documentation

◆ AddBlockDeviceMappings() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddBlockDeviceMappings ( const BlockDeviceMapping value)
inline

The block device mapping entries.

Definition at line 103 of file RunInstancesRequest.h.

◆ AddBlockDeviceMappings() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddBlockDeviceMappings ( BlockDeviceMapping &&  value)
inline

The block device mapping entries.

Definition at line 108 of file RunInstancesRequest.h.

◆ AddElasticGpuSpecification() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddElasticGpuSpecification ( const ElasticGpuSpecification value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1559 of file RunInstancesRequest.h.

◆ AddElasticGpuSpecification() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddElasticGpuSpecification ( ElasticGpuSpecification &&  value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1569 of file RunInstancesRequest.h.

◆ AddElasticInferenceAccelerators() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddElasticInferenceAccelerators ( const ElasticInferenceAccelerator value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1626 of file RunInstancesRequest.h.

◆ AddElasticInferenceAccelerators() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddElasticInferenceAccelerators ( ElasticInferenceAccelerator &&  value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1634 of file RunInstancesRequest.h.

◆ AddIpv6Addresses() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddIpv6Addresses ( const InstanceIpv6Address value)
inline

[EC2-VPC] 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.

Definition at line 318 of file RunInstancesRequest.h.

◆ AddIpv6Addresses() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddIpv6Addresses ( InstanceIpv6Address &&  value)
inline

[EC2-VPC] 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.

Definition at line 328 of file RunInstancesRequest.h.

◆ AdditionalInfoHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::AdditionalInfoHasBeenSet ( ) const
inline

Reserved.

Definition at line 1046 of file RunInstancesRequest.h.

◆ AddLicenseSpecifications() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddLicenseSpecifications ( const LicenseConfigurationRequest value)
inline

The license configurations.

Definition at line 2061 of file RunInstancesRequest.h.

◆ AddLicenseSpecifications() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddLicenseSpecifications ( LicenseConfigurationRequest &&  value)
inline

The license configurations.

Definition at line 2066 of file RunInstancesRequest.h.

◆ AddNetworkInterfaces() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddNetworkInterfaces ( const InstanceNetworkInterfaceSpecification value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1392 of file RunInstancesRequest.h.

◆ AddNetworkInterfaces() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddNetworkInterfaces ( InstanceNetworkInterfaceSpecification &&  value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1399 of file RunInstancesRequest.h.

◆ AddSecurityGroupIds() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroupIds ( const Aws::String value)
inline

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.

Definition at line 800 of file RunInstancesRequest.h.

◆ AddSecurityGroupIds() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroupIds ( Aws::String &&  value)
inline

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.

Definition at line 808 of file RunInstancesRequest.h.

◆ AddSecurityGroupIds() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroupIds ( const char *  value)
inline

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.

Definition at line 816 of file RunInstancesRequest.h.

◆ AddSecurityGroups() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroups ( const Aws::String value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 873 of file RunInstancesRequest.h.

◆ AddSecurityGroups() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroups ( Aws::String &&  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 881 of file RunInstancesRequest.h.

◆ AddSecurityGroups() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddSecurityGroups ( const char *  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 889 of file RunInstancesRequest.h.

◆ AddTagSpecifications() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddTagSpecifications ( const TagSpecification value)
inline

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.

Definition at line 1698 of file RunInstancesRequest.h.

◆ AddTagSpecifications() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::AddTagSpecifications ( TagSpecification &&  value)
inline

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.

Definition at line 1707 of file RunInstancesRequest.h.

◆ BlockDeviceMappingsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::BlockDeviceMappingsHasBeenSet ( ) const
inline

The block device mapping entries.

Definition at line 78 of file RunInstancesRequest.h.

◆ CapacityReservationSpecificationHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::CapacityReservationSpecificationHasBeenSet ( ) const
inline

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

Definition at line 1944 of file RunInstancesRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::ClientTokenHasBeenSet ( ) const
inline

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

Definition at line 1095 of file RunInstancesRequest.h.

◆ CpuOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::CpuOptionsHasBeenSet ( ) const
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1899 of file RunInstancesRequest.h.

◆ CreditSpecificationHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::CreditSpecificationHasBeenSet ( ) const
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1832 of file RunInstancesRequest.h.

◆ DisableApiTerminationHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::DisableApiTerminationHasBeenSet ( ) const
inline

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

Definition at line 1172 of file RunInstancesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 1211 of file RunInstancesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::RunInstancesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EbsOptimizedHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::EbsOptimizedHasBeenSet ( ) const
inline

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

Definition at line 1248 of file RunInstancesRequest.h.

◆ ElasticGpuSpecificationHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::ElasticGpuSpecificationHasBeenSet ( ) const
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1509 of file RunInstancesRequest.h.

◆ ElasticInferenceAcceleratorsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::ElasticInferenceAcceleratorsHasBeenSet ( ) const
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1586 of file RunInstancesRequest.h.

◆ GetAdditionalInfo()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetAdditionalInfo ( ) const
inline

Reserved.

Definition at line 1041 of file RunInstancesRequest.h.

◆ GetBlockDeviceMappings()

const Aws::Vector<BlockDeviceMapping>& Aws::EC2::Model::RunInstancesRequest::GetBlockDeviceMappings ( ) const
inline

The block device mapping entries.

Definition at line 73 of file RunInstancesRequest.h.

◆ GetCapacityReservationSpecification()

const CapacityReservationSpecification& Aws::EC2::Model::RunInstancesRequest::GetCapacityReservationSpecification ( ) const
inline

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

Definition at line 1936 of file RunInstancesRequest.h.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetClientToken ( ) const
inline

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

Definition at line 1086 of file RunInstancesRequest.h.

◆ GetCpuOptions()

const CpuOptionsRequest& Aws::EC2::Model::RunInstancesRequest::GetCpuOptions ( ) const
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1892 of file RunInstancesRequest.h.

◆ GetCreditSpecification()

const CreditSpecificationRequest& Aws::EC2::Model::RunInstancesRequest::GetCreditSpecification ( ) const
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1819 of file RunInstancesRequest.h.

◆ GetDisableApiTermination()

bool Aws::EC2::Model::RunInstancesRequest::GetDisableApiTermination ( ) const
inline

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

Definition at line 1161 of file RunInstancesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::RunInstancesRequest::GetDryRun ( ) const
inline

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.

Definition at line 1203 of file RunInstancesRequest.h.

◆ GetEbsOptimized()

bool Aws::EC2::Model::RunInstancesRequest::GetEbsOptimized ( ) const
inline

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

Definition at line 1238 of file RunInstancesRequest.h.

◆ GetElasticGpuSpecification()

const Aws::Vector<ElasticGpuSpecification>& Aws::EC2::Model::RunInstancesRequest::GetElasticGpuSpecification ( ) const
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1499 of file RunInstancesRequest.h.

◆ GetElasticInferenceAccelerators()

const Aws::Vector<ElasticInferenceAccelerator>& Aws::EC2::Model::RunInstancesRequest::GetElasticInferenceAccelerators ( ) const
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1578 of file RunInstancesRequest.h.

◆ GetHibernationOptions()

const HibernationOptionsRequest& Aws::EC2::Model::RunInstancesRequest::GetHibernationOptions ( ) const
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1985 of file RunInstancesRequest.h.

◆ GetIamInstanceProfile()

const IamInstanceProfileSpecification& Aws::EC2::Model::RunInstancesRequest::GetIamInstanceProfile ( ) const
inline

The IAM instance profile.

Definition at line 1274 of file RunInstancesRequest.h.

◆ GetImageId()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetImageId ( ) const
inline

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

Definition at line 115 of file RunInstancesRequest.h.

◆ GetInstanceInitiatedShutdownBehavior()

const ShutdownBehavior& Aws::EC2::Model::RunInstancesRequest::GetInstanceInitiatedShutdownBehavior ( ) const
inline

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

Default: stop

Definition at line 1307 of file RunInstancesRequest.h.

◆ GetInstanceMarketOptions()

const InstanceMarketOptionsRequest& Aws::EC2::Model::RunInstancesRequest::GetInstanceMarketOptions ( ) const
inline

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.

Definition at line 1765 of file RunInstancesRequest.h.

◆ GetInstanceType()

const InstanceType& Aws::EC2::Model::RunInstancesRequest::GetInstanceType ( ) const
inline

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

Default: m1.small

Definition at line 166 of file RunInstancesRequest.h.

◆ GetIpv6AddressCount()

int Aws::EC2::Model::RunInstancesRequest::GetIpv6AddressCount ( ) const
inline

[EC2-VPC] 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.

Definition at line 217 of file RunInstancesRequest.h.

◆ GetIpv6Addresses()

const Aws::Vector<InstanceIpv6Address>& Aws::EC2::Model::RunInstancesRequest::GetIpv6Addresses ( ) const
inline

[EC2-VPC] 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.

Definition at line 258 of file RunInstancesRequest.h.

◆ GetKernelId()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetKernelId ( ) const
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 338 of file RunInstancesRequest.h.

◆ GetKeyName()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetKeyName ( ) const
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 413 of file RunInstancesRequest.h.

◆ GetLaunchTemplate()

const LaunchTemplateSpecification& Aws::EC2::Model::RunInstancesRequest::GetLaunchTemplate ( ) const
inline

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.

Definition at line 1716 of file RunInstancesRequest.h.

◆ GetLicenseSpecifications()

const Aws::Vector<LicenseConfigurationRequest>& Aws::EC2::Model::RunInstancesRequest::GetLicenseSpecifications ( ) const
inline

The license configurations.

Definition at line 2031 of file RunInstancesRequest.h.

◆ GetMaxCount()

int Aws::EC2::Model::RunInstancesRequest::GetMaxCount ( ) const
inline

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.

Definition at line 503 of file RunInstancesRequest.h.

◆ GetMetadataOptions()

const InstanceMetadataOptionsRequest& Aws::EC2::Model::RunInstancesRequest::GetMetadataOptions ( ) const
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2074 of file RunInstancesRequest.h.

◆ GetMinCount()

int Aws::EC2::Model::RunInstancesRequest::GetMinCount ( ) const
inline

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.

Definition at line 551 of file RunInstancesRequest.h.

◆ GetMonitoring()

const RunInstancesMonitoringEnabled& Aws::EC2::Model::RunInstancesRequest::GetMonitoring ( ) const
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 590 of file RunInstancesRequest.h.

◆ GetNetworkInterfaces()

const Aws::Vector<InstanceNetworkInterfaceSpecification>& Aws::EC2::Model::RunInstancesRequest::GetNetworkInterfaces ( ) const
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1350 of file RunInstancesRequest.h.

◆ GetPlacement()

const Placement& Aws::EC2::Model::RunInstancesRequest::GetPlacement ( ) const
inline

The placement for the instance.

Definition at line 621 of file RunInstancesRequest.h.

◆ GetPrivateIpAddress()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetPrivateIpAddress ( ) const
inline

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

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

Definition at line 1411 of file RunInstancesRequest.h.

◆ GetRamdiskId()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetRamdiskId ( ) const
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 659 of file RunInstancesRequest.h.

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::RunInstancesRequest::GetSecurityGroupIds ( ) const
inline

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.

Definition at line 752 of file RunInstancesRequest.h.

◆ GetSecurityGroups()

const Aws::Vector<Aws::String>& Aws::EC2::Model::RunInstancesRequest::GetSecurityGroups ( ) const
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 825 of file RunInstancesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::RunInstancesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 61 of file RunInstancesRequest.h.

◆ GetSubnetId()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetSubnetId ( ) const
inline

[EC2-VPC] 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.

Definition at line 897 of file RunInstancesRequest.h.

◆ GetTagSpecifications()

const Aws::Vector<TagSpecification>& Aws::EC2::Model::RunInstancesRequest::GetTagSpecifications ( ) const
inline

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.

Definition at line 1644 of file RunInstancesRequest.h.

◆ GetUserData()

const Aws::String& Aws::EC2::Model::RunInstancesRequest::GetUserData ( ) const
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 958 of file RunInstancesRequest.h.

◆ HibernationOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::HibernationOptionsHasBeenSet ( ) const
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1993 of file RunInstancesRequest.h.

◆ IamInstanceProfileHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::IamInstanceProfileHasBeenSet ( ) const
inline

The IAM instance profile.

Definition at line 1279 of file RunInstancesRequest.h.

◆ ImageIdHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::ImageIdHasBeenSet ( ) const
inline

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

Definition at line 121 of file RunInstancesRequest.h.

◆ InstanceInitiatedShutdownBehaviorHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::InstanceInitiatedShutdownBehaviorHasBeenSet ( ) const
inline

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

Default: stop

Definition at line 1314 of file RunInstancesRequest.h.

◆ InstanceMarketOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::InstanceMarketOptionsHasBeenSet ( ) const
inline

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.

Definition at line 1773 of file RunInstancesRequest.h.

◆ InstanceTypeHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::InstanceTypeHasBeenSet ( ) const
inline

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

Default: m1.small

Definition at line 174 of file RunInstancesRequest.h.

◆ Ipv6AddressCountHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::Ipv6AddressCountHasBeenSet ( ) const
inline

[EC2-VPC] 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.

Definition at line 227 of file RunInstancesRequest.h.

◆ Ipv6AddressesHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::Ipv6AddressesHasBeenSet ( ) const
inline

[EC2-VPC] 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.

Definition at line 268 of file RunInstancesRequest.h.

◆ KernelIdHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::KernelIdHasBeenSet ( ) const
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 347 of file RunInstancesRequest.h.

◆ KeyNameHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::KeyNameHasBeenSet ( ) const
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 424 of file RunInstancesRequest.h.

◆ LaunchTemplateHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::LaunchTemplateHasBeenSet ( ) const
inline

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.

Definition at line 1724 of file RunInstancesRequest.h.

◆ LicenseSpecificationsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::LicenseSpecificationsHasBeenSet ( ) const
inline

The license configurations.

Definition at line 2036 of file RunInstancesRequest.h.

◆ MaxCountHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::MaxCountHasBeenSet ( ) const
inline

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.

Definition at line 515 of file RunInstancesRequest.h.

◆ MetadataOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::MetadataOptionsHasBeenSet ( ) const
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2081 of file RunInstancesRequest.h.

◆ MinCountHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::MinCountHasBeenSet ( ) const
inline

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.

Definition at line 562 of file RunInstancesRequest.h.

◆ MonitoringHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::MonitoringHasBeenSet ( ) const
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 595 of file RunInstancesRequest.h.

◆ NetworkInterfacesHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::NetworkInterfacesHasBeenSet ( ) const
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1357 of file RunInstancesRequest.h.

◆ PlacementHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::PlacementHasBeenSet ( ) const
inline

The placement for the instance.

Definition at line 626 of file RunInstancesRequest.h.

◆ PrivateIpAddressHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::PrivateIpAddressHasBeenSet ( ) const
inline

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

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

Definition at line 1422 of file RunInstancesRequest.h.

◆ RamdiskIdHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::RamdiskIdHasBeenSet ( ) const
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 671 of file RunInstancesRequest.h.

◆ SecurityGroupIdsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::SecurityGroupIdsHasBeenSet ( ) const
inline

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.

Definition at line 760 of file RunInstancesRequest.h.

◆ SecurityGroupsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::SecurityGroupsHasBeenSet ( ) const
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 833 of file RunInstancesRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::RunInstancesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdditionalInfo() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1051 of file RunInstancesRequest.h.

◆ SetAdditionalInfo() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1056 of file RunInstancesRequest.h.

◆ SetAdditionalInfo() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1061 of file RunInstancesRequest.h.

◆ SetBlockDeviceMappings() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetBlockDeviceMappings ( const Aws::Vector< BlockDeviceMapping > &  value)
inline

The block device mapping entries.

Definition at line 83 of file RunInstancesRequest.h.

◆ SetBlockDeviceMappings() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetBlockDeviceMappings ( Aws::Vector< BlockDeviceMapping > &&  value)
inline

The block device mapping entries.

Definition at line 88 of file RunInstancesRequest.h.

◆ SetCapacityReservationSpecification() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetCapacityReservationSpecification ( const CapacityReservationSpecification value)
inline

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

Definition at line 1952 of file RunInstancesRequest.h.

◆ SetCapacityReservationSpecification() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetCapacityReservationSpecification ( CapacityReservationSpecification &&  value)
inline

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

Definition at line 1960 of file RunInstancesRequest.h.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetClientToken ( const Aws::String value)
inline

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

Definition at line 1104 of file RunInstancesRequest.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetClientToken ( Aws::String &&  value)
inline

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

Definition at line 1113 of file RunInstancesRequest.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetClientToken ( const char *  value)
inline

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

Definition at line 1122 of file RunInstancesRequest.h.

◆ SetCpuOptions() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetCpuOptions ( const CpuOptionsRequest value)
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1906 of file RunInstancesRequest.h.

◆ SetCpuOptions() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetCpuOptions ( CpuOptionsRequest &&  value)
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1913 of file RunInstancesRequest.h.

◆ SetCreditSpecification() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetCreditSpecification ( const CreditSpecificationRequest value)
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1845 of file RunInstancesRequest.h.

◆ SetCreditSpecification() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetCreditSpecification ( CreditSpecificationRequest &&  value)
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1858 of file RunInstancesRequest.h.

◆ SetDisableApiTermination()

void Aws::EC2::Model::RunInstancesRequest::SetDisableApiTermination ( bool  value)
inline

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

Definition at line 1183 of file RunInstancesRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::RunInstancesRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 1219 of file RunInstancesRequest.h.

◆ SetEbsOptimized()

void Aws::EC2::Model::RunInstancesRequest::SetEbsOptimized ( bool  value)
inline

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

Definition at line 1258 of file RunInstancesRequest.h.

◆ SetElasticGpuSpecification() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetElasticGpuSpecification ( const Aws::Vector< ElasticGpuSpecification > &  value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1519 of file RunInstancesRequest.h.

◆ SetElasticGpuSpecification() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetElasticGpuSpecification ( Aws::Vector< ElasticGpuSpecification > &&  value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1529 of file RunInstancesRequest.h.

◆ SetElasticInferenceAccelerators() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetElasticInferenceAccelerators ( const Aws::Vector< ElasticInferenceAccelerator > &  value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1594 of file RunInstancesRequest.h.

◆ SetElasticInferenceAccelerators() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetElasticInferenceAccelerators ( Aws::Vector< ElasticInferenceAccelerator > &&  value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1602 of file RunInstancesRequest.h.

◆ SetHibernationOptions() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetHibernationOptions ( const HibernationOptionsRequest value)
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 2001 of file RunInstancesRequest.h.

◆ SetHibernationOptions() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetHibernationOptions ( HibernationOptionsRequest &&  value)
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 2009 of file RunInstancesRequest.h.

◆ SetIamInstanceProfile() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetIamInstanceProfile ( const IamInstanceProfileSpecification value)
inline

The IAM instance profile.

Definition at line 1284 of file RunInstancesRequest.h.

◆ SetIamInstanceProfile() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetIamInstanceProfile ( IamInstanceProfileSpecification &&  value)
inline

The IAM instance profile.

Definition at line 1289 of file RunInstancesRequest.h.

◆ SetImageId() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetImageId ( const Aws::String value)
inline

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

Definition at line 127 of file RunInstancesRequest.h.

◆ SetImageId() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetImageId ( Aws::String &&  value)
inline

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

Definition at line 133 of file RunInstancesRequest.h.

◆ SetImageId() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetImageId ( const char *  value)
inline

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

Definition at line 139 of file RunInstancesRequest.h.

◆ SetInstanceInitiatedShutdownBehavior() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceInitiatedShutdownBehavior ( const ShutdownBehavior value)
inline

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

Default: stop

Definition at line 1321 of file RunInstancesRequest.h.

◆ SetInstanceInitiatedShutdownBehavior() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceInitiatedShutdownBehavior ( ShutdownBehavior &&  value)
inline

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

Default: stop

Definition at line 1328 of file RunInstancesRequest.h.

◆ SetInstanceMarketOptions() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceMarketOptions ( const InstanceMarketOptionsRequest value)
inline

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.

Definition at line 1781 of file RunInstancesRequest.h.

◆ SetInstanceMarketOptions() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceMarketOptions ( InstanceMarketOptionsRequest &&  value)
inline

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.

Definition at line 1789 of file RunInstancesRequest.h.

◆ SetInstanceType() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceType ( const InstanceType value)
inline

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

Default: m1.small

Definition at line 182 of file RunInstancesRequest.h.

◆ SetInstanceType() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetInstanceType ( InstanceType &&  value)
inline

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

Default: m1.small

Definition at line 190 of file RunInstancesRequest.h.

◆ SetIpv6AddressCount()

void Aws::EC2::Model::RunInstancesRequest::SetIpv6AddressCount ( int  value)
inline

[EC2-VPC] 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.

Definition at line 237 of file RunInstancesRequest.h.

◆ SetIpv6Addresses() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetIpv6Addresses ( const Aws::Vector< InstanceIpv6Address > &  value)
inline

[EC2-VPC] 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.

Definition at line 278 of file RunInstancesRequest.h.

◆ SetIpv6Addresses() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetIpv6Addresses ( Aws::Vector< InstanceIpv6Address > &&  value)
inline

[EC2-VPC] 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.

Definition at line 288 of file RunInstancesRequest.h.

◆ SetKernelId() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetKernelId ( const Aws::String value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 356 of file RunInstancesRequest.h.

◆ SetKernelId() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetKernelId ( Aws::String &&  value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 365 of file RunInstancesRequest.h.

◆ SetKernelId() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetKernelId ( const char *  value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 374 of file RunInstancesRequest.h.

◆ SetKeyName() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetKeyName ( const Aws::String value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 435 of file RunInstancesRequest.h.

◆ SetKeyName() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetKeyName ( Aws::String &&  value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 446 of file RunInstancesRequest.h.

◆ SetKeyName() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetKeyName ( const char *  value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 457 of file RunInstancesRequest.h.

◆ SetLaunchTemplate() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetLaunchTemplate ( const LaunchTemplateSpecification value)
inline

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.

Definition at line 1732 of file RunInstancesRequest.h.

◆ SetLaunchTemplate() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

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.

Definition at line 1740 of file RunInstancesRequest.h.

◆ SetLicenseSpecifications() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetLicenseSpecifications ( const Aws::Vector< LicenseConfigurationRequest > &  value)
inline

The license configurations.

Definition at line 2041 of file RunInstancesRequest.h.

◆ SetLicenseSpecifications() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetLicenseSpecifications ( Aws::Vector< LicenseConfigurationRequest > &&  value)
inline

The license configurations.

Definition at line 2046 of file RunInstancesRequest.h.

◆ SetMaxCount()

void Aws::EC2::Model::RunInstancesRequest::SetMaxCount ( int  value)
inline

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.

Definition at line 527 of file RunInstancesRequest.h.

◆ SetMetadataOptions() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetMetadataOptions ( const InstanceMetadataOptionsRequest value)
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2088 of file RunInstancesRequest.h.

◆ SetMetadataOptions() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetMetadataOptions ( InstanceMetadataOptionsRequest &&  value)
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2095 of file RunInstancesRequest.h.

◆ SetMinCount()

void Aws::EC2::Model::RunInstancesRequest::SetMinCount ( int  value)
inline

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.

Definition at line 573 of file RunInstancesRequest.h.

◆ SetMonitoring() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetMonitoring ( const RunInstancesMonitoringEnabled value)
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 600 of file RunInstancesRequest.h.

◆ SetMonitoring() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetMonitoring ( RunInstancesMonitoringEnabled &&  value)
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 605 of file RunInstancesRequest.h.

◆ SetNetworkInterfaces() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetNetworkInterfaces ( const Aws::Vector< InstanceNetworkInterfaceSpecification > &  value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1364 of file RunInstancesRequest.h.

◆ SetNetworkInterfaces() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetNetworkInterfaces ( Aws::Vector< InstanceNetworkInterfaceSpecification > &&  value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1371 of file RunInstancesRequest.h.

◆ SetPlacement() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetPlacement ( const Placement value)
inline

The placement for the instance.

Definition at line 631 of file RunInstancesRequest.h.

◆ SetPlacement() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetPlacement ( Placement &&  value)
inline

The placement for the instance.

Definition at line 636 of file RunInstancesRequest.h.

◆ SetPrivateIpAddress() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetPrivateIpAddress ( const Aws::String value)
inline

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

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

Definition at line 1433 of file RunInstancesRequest.h.

◆ SetPrivateIpAddress() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetPrivateIpAddress ( Aws::String &&  value)
inline

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

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

Definition at line 1444 of file RunInstancesRequest.h.

◆ SetPrivateIpAddress() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetPrivateIpAddress ( const char *  value)
inline

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

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

Definition at line 1455 of file RunInstancesRequest.h.

◆ SetRamdiskId() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetRamdiskId ( const Aws::String value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 683 of file RunInstancesRequest.h.

◆ SetRamdiskId() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetRamdiskId ( Aws::String &&  value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 695 of file RunInstancesRequest.h.

◆ SetRamdiskId() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetRamdiskId ( const char *  value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 707 of file RunInstancesRequest.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 768 of file RunInstancesRequest.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 776 of file RunInstancesRequest.h.

◆ SetSecurityGroups() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 841 of file RunInstancesRequest.h.

◆ SetSecurityGroups() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 849 of file RunInstancesRequest.h.

◆ SetSubnetId() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetSubnetId ( const Aws::String value)
inline

[EC2-VPC] 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.

Definition at line 911 of file RunInstancesRequest.h.

◆ SetSubnetId() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetSubnetId ( Aws::String &&  value)
inline

[EC2-VPC] 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.

Definition at line 918 of file RunInstancesRequest.h.

◆ SetSubnetId() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetSubnetId ( const char *  value)
inline

[EC2-VPC] 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.

Definition at line 925 of file RunInstancesRequest.h.

◆ SetTagSpecifications() [1/2]

void Aws::EC2::Model::RunInstancesRequest::SetTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

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.

Definition at line 1662 of file RunInstancesRequest.h.

◆ SetTagSpecifications() [2/2]

void Aws::EC2::Model::RunInstancesRequest::SetTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

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.

Definition at line 1671 of file RunInstancesRequest.h.

◆ SetUserData() [1/3]

void Aws::EC2::Model::RunInstancesRequest::SetUserData ( const Aws::String value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 980 of file RunInstancesRequest.h.

◆ SetUserData() [2/3]

void Aws::EC2::Model::RunInstancesRequest::SetUserData ( Aws::String &&  value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 991 of file RunInstancesRequest.h.

◆ SetUserData() [3/3]

void Aws::EC2::Model::RunInstancesRequest::SetUserData ( const char *  value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 1002 of file RunInstancesRequest.h.

◆ SubnetIdHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::SubnetIdHasBeenSet ( ) const
inline

[EC2-VPC] 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.

Definition at line 904 of file RunInstancesRequest.h.

◆ TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::TagSpecificationsHasBeenSet ( ) const
inline

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.

Definition at line 1653 of file RunInstancesRequest.h.

◆ UserDataHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::UserDataHasBeenSet ( ) const
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 969 of file RunInstancesRequest.h.

◆ WithAdditionalInfo() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1066 of file RunInstancesRequest.h.

◆ WithAdditionalInfo() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1071 of file RunInstancesRequest.h.

◆ WithAdditionalInfo() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1076 of file RunInstancesRequest.h.

◆ WithBlockDeviceMappings() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithBlockDeviceMappings ( const Aws::Vector< BlockDeviceMapping > &  value)
inline

The block device mapping entries.

Definition at line 93 of file RunInstancesRequest.h.

◆ WithBlockDeviceMappings() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithBlockDeviceMappings ( Aws::Vector< BlockDeviceMapping > &&  value)
inline

The block device mapping entries.

Definition at line 98 of file RunInstancesRequest.h.

◆ WithCapacityReservationSpecification() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCapacityReservationSpecification ( const CapacityReservationSpecification value)
inline

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

Definition at line 1968 of file RunInstancesRequest.h.

◆ WithCapacityReservationSpecification() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCapacityReservationSpecification ( CapacityReservationSpecification &&  value)
inline

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

Definition at line 1976 of file RunInstancesRequest.h.

◆ WithClientToken() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithClientToken ( const Aws::String value)
inline

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

Definition at line 1131 of file RunInstancesRequest.h.

◆ WithClientToken() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithClientToken ( Aws::String &&  value)
inline

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

Definition at line 1140 of file RunInstancesRequest.h.

◆ WithClientToken() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithClientToken ( const char *  value)
inline

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

Definition at line 1149 of file RunInstancesRequest.h.

◆ WithCpuOptions() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCpuOptions ( const CpuOptionsRequest value)
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1920 of file RunInstancesRequest.h.

◆ WithCpuOptions() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCpuOptions ( CpuOptionsRequest &&  value)
inline

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1927 of file RunInstancesRequest.h.

◆ WithCreditSpecification() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCreditSpecification ( const CreditSpecificationRequest value)
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1871 of file RunInstancesRequest.h.

◆ WithCreditSpecification() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithCreditSpecification ( CreditSpecificationRequest &&  value)
inline

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 Elastic Compute Cloud User Guide.

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

Definition at line 1884 of file RunInstancesRequest.h.

◆ WithDisableApiTermination()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithDisableApiTermination ( bool  value)
inline

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

Definition at line 1194 of file RunInstancesRequest.h.

◆ WithDryRun()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 1227 of file RunInstancesRequest.h.

◆ WithEbsOptimized()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithEbsOptimized ( bool  value)
inline

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

Definition at line 1268 of file RunInstancesRequest.h.

◆ WithElasticGpuSpecification() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithElasticGpuSpecification ( const Aws::Vector< ElasticGpuSpecification > &  value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1539 of file RunInstancesRequest.h.

◆ WithElasticGpuSpecification() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithElasticGpuSpecification ( Aws::Vector< ElasticGpuSpecification > &&  value)
inline

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

Definition at line 1549 of file RunInstancesRequest.h.

◆ WithElasticInferenceAccelerators() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithElasticInferenceAccelerators ( const Aws::Vector< ElasticInferenceAccelerator > &  value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1610 of file RunInstancesRequest.h.

◆ WithElasticInferenceAccelerators() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithElasticInferenceAccelerators ( Aws::Vector< ElasticInferenceAccelerator > &&  value)
inline

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

Definition at line 1618 of file RunInstancesRequest.h.

◆ WithHibernationOptions() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithHibernationOptions ( const HibernationOptionsRequest value)
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 2017 of file RunInstancesRequest.h.

◆ WithHibernationOptions() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithHibernationOptions ( HibernationOptionsRequest &&  value)
inline

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Definition at line 2025 of file RunInstancesRequest.h.

◆ WithIamInstanceProfile() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithIamInstanceProfile ( const IamInstanceProfileSpecification value)
inline

The IAM instance profile.

Definition at line 1294 of file RunInstancesRequest.h.

◆ WithIamInstanceProfile() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithIamInstanceProfile ( IamInstanceProfileSpecification &&  value)
inline

The IAM instance profile.

Definition at line 1299 of file RunInstancesRequest.h.

◆ WithImageId() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithImageId ( const Aws::String value)
inline

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

Definition at line 145 of file RunInstancesRequest.h.

◆ WithImageId() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithImageId ( Aws::String &&  value)
inline

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

Definition at line 151 of file RunInstancesRequest.h.

◆ WithImageId() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithImageId ( const char *  value)
inline

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

Definition at line 157 of file RunInstancesRequest.h.

◆ WithInstanceInitiatedShutdownBehavior() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceInitiatedShutdownBehavior ( const ShutdownBehavior value)
inline

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

Default: stop

Definition at line 1335 of file RunInstancesRequest.h.

◆ WithInstanceInitiatedShutdownBehavior() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceInitiatedShutdownBehavior ( ShutdownBehavior &&  value)
inline

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

Default: stop

Definition at line 1342 of file RunInstancesRequest.h.

◆ WithInstanceMarketOptions() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceMarketOptions ( const InstanceMarketOptionsRequest value)
inline

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.

Definition at line 1797 of file RunInstancesRequest.h.

◆ WithInstanceMarketOptions() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceMarketOptions ( InstanceMarketOptionsRequest &&  value)
inline

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.

Definition at line 1805 of file RunInstancesRequest.h.

◆ WithInstanceType() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceType ( const InstanceType value)
inline

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

Default: m1.small

Definition at line 198 of file RunInstancesRequest.h.

◆ WithInstanceType() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithInstanceType ( InstanceType &&  value)
inline

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

Default: m1.small

Definition at line 206 of file RunInstancesRequest.h.

◆ WithIpv6AddressCount()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithIpv6AddressCount ( int  value)
inline

[EC2-VPC] 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.

Definition at line 247 of file RunInstancesRequest.h.

◆ WithIpv6Addresses() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithIpv6Addresses ( const Aws::Vector< InstanceIpv6Address > &  value)
inline

[EC2-VPC] 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.

Definition at line 298 of file RunInstancesRequest.h.

◆ WithIpv6Addresses() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithIpv6Addresses ( Aws::Vector< InstanceIpv6Address > &&  value)
inline

[EC2-VPC] 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.

Definition at line 308 of file RunInstancesRequest.h.

◆ WithKernelId() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKernelId ( const Aws::String value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 383 of file RunInstancesRequest.h.

◆ WithKernelId() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKernelId ( Aws::String &&  value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 392 of file RunInstancesRequest.h.

◆ WithKernelId() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKernelId ( const char *  value)
inline

The ID of the kernel.

<important>

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.

</important>

Definition at line 401 of file RunInstancesRequest.h.

◆ WithKeyName() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKeyName ( const Aws::String value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 468 of file RunInstancesRequest.h.

◆ WithKeyName() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKeyName ( Aws::String &&  value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 479 of file RunInstancesRequest.h.

◆ WithKeyName() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithKeyName ( const char *  value)
inline

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

<important>

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.

</important>

Definition at line 490 of file RunInstancesRequest.h.

◆ WithLaunchTemplate() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithLaunchTemplate ( const LaunchTemplateSpecification value)
inline

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.

Definition at line 1748 of file RunInstancesRequest.h.

◆ WithLaunchTemplate() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

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.

Definition at line 1756 of file RunInstancesRequest.h.

◆ WithLicenseSpecifications() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithLicenseSpecifications ( const Aws::Vector< LicenseConfigurationRequest > &  value)
inline

The license configurations.

Definition at line 2051 of file RunInstancesRequest.h.

◆ WithLicenseSpecifications() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithLicenseSpecifications ( Aws::Vector< LicenseConfigurationRequest > &&  value)
inline

The license configurations.

Definition at line 2056 of file RunInstancesRequest.h.

◆ WithMaxCount()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMaxCount ( int  value)
inline

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.

Definition at line 539 of file RunInstancesRequest.h.

◆ WithMetadataOptions() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMetadataOptions ( const InstanceMetadataOptionsRequest value)
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2102 of file RunInstancesRequest.h.

◆ WithMetadataOptions() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMetadataOptions ( InstanceMetadataOptionsRequest &&  value)
inline

The metadata options for the instance. For more information, see Instance Metadata and User Data.

Definition at line 2109 of file RunInstancesRequest.h.

◆ WithMinCount()

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMinCount ( int  value)
inline

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.

Definition at line 584 of file RunInstancesRequest.h.

◆ WithMonitoring() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMonitoring ( const RunInstancesMonitoringEnabled value)
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 610 of file RunInstancesRequest.h.

◆ WithMonitoring() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithMonitoring ( RunInstancesMonitoringEnabled &&  value)
inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 615 of file RunInstancesRequest.h.

◆ WithNetworkInterfaces() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithNetworkInterfaces ( const Aws::Vector< InstanceNetworkInterfaceSpecification > &  value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1378 of file RunInstancesRequest.h.

◆ WithNetworkInterfaces() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithNetworkInterfaces ( Aws::Vector< InstanceNetworkInterfaceSpecification > &&  value)
inline

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

Definition at line 1385 of file RunInstancesRequest.h.

◆ WithPlacement() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithPlacement ( const Placement value)
inline

The placement for the instance.

Definition at line 641 of file RunInstancesRequest.h.

◆ WithPlacement() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithPlacement ( Placement &&  value)
inline

The placement for the instance.

Definition at line 646 of file RunInstancesRequest.h.

◆ WithPrivateIpAddress() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithPrivateIpAddress ( const Aws::String value)
inline

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

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

Definition at line 1466 of file RunInstancesRequest.h.

◆ WithPrivateIpAddress() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithPrivateIpAddress ( Aws::String &&  value)
inline

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

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

Definition at line 1477 of file RunInstancesRequest.h.

◆ WithPrivateIpAddress() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithPrivateIpAddress ( const char *  value)
inline

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

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

Definition at line 1488 of file RunInstancesRequest.h.

◆ WithRamdiskId() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithRamdiskId ( const Aws::String value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 719 of file RunInstancesRequest.h.

◆ WithRamdiskId() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithRamdiskId ( Aws::String &&  value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 731 of file RunInstancesRequest.h.

◆ WithRamdiskId() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithRamdiskId ( const char *  value)
inline

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 AWS Resource Center and search for the kernel ID.

<important>

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.

</important>

Definition at line 743 of file RunInstancesRequest.h.

◆ WithSecurityGroupIds() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 784 of file RunInstancesRequest.h.

◆ WithSecurityGroupIds() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 792 of file RunInstancesRequest.h.

◆ WithSecurityGroups() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 857 of file RunInstancesRequest.h.

◆ WithSecurityGroups() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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

Default: Amazon EC2 uses the default security group.

Definition at line 865 of file RunInstancesRequest.h.

◆ WithSubnetId() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSubnetId ( const Aws::String value)
inline

[EC2-VPC] 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.

Definition at line 932 of file RunInstancesRequest.h.

◆ WithSubnetId() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSubnetId ( Aws::String &&  value)
inline

[EC2-VPC] 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.

Definition at line 939 of file RunInstancesRequest.h.

◆ WithSubnetId() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithSubnetId ( const char *  value)
inline

[EC2-VPC] 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.

Definition at line 946 of file RunInstancesRequest.h.

◆ WithTagSpecifications() [1/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

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.

Definition at line 1680 of file RunInstancesRequest.h.

◆ WithTagSpecifications() [2/2]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

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.

Definition at line 1689 of file RunInstancesRequest.h.

◆ WithUserData() [1/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithUserData ( const Aws::String value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 1013 of file RunInstancesRequest.h.

◆ WithUserData() [2/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithUserData ( Aws::String &&  value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 1024 of file RunInstancesRequest.h.

◆ WithUserData() [3/3]

RunInstancesRequest& Aws::EC2::Model::RunInstancesRequest::WithUserData ( const char *  value)
inline

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding 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. User data is limited to 16 KB.

Definition at line 1035 of file RunInstancesRequest.h.


The documentation for this class was generated from the following file: