Aws::EC2::Model::RunInstancesRequest Class Reference

#include <RunInstancesRequest.h>

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

Public Member Functions

AWS_EC2_API RunInstancesRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_EC2_API Aws::String SerializePayload () const override

 

const Aws::Vector< BlockDeviceMapping > & GetBlockDeviceMappings () const

 

bool BlockDeviceMappingsHasBeenSet () const

 

template<typename BlockDeviceMappingsT = Aws::Vector<BlockDeviceMapping>>

void SetBlockDeviceMappings (BlockDeviceMappingsT &&value)

 

template<typename BlockDeviceMappingsT = Aws::Vector<BlockDeviceMapping>>

RunInstancesRequest & WithBlockDeviceMappings (BlockDeviceMappingsT &&value)

 

template<typename BlockDeviceMappingsT = BlockDeviceMapping>

RunInstancesRequest & AddBlockDeviceMappings (BlockDeviceMappingsT &&value)

 

const Aws::String & GetImageId () const

 

bool ImageIdHasBeenSet () const

 

template<typename ImageIdT = Aws::String>

void SetImageId (ImageIdT &&value)

 

template<typename ImageIdT = Aws::String>

RunInstancesRequest & WithImageId (ImageIdT &&value)

 

InstanceType GetInstanceType () const

 

bool InstanceTypeHasBeenSet () const

 

void SetInstanceType (InstanceType value)

 

RunInstancesRequest & WithInstanceType (InstanceType value)

 

int GetIpv6AddressCount () const

 

bool Ipv6AddressCountHasBeenSet () const

 

void SetIpv6AddressCount (int value)

 

RunInstancesRequest & WithIpv6AddressCount (int value)

 

const Aws::Vector< InstanceIpv6Address > & GetIpv6Addresses () const

 

bool Ipv6AddressesHasBeenSet () const

 

template<typename Ipv6AddressesT = Aws::Vector<InstanceIpv6Address>>

void SetIpv6Addresses (Ipv6AddressesT &&value)

 

template<typename Ipv6AddressesT = Aws::Vector<InstanceIpv6Address>>

RunInstancesRequest & WithIpv6Addresses (Ipv6AddressesT &&value)

 

template<typename Ipv6AddressesT = InstanceIpv6Address>

RunInstancesRequest & AddIpv6Addresses (Ipv6AddressesT &&value)

 

const Aws::String & GetKernelId () const

 

bool KernelIdHasBeenSet () const

 

template<typename KernelIdT = Aws::String>

void SetKernelId (KernelIdT &&value)

 

template<typename KernelIdT = Aws::String>

RunInstancesRequest & WithKernelId (KernelIdT &&value)

 

const Aws::String & GetKeyName () const

 

bool KeyNameHasBeenSet () const

 

template<typename KeyNameT = Aws::String>

void SetKeyName (KeyNameT &&value)

 

template<typename KeyNameT = Aws::String>

RunInstancesRequest & WithKeyName (KeyNameT &&value)

 

int GetMaxCount () const

 

bool MaxCountHasBeenSet () const

 

void SetMaxCount (int value)

 

RunInstancesRequest & WithMaxCount (int value)

 

int GetMinCount () const

 

bool MinCountHasBeenSet () const

 

void SetMinCount (int value)

 

RunInstancesRequest & WithMinCount (int value)

 

const RunInstancesMonitoringEnabled & GetMonitoring () const

 

bool MonitoringHasBeenSet () const

 

template<typename MonitoringT = RunInstancesMonitoringEnabled>

void SetMonitoring (MonitoringT &&value)

 

template<typename MonitoringT = RunInstancesMonitoringEnabled>

RunInstancesRequest & WithMonitoring (MonitoringT &&value)

 

const Placement & GetPlacement () const

 

bool PlacementHasBeenSet () const

 

template<typename PlacementT = Placement>

void SetPlacement (PlacementT &&value)

 

template<typename PlacementT = Placement>

RunInstancesRequest & WithPlacement (PlacementT &&value)

 

const Aws::String & GetRamdiskId () const

 

bool RamdiskIdHasBeenSet () const

 

template<typename RamdiskIdT = Aws::String>

void SetRamdiskId (RamdiskIdT &&value)

 

template<typename RamdiskIdT = Aws::String>

RunInstancesRequest & WithRamdiskId (RamdiskIdT &&value)

 

const Aws::Vector< Aws::String > & GetSecurityGroupIds () const

 

bool SecurityGroupIdsHasBeenSet () const

 

template<typename SecurityGroupIdsT = Aws::Vector<Aws::String>>

void SetSecurityGroupIds (SecurityGroupIdsT &&value)

 

template<typename SecurityGroupIdsT = Aws::Vector<Aws::String>>

RunInstancesRequest & WithSecurityGroupIds (SecurityGroupIdsT &&value)

 

template<typename SecurityGroupIdsT = Aws::String>

RunInstancesRequest & AddSecurityGroupIds (SecurityGroupIdsT &&value)

 

const Aws::Vector< Aws::String > & GetSecurityGroups () const

 

bool SecurityGroupsHasBeenSet () const

 

template<typename SecurityGroupsT = Aws::Vector<Aws::String>>

void SetSecurityGroups (SecurityGroupsT &&value)

 

template<typename SecurityGroupsT = Aws::Vector<Aws::String>>

RunInstancesRequest & WithSecurityGroups (SecurityGroupsT &&value)

 

template<typename SecurityGroupsT = Aws::String>

RunInstancesRequest & AddSecurityGroups (SecurityGroupsT &&value)

 

const Aws::String & GetSubnetId () const

 

bool SubnetIdHasBeenSet () const

 

template<typename SubnetIdT = Aws::String>

void SetSubnetId (SubnetIdT &&value)

 

template<typename SubnetIdT = Aws::String>

RunInstancesRequest & WithSubnetId (SubnetIdT &&value)

 

const Aws::String & GetUserData () const

 

bool UserDataHasBeenSet () const

 

template<typename UserDataT = Aws::String>

void SetUserData (UserDataT &&value)

 

template<typename UserDataT = Aws::String>

RunInstancesRequest & WithUserData (UserDataT &&value)

 

const Aws::Vector< TagSpecification > & GetTagSpecifications () const

 

bool TagSpecificationsHasBeenSet () const

 

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

void SetTagSpecifications (TagSpecificationsT &&value)

 

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

RunInstancesRequest & WithTagSpecifications (TagSpecificationsT &&value)

 

template<typename TagSpecificationsT = TagSpecification>

RunInstancesRequest & AddTagSpecifications (TagSpecificationsT &&value)

 

const LaunchTemplateSpecification & GetLaunchTemplate () const

 

bool LaunchTemplateHasBeenSet () const

 

template<typename LaunchTemplateT = LaunchTemplateSpecification>

void SetLaunchTemplate (LaunchTemplateT &&value)

 

template<typename LaunchTemplateT = LaunchTemplateSpecification>

RunInstancesRequest & WithLaunchTemplate (LaunchTemplateT &&value)

 

const InstanceMarketOptionsRequest & GetInstanceMarketOptions () const

 

bool InstanceMarketOptionsHasBeenSet () const

 

template<typename InstanceMarketOptionsT = InstanceMarketOptionsRequest>

void SetInstanceMarketOptions (InstanceMarketOptionsT &&value)

 

template<typename InstanceMarketOptionsT = InstanceMarketOptionsRequest>

RunInstancesRequest & WithInstanceMarketOptions (InstanceMarketOptionsT &&value)

 

const CreditSpecificationRequest & GetCreditSpecification () const

 

bool CreditSpecificationHasBeenSet () const

 

template<typename CreditSpecificationT = CreditSpecificationRequest>

void SetCreditSpecification (CreditSpecificationT &&value)

 

template<typename CreditSpecificationT = CreditSpecificationRequest>

RunInstancesRequest & WithCreditSpecification (CreditSpecificationT &&value)

 

const CpuOptionsRequest & GetCpuOptions () const

 

bool CpuOptionsHasBeenSet () const

 

template<typename CpuOptionsT = CpuOptionsRequest>

void SetCpuOptions (CpuOptionsT &&value)

 

template<typename CpuOptionsT = CpuOptionsRequest>

RunInstancesRequest & WithCpuOptions (CpuOptionsT &&value)

 

const CapacityReservationSpecification & GetCapacityReservationSpecification () const

 

bool CapacityReservationSpecificationHasBeenSet () const

 

template<typename CapacityReservationSpecificationT = CapacityReservationSpecification>

void SetCapacityReservationSpecification (CapacityReservationSpecificationT &&value)

 

template<typename CapacityReservationSpecificationT = CapacityReservationSpecification>

RunInstancesRequest & WithCapacityReservationSpecification (CapacityReservationSpecificationT &&value)

 

const HibernationOptionsRequest & GetHibernationOptions () const

 

bool HibernationOptionsHasBeenSet () const

 

template<typename HibernationOptionsT = HibernationOptionsRequest>

void SetHibernationOptions (HibernationOptionsT &&value)

 

template<typename HibernationOptionsT = HibernationOptionsRequest>

RunInstancesRequest & WithHibernationOptions (HibernationOptionsT &&value)

 

const Aws::Vector< LicenseConfigurationRequest > & GetLicenseSpecifications () const

 

bool LicenseSpecificationsHasBeenSet () const

 

template<typename LicenseSpecificationsT = Aws::Vector<LicenseConfigurationRequest>>

void SetLicenseSpecifications (LicenseSpecificationsT &&value)

 

template<typename LicenseSpecificationsT = Aws::Vector<LicenseConfigurationRequest>>

RunInstancesRequest & WithLicenseSpecifications (LicenseSpecificationsT &&value)

 

template<typename LicenseSpecificationsT = LicenseConfigurationRequest>

RunInstancesRequest & AddLicenseSpecifications (LicenseSpecificationsT &&value)

 

const InstanceMetadataOptionsRequest & GetMetadataOptions () const

 

bool MetadataOptionsHasBeenSet () const

 

template<typename MetadataOptionsT = InstanceMetadataOptionsRequest>

void SetMetadataOptions (MetadataOptionsT &&value)

 

template<typename MetadataOptionsT = InstanceMetadataOptionsRequest>

RunInstancesRequest & WithMetadataOptions (MetadataOptionsT &&value)

 

const EnclaveOptionsRequest & GetEnclaveOptions () const

 

bool EnclaveOptionsHasBeenSet () const

 

template<typename EnclaveOptionsT = EnclaveOptionsRequest>

void SetEnclaveOptions (EnclaveOptionsT &&value)

 

template<typename EnclaveOptionsT = EnclaveOptionsRequest>

RunInstancesRequest & WithEnclaveOptions (EnclaveOptionsT &&value)

 

const PrivateDnsNameOptionsRequest & GetPrivateDnsNameOptions () const

 

bool PrivateDnsNameOptionsHasBeenSet () const

 

template<typename PrivateDnsNameOptionsT = PrivateDnsNameOptionsRequest>

void SetPrivateDnsNameOptions (PrivateDnsNameOptionsT &&value)

 

template<typename PrivateDnsNameOptionsT = PrivateDnsNameOptionsRequest>

RunInstancesRequest & WithPrivateDnsNameOptions (PrivateDnsNameOptionsT &&value)

 

const InstanceMaintenanceOptionsRequest & GetMaintenanceOptions () const

 

bool MaintenanceOptionsHasBeenSet () const

 

template<typename MaintenanceOptionsT = InstanceMaintenanceOptionsRequest>

void SetMaintenanceOptions (MaintenanceOptionsT &&value)

 

template<typename MaintenanceOptionsT = InstanceMaintenanceOptionsRequest>

RunInstancesRequest & WithMaintenanceOptions (MaintenanceOptionsT &&value)

 

bool GetDisableApiStop () const

 

bool DisableApiStopHasBeenSet () const

 

void SetDisableApiStop (bool value)

 

RunInstancesRequest & WithDisableApiStop (bool value)

 

bool GetEnablePrimaryIpv6 () const

 

bool EnablePrimaryIpv6HasBeenSet () const

 

void SetEnablePrimaryIpv6 (bool value)

 

RunInstancesRequest & WithEnablePrimaryIpv6 (bool value)

 

const InstanceNetworkPerformanceOptionsRequest & GetNetworkPerformanceOptions () const

 

bool NetworkPerformanceOptionsHasBeenSet () const

 

template<typename NetworkPerformanceOptionsT = InstanceNetworkPerformanceOptionsRequest>

void SetNetworkPerformanceOptions (NetworkPerformanceOptionsT &&value)

 

template<typename NetworkPerformanceOptionsT = InstanceNetworkPerformanceOptionsRequest>

RunInstancesRequest & WithNetworkPerformanceOptions (NetworkPerformanceOptionsT &&value)

 

const OperatorRequest & GetOperator () const

 

bool OperatorHasBeenSet () const

 

template<typename OperatorT = OperatorRequest>

void SetOperator (OperatorT &&value)

 

template<typename OperatorT = OperatorRequest>

RunInstancesRequest & WithOperator (OperatorT &&value)

 

const Aws::Vector< InstanceSecondaryInterfaceSpecificationRequest > & GetSecondaryInterfaces () const

 

bool SecondaryInterfacesHasBeenSet () const

 

template<typename SecondaryInterfacesT = Aws::Vector<InstanceSecondaryInterfaceSpecificationRequest>>

void SetSecondaryInterfaces (SecondaryInterfacesT &&value)

 

template<typename SecondaryInterfacesT = Aws::Vector<InstanceSecondaryInterfaceSpecificationRequest>>

RunInstancesRequest & WithSecondaryInterfaces (SecondaryInterfacesT &&value)

 

template<typename SecondaryInterfacesT = InstanceSecondaryInterfaceSpecificationRequest>

RunInstancesRequest & AddSecondaryInterfaces (SecondaryInterfacesT &&value)

 

bool GetDryRun () const

 

bool DryRunHasBeenSet () const

 

void SetDryRun (bool value)

 

RunInstancesRequest & WithDryRun (bool value)

 

bool GetDisableApiTermination () const

 

bool DisableApiTerminationHasBeenSet () const

 

void SetDisableApiTermination (bool value)

 

RunInstancesRequest & WithDisableApiTermination (bool value)

 

ShutdownBehavior GetInstanceInitiatedShutdownBehavior () const

 

bool InstanceInitiatedShutdownBehaviorHasBeenSet () const

 

void SetInstanceInitiatedShutdownBehavior (ShutdownBehavior value)

 

RunInstancesRequest & WithInstanceInitiatedShutdownBehavior (ShutdownBehavior value)

 

const Aws::String & GetPrivateIpAddress () const

 

bool PrivateIpAddressHasBeenSet () const

 

template<typename PrivateIpAddressT = Aws::String>

void SetPrivateIpAddress (PrivateIpAddressT &&value)

 

template<typename PrivateIpAddressT = Aws::String>

RunInstancesRequest & WithPrivateIpAddress (PrivateIpAddressT &&value)

 

const Aws::String & GetClientToken () const

 

bool ClientTokenHasBeenSet () const

 

template<typename ClientTokenT = Aws::String>

void SetClientToken (ClientTokenT &&value)

 

template<typename ClientTokenT = Aws::String>

RunInstancesRequest & WithClientToken (ClientTokenT &&value)

 

const Aws::String & GetAdditionalInfo () const

 

bool AdditionalInfoHasBeenSet () const

 

template<typename AdditionalInfoT = Aws::String>

void SetAdditionalInfo (AdditionalInfoT &&value)

 

template<typename AdditionalInfoT = Aws::String>

RunInstancesRequest & WithAdditionalInfo (AdditionalInfoT &&value)

 

const Aws::Vector< InstanceNetworkInterfaceSpecification > & GetNetworkInterfaces () const

 

bool NetworkInterfacesHasBeenSet () const

 

template<typename NetworkInterfacesT = Aws::Vector<InstanceNetworkInterfaceSpecification>>

void SetNetworkInterfaces (NetworkInterfacesT &&value)

 

template<typename NetworkInterfacesT = Aws::Vector<InstanceNetworkInterfaceSpecification>>

RunInstancesRequest & WithNetworkInterfaces (NetworkInterfacesT &&value)

 

template<typename NetworkInterfacesT = InstanceNetworkInterfaceSpecification>

RunInstancesRequest & AddNetworkInterfaces (NetworkInterfacesT &&value)

 

const IamInstanceProfileSpecification & GetIamInstanceProfile () const

 

bool IamInstanceProfileHasBeenSet () const

 

template<typename IamInstanceProfileT = IamInstanceProfileSpecification>

void SetIamInstanceProfile (IamInstanceProfileT &&value)

 

template<typename IamInstanceProfileT = IamInstanceProfileSpecification>

RunInstancesRequest & WithIamInstanceProfile (IamInstanceProfileT &&value)

 

bool GetEbsOptimized () const

 

bool EbsOptimizedHasBeenSet () const

 

void SetEbsOptimized (bool value)

 

RunInstancesRequest & WithEbsOptimized (bool 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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual bool IsLongPollingOperation () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual bool ChecksumAlgorithmIsSet () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

AWS_EC2_API void DumpBodyToUrl (Aws::Http::URI &uri) const override

 

Protected Member Functions inherited from Aws::EC2::EC2Request

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 44 of file RunInstancesRequest.h.

Constructor & Destructor Documentation

RunInstancesRequest()

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

default

Member Function Documentation

AddBlockDeviceMappings()

template<typename BlockDeviceMappingsT = BlockDeviceMapping>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddBlockDeviceMappings ( BlockDeviceMappingsT &&  value)

inline

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

Definition at line 80 of file RunInstancesRequest.h.

AddIpv6Addresses()

template<typename Ipv6AddressesT = InstanceIpv6Address>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddIpv6Addresses ( Ipv6AddressesT &&  value)

inline

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 166 of file RunInstancesRequest.h.

AdditionalInfoHasBeenSet()

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

inline

Reserved.

Definition at line 900 of file RunInstancesRequest.h.

AddLicenseSpecifications()

template<typename LicenseSpecificationsT = LicenseConfigurationRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddLicenseSpecifications ( LicenseSpecificationsT &&  value)

inline

The license configurations.

Definition at line 597 of file RunInstancesRequest.h.

AddNetworkInterfaces()

template<typename NetworkInterfacesT = InstanceNetworkInterfaceSpecification>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddNetworkInterfaces ( NetworkInterfacesT &&  value)

inline

The network interfaces to associate with the instance.

Definition at line 930 of file RunInstancesRequest.h.

AddSecondaryInterfaces()

template<typename SecondaryInterfacesT = InstanceSecondaryInterfaceSpecificationRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddSecondaryInterfaces ( SecondaryInterfacesT &&  value)

inline

The secondary interfaces to associate with the instance.

Definition at line 784 of file RunInstancesRequest.h.

AddSecurityGroupIds()

template<typename SecurityGroupIdsT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddSecurityGroupIds ( SecurityGroupIdsT &&  value)

inline

The IDs of the security groups.

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

Definition at line 340 of file RunInstancesRequest.h.

AddSecurityGroups()

template<typename SecurityGroupsT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddSecurityGroups ( SecurityGroupsT &&  value)

inline

[Default VPC] The names of the security groups.

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

Default: Amazon EC2 uses the default security group.

Definition at line 367 of file RunInstancesRequest.h.

AddTagSpecifications()

template<typename TagSpecificationsT = TagSpecification>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::AddTagSpecifications ( TagSpecificationsT &&  value)

inline

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

You can specify tags for the following resources only:

• Instances

• Volumes

• Spot Instance requests

• Network interfaces

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

Definition at line 438 of file RunInstancesRequest.h.

BlockDeviceMappingsHasBeenSet()

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

inline

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

Definition at line 68 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, and tenancy).

Definition at line 542 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 in Amazon EC2 API requests.

Constraints: Maximum 64 ASCII characters

Definition at line 882 of file RunInstancesRequest.h.

CpuOptionsHasBeenSet()

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

inline

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

Definition at line 520 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 EC2 User Guide.

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

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

Definition at line 500 of file RunInstancesRequest.h.

DisableApiStopHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::DisableApiStopHasBeenSet ( ) const

inline

Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances.

Definition at line 692 of file RunInstancesRequest.h.

DisableApiTerminationHasBeenSet()

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

inline

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Definition at line 819 of file RunInstancesRequest.h.

DryRunHasBeenSet()

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

inline

Checks whether you have the required permissions for the operation, 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 799 of file RunInstancesRequest.h.

DumpBodyToUrl()

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

overrideprotectedvirtual

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 965 of file RunInstancesRequest.h.

EnablePrimaryIpv6HasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::EnablePrimaryIpv6HasBeenSet ( ) const

inline

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

Definition at line 720 of file RunInstancesRequest.h.

EnclaveOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::EnclaveOptionsHasBeenSet ( ) const

inline

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

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

Definition at line 633 of file RunInstancesRequest.h.

GetAdditionalInfo()

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

inline

Reserved.

Definition at line 899 of file RunInstancesRequest.h.

GetBlockDeviceMappings()

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

inline

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

Definition at line 67 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, and tenancy).

Definition at line 541 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 in Amazon EC2 API requests.

Constraints: Maximum 64 ASCII characters

Definition at line 881 of file RunInstancesRequest.h.

GetCpuOptions()

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

inline

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

Definition at line 519 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 EC2 User Guide.

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

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

Definition at line 499 of file RunInstancesRequest.h.

GetDisableApiStop()

bool Aws::EC2::Model::RunInstancesRequest::GetDisableApiStop ( ) const

inline

Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances.

Definition at line 691 of file RunInstancesRequest.h.

GetDisableApiTermination()

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

inline

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Definition at line 818 of file RunInstancesRequest.h.

GetDryRun()

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

inline

Checks whether you have the required permissions for the operation, 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 798 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 964 of file RunInstancesRequest.h.

GetEnablePrimaryIpv6()

bool Aws::EC2::Model::RunInstancesRequest::GetEnablePrimaryIpv6 ( ) const

inline

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

Definition at line 719 of file RunInstancesRequest.h.

GetEnclaveOptions()

const EnclaveOptionsRequest & Aws::EC2::Model::RunInstancesRequest::GetEnclaveOptions ( ) const

inline

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

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

Definition at line 632 of file RunInstancesRequest.h.

GetHibernationOptions()

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

inline

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

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

Definition at line 566 of file RunInstancesRequest.h.

GetIamInstanceProfile()

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

inline

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

Definition at line 941 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 92 of file RunInstancesRequest.h.

GetInstanceInitiatedShutdownBehavior()

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 836 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 472 of file RunInstancesRequest.h.

GetInstanceType()

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

inline

The instance type. For more information, see Amazon EC2 Instance Types Guide.

Definition at line 112 of file RunInstancesRequest.h.

GetIpv6AddressCount()

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

inline

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 133 of file RunInstancesRequest.h.

GetIpv6Addresses()

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

inline

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 153 of file RunInstancesRequest.h.

GetKernelId()

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

inline

The ID of the kernel.

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

Definition at line 180 of file RunInstancesRequest.h.

GetKeyName()

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

inline

The name of the key pair. For more information, see Create a key pair for your EC2 instance.

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.

Definition at line 202 of file RunInstancesRequest.h.

GetLaunchTemplate()

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

inline

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

Definition at line 451 of file RunInstancesRequest.h.

GetLicenseSpecifications()

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

inline

The license configurations.

Definition at line 584 of file RunInstancesRequest.h.

GetMaintenanceOptions()

const InstanceMaintenanceOptionsRequest & Aws::EC2::Model::RunInstancesRequest::GetMaintenanceOptions ( ) const

inline

The maintenance and recovery options for the instance.

Definition at line 670 of file RunInstancesRequest.h.

GetMaxCount()

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

inline

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

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

Definition at line 226 of file RunInstancesRequest.h.

GetMetadataOptions()

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

inline

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options.

Definition at line 610 of file RunInstancesRequest.h.

GetMinCount()

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

inline

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

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

Definition at line 248 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 264 of file RunInstancesRequest.h.

GetNetworkInterfaces()

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

inline

The network interfaces to associate with the instance.

Definition at line 917 of file RunInstancesRequest.h.

GetNetworkPerformanceOptions()

const InstanceNetworkPerformanceOptionsRequest & Aws::EC2::Model::RunInstancesRequest::GetNetworkPerformanceOptions ( ) const

inline

Contains settings for the network performance options for the instance.

Definition at line 735 of file RunInstancesRequest.h.

GetOperator()

const OperatorRequest & Aws::EC2::Model::RunInstancesRequest::GetOperator ( ) const

inline

Reserved for internal use.

Definition at line 753 of file RunInstancesRequest.h.

GetPlacement()

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

inline

The placement for the instance.

Definition at line 282 of file RunInstancesRequest.h.

GetPrivateDnsNameOptions()

const PrivateDnsNameOptionsRequest & Aws::EC2::Model::RunInstancesRequest::GetPrivateDnsNameOptions ( ) const

inline

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

Definition at line 652 of file RunInstancesRequest.h.

GetPrivateIpAddress()

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

inline

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 858 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 Amazon Web Services Resource Center and search for the kernel ID.

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

Definition at line 307 of file RunInstancesRequest.h.

GetSecondaryInterfaces()

const Aws::Vector< InstanceSecondaryInterfaceSpecificationRequest > & Aws::EC2::Model::RunInstancesRequest::GetSecondaryInterfaces ( ) const

inline

The secondary interfaces to associate with the instance.

Definition at line 771 of file RunInstancesRequest.h.

GetSecurityGroupIds()

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

inline

The IDs of the security groups.

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

Definition at line 327 of file RunInstancesRequest.h.

GetSecurityGroups()

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

inline

[Default VPC] The names of the security groups.

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

Default: Amazon EC2 uses the default security group.

Definition at line 354 of file RunInstancesRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 52 of file RunInstancesRequest.h.

GetSubnetId()

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

inline

The ID of the subnet to launch the instance into.

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

Definition at line 380 of file RunInstancesRequest.h.

GetTagSpecifications()

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

inline

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

You can specify tags for the following resources only:

• Instances

• Volumes

• Spot Instance requests

• Network interfaces

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

Definition at line 425 of file RunInstancesRequest.h.

GetUserData()

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

inline

The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data.

Definition at line 402 of file RunInstancesRequest.h.

HibernationOptionsHasBeenSet()

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

inline

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

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

Definition at line 567 of file RunInstancesRequest.h.

IamInstanceProfileHasBeenSet()

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

inline

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

Definition at line 942 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 93 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 837 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 473 of file RunInstancesRequest.h.

InstanceTypeHasBeenSet()

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

inline

The instance type. For more information, see Amazon EC2 Instance Types Guide.

Definition at line 113 of file RunInstancesRequest.h.

Ipv6AddressCountHasBeenSet()

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

inline

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 134 of file RunInstancesRequest.h.

Ipv6AddressesHasBeenSet()

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

inline

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 154 of file RunInstancesRequest.h.

KernelIdHasBeenSet()

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

inline

The ID of the kernel.

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

Definition at line 181 of file RunInstancesRequest.h.

KeyNameHasBeenSet()

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

inline

The name of the key pair. For more information, see Create a key pair for your EC2 instance.

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.

Definition at line 203 of file RunInstancesRequest.h.

LaunchTemplateHasBeenSet()

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

inline

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

Definition at line 452 of file RunInstancesRequest.h.

LicenseSpecificationsHasBeenSet()

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

inline

The license configurations.

Definition at line 585 of file RunInstancesRequest.h.

MaintenanceOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::MaintenanceOptionsHasBeenSet ( ) const

inline

The maintenance and recovery options for the instance.

Definition at line 671 of file RunInstancesRequest.h.

MaxCountHasBeenSet()

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

inline

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

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

Definition at line 227 of file RunInstancesRequest.h.

MetadataOptionsHasBeenSet()

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

inline

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options.

Definition at line 611 of file RunInstancesRequest.h.

MinCountHasBeenSet()

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

inline

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

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

Definition at line 249 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 265 of file RunInstancesRequest.h.

NetworkInterfacesHasBeenSet()

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

inline

The network interfaces to associate with the instance.

Definition at line 918 of file RunInstancesRequest.h.

NetworkPerformanceOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::NetworkPerformanceOptionsHasBeenSet ( ) const

inline

Contains settings for the network performance options for the instance.

Definition at line 736 of file RunInstancesRequest.h.

OperatorHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::OperatorHasBeenSet ( ) const

inline

Reserved for internal use.

Definition at line 754 of file RunInstancesRequest.h.

PlacementHasBeenSet()

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

inline

The placement for the instance.

Definition at line 283 of file RunInstancesRequest.h.

PrivateDnsNameOptionsHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::PrivateDnsNameOptionsHasBeenSet ( ) const

inline

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

Definition at line 653 of file RunInstancesRequest.h.

PrivateIpAddressHasBeenSet()

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

inline

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 859 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 Amazon Web Services Resource Center and search for the kernel ID.

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

Definition at line 308 of file RunInstancesRequest.h.

SecondaryInterfacesHasBeenSet()

bool Aws::EC2::Model::RunInstancesRequest::SecondaryInterfacesHasBeenSet ( ) const

inline

The secondary interfaces to associate with the instance.

Definition at line 772 of file RunInstancesRequest.h.

SecurityGroupIdsHasBeenSet()

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

inline

The IDs of the security groups.

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

Definition at line 328 of file RunInstancesRequest.h.

SecurityGroupsHasBeenSet()

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

inline

[Default VPC] The names of the security groups.

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

Default: Amazon EC2 uses the default security group.

Definition at line 355 of file RunInstancesRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetAdditionalInfo()

template<typename AdditionalInfoT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetAdditionalInfo ( AdditionalInfoT &&  value)

inline

Reserved.

Definition at line 902 of file RunInstancesRequest.h.

SetBlockDeviceMappings()

template<typename BlockDeviceMappingsT = Aws::Vector<BlockDeviceMapping>>

void Aws::EC2::Model::RunInstancesRequest::SetBlockDeviceMappings ( BlockDeviceMappingsT &&  value)

inline

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

Definition at line 70 of file RunInstancesRequest.h.

SetCapacityReservationSpecification()

template<typename CapacityReservationSpecificationT = CapacityReservationSpecification>

void Aws::EC2::Model::RunInstancesRequest::SetCapacityReservationSpecification ( CapacityReservationSpecificationT &&  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, and tenancy).

Definition at line 544 of file RunInstancesRequest.h.

SetClientToken()

template<typename ClientTokenT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetClientToken ( ClientTokenT &&  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 in Amazon EC2 API requests.

Constraints: Maximum 64 ASCII characters

Definition at line 884 of file RunInstancesRequest.h.

SetCpuOptions()

template<typename CpuOptionsT = CpuOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetCpuOptions ( CpuOptionsT &&  value)

inline

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

Definition at line 522 of file RunInstancesRequest.h.

SetCreditSpecification()

template<typename CreditSpecificationT = CreditSpecificationRequest>

void Aws::EC2::Model::RunInstancesRequest::SetCreditSpecification ( CreditSpecificationT &&  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 EC2 User Guide.

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

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

Definition at line 502 of file RunInstancesRequest.h.

SetDisableApiStop()

void Aws::EC2::Model::RunInstancesRequest::SetDisableApiStop ( bool  value)

inline

Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances.

Definition at line 693 of file RunInstancesRequest.h.

SetDisableApiTermination()

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

inline

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Definition at line 820 of file RunInstancesRequest.h.

SetDryRun()

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

inline

Checks whether you have the required permissions for the operation, 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 800 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 966 of file RunInstancesRequest.h.

SetEnablePrimaryIpv6()

void Aws::EC2::Model::RunInstancesRequest::SetEnablePrimaryIpv6 ( bool  value)

inline

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

Definition at line 721 of file RunInstancesRequest.h.

SetEnclaveOptions()

template<typename EnclaveOptionsT = EnclaveOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetEnclaveOptions ( EnclaveOptionsT &&  value)

inline

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

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

Definition at line 635 of file RunInstancesRequest.h.

SetHibernationOptions()

template<typename HibernationOptionsT = HibernationOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetHibernationOptions ( HibernationOptionsT &&  value)

inline

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

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

Definition at line 569 of file RunInstancesRequest.h.

SetIamInstanceProfile()

template<typename IamInstanceProfileT = IamInstanceProfileSpecification>

void Aws::EC2::Model::RunInstancesRequest::SetIamInstanceProfile ( IamInstanceProfileT &&  value)

inline

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

Definition at line 944 of file RunInstancesRequest.h.

SetImageId()

template<typename ImageIdT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetImageId ( ImageIdT &&  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 95 of file RunInstancesRequest.h.

SetInstanceInitiatedShutdownBehavior()

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 838 of file RunInstancesRequest.h.

SetInstanceMarketOptions()

template<typename InstanceMarketOptionsT = InstanceMarketOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetInstanceMarketOptions ( InstanceMarketOptionsT &&  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 475 of file RunInstancesRequest.h.

SetInstanceType()

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

inline

The instance type. For more information, see Amazon EC2 Instance Types Guide.

Definition at line 114 of file RunInstancesRequest.h.

SetIpv6AddressCount()

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

inline

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 135 of file RunInstancesRequest.h.

SetIpv6Addresses()

template<typename Ipv6AddressesT = Aws::Vector<InstanceIpv6Address>>

void Aws::EC2::Model::RunInstancesRequest::SetIpv6Addresses ( Ipv6AddressesT &&  value)

inline

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 156 of file RunInstancesRequest.h.

SetKernelId()

template<typename KernelIdT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetKernelId ( KernelIdT &&  value)

inline

The ID of the kernel.

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

Definition at line 183 of file RunInstancesRequest.h.

SetKeyName()

template<typename KeyNameT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetKeyName ( KeyNameT &&  value)

inline

The name of the key pair. For more information, see Create a key pair for your EC2 instance.

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.

Definition at line 205 of file RunInstancesRequest.h.

SetLaunchTemplate()

template<typename LaunchTemplateT = LaunchTemplateSpecification>

void Aws::EC2::Model::RunInstancesRequest::SetLaunchTemplate ( LaunchTemplateT &&  value)

inline

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

Definition at line 454 of file RunInstancesRequest.h.

SetLicenseSpecifications()

template<typename LicenseSpecificationsT = Aws::Vector<LicenseConfigurationRequest>>

void Aws::EC2::Model::RunInstancesRequest::SetLicenseSpecifications ( LicenseSpecificationsT &&  value)

inline

The license configurations.

Definition at line 587 of file RunInstancesRequest.h.

SetMaintenanceOptions()

template<typename MaintenanceOptionsT = InstanceMaintenanceOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetMaintenanceOptions ( MaintenanceOptionsT &&  value)

inline

The maintenance and recovery options for the instance.

Definition at line 673 of file RunInstancesRequest.h.

SetMaxCount()

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

inline

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

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

Definition at line 228 of file RunInstancesRequest.h.

SetMetadataOptions()

template<typename MetadataOptionsT = InstanceMetadataOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetMetadataOptions ( MetadataOptionsT &&  value)

inline

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options.

Definition at line 613 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 value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.

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

Definition at line 250 of file RunInstancesRequest.h.

SetMonitoring()

template<typename MonitoringT = RunInstancesMonitoringEnabled>

void Aws::EC2::Model::RunInstancesRequest::SetMonitoring ( MonitoringT &&  value)

inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 267 of file RunInstancesRequest.h.

SetNetworkInterfaces()

template<typename NetworkInterfacesT = Aws::Vector<InstanceNetworkInterfaceSpecification>>

void Aws::EC2::Model::RunInstancesRequest::SetNetworkInterfaces ( NetworkInterfacesT &&  value)

inline

The network interfaces to associate with the instance.

Definition at line 920 of file RunInstancesRequest.h.

SetNetworkPerformanceOptions()

template<typename NetworkPerformanceOptionsT = InstanceNetworkPerformanceOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetNetworkPerformanceOptions ( NetworkPerformanceOptionsT &&  value)

inline

Contains settings for the network performance options for the instance.

Definition at line 738 of file RunInstancesRequest.h.

SetOperator()

template<typename OperatorT = OperatorRequest>

void Aws::EC2::Model::RunInstancesRequest::SetOperator ( OperatorT &&  value)

inline

Reserved for internal use.

Definition at line 756 of file RunInstancesRequest.h.

SetPlacement()

template<typename PlacementT = Placement>

void Aws::EC2::Model::RunInstancesRequest::SetPlacement ( PlacementT &&  value)

inline

The placement for the instance.

Definition at line 285 of file RunInstancesRequest.h.

SetPrivateDnsNameOptions()

template<typename PrivateDnsNameOptionsT = PrivateDnsNameOptionsRequest>

void Aws::EC2::Model::RunInstancesRequest::SetPrivateDnsNameOptions ( PrivateDnsNameOptionsT &&  value)

inline

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

Definition at line 655 of file RunInstancesRequest.h.

SetPrivateIpAddress()

template<typename PrivateIpAddressT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetPrivateIpAddress ( PrivateIpAddressT &&  value)

inline

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 861 of file RunInstancesRequest.h.

SetRamdiskId()

template<typename RamdiskIdT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetRamdiskId ( RamdiskIdT &&  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 Amazon Web Services Resource Center and search for the kernel ID.

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

Definition at line 310 of file RunInstancesRequest.h.

SetSecondaryInterfaces()

template<typename SecondaryInterfacesT = Aws::Vector<InstanceSecondaryInterfaceSpecificationRequest>>

void Aws::EC2::Model::RunInstancesRequest::SetSecondaryInterfaces ( SecondaryInterfacesT &&  value)

inline

The secondary interfaces to associate with the instance.

Definition at line 774 of file RunInstancesRequest.h.

SetSecurityGroupIds()

template<typename SecurityGroupIdsT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroupIds ( SecurityGroupIdsT &&  value)

inline

The IDs of the security groups.

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

Definition at line 330 of file RunInstancesRequest.h.

SetSecurityGroups()

template<typename SecurityGroupsT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::RunInstancesRequest::SetSecurityGroups ( SecurityGroupsT &&  value)

inline

[Default VPC] The names of the security groups.

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

Default: Amazon EC2 uses the default security group.

Definition at line 357 of file RunInstancesRequest.h.

SetSubnetId()

template<typename SubnetIdT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetSubnetId ( SubnetIdT &&  value)

inline

The ID of the subnet to launch the instance into.

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

Definition at line 383 of file RunInstancesRequest.h.

SetTagSpecifications()

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

void Aws::EC2::Model::RunInstancesRequest::SetTagSpecifications ( TagSpecificationsT &&  value)

inline

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

You can specify tags for the following resources only:

• Instances

• Volumes

• Spot Instance requests

• Network interfaces

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

Definition at line 428 of file RunInstancesRequest.h.

SetUserData()

template<typename UserDataT = Aws::String>

void Aws::EC2::Model::RunInstancesRequest::SetUserData ( UserDataT &&  value)

inline

The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data.

Definition at line 405 of file RunInstancesRequest.h.

SubnetIdHasBeenSet()

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

inline

The ID of the subnet to launch the instance into.

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

Definition at line 381 of file RunInstancesRequest.h.

TagSpecificationsHasBeenSet()

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

inline

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

You can specify tags for the following resources only:

• Instances

• Volumes

• Spot Instance requests

• Network interfaces

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

Definition at line 426 of file RunInstancesRequest.h.

UserDataHasBeenSet()

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

inline

The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data.

Definition at line 403 of file RunInstancesRequest.h.

WithAdditionalInfo()

template<typename AdditionalInfoT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithAdditionalInfo ( AdditionalInfoT &&  value)

inline

Reserved.

Definition at line 907 of file RunInstancesRequest.h.

WithBlockDeviceMappings()

template<typename BlockDeviceMappingsT = Aws::Vector<BlockDeviceMapping>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithBlockDeviceMappings ( BlockDeviceMappingsT &&  value)

inline

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

Definition at line 75 of file RunInstancesRequest.h.

WithCapacityReservationSpecification()

template<typename CapacityReservationSpecificationT = CapacityReservationSpecification>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithCapacityReservationSpecification ( CapacityReservationSpecificationT &&  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, and tenancy).

Definition at line 549 of file RunInstancesRequest.h.

WithClientToken()

template<typename ClientTokenT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithClientToken ( ClientTokenT &&  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 in Amazon EC2 API requests.

Constraints: Maximum 64 ASCII characters

Definition at line 889 of file RunInstancesRequest.h.

WithCpuOptions()

template<typename CpuOptionsT = CpuOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithCpuOptions ( CpuOptionsT &&  value)

inline

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

Definition at line 527 of file RunInstancesRequest.h.

WithCreditSpecification()

template<typename CreditSpecificationT = CreditSpecificationRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithCreditSpecification ( CreditSpecificationT &&  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 EC2 User Guide.

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

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

Definition at line 507 of file RunInstancesRequest.h.

WithDisableApiStop()

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithDisableApiStop ( bool  value)

inline

Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances.

Definition at line 697 of file RunInstancesRequest.h.

WithDisableApiTermination()

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

inline

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Definition at line 824 of file RunInstancesRequest.h.

WithDryRun()

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

inline

Checks whether you have the required permissions for the operation, 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 804 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 970 of file RunInstancesRequest.h.

WithEnablePrimaryIpv6()

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithEnablePrimaryIpv6 ( bool  value)

inline

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

Definition at line 725 of file RunInstancesRequest.h.

WithEnclaveOptions()

template<typename EnclaveOptionsT = EnclaveOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithEnclaveOptions ( EnclaveOptionsT &&  value)

inline

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

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

Definition at line 640 of file RunInstancesRequest.h.

WithHibernationOptions()

template<typename HibernationOptionsT = HibernationOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithHibernationOptions ( HibernationOptionsT &&  value)

inline

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

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

Definition at line 574 of file RunInstancesRequest.h.

WithIamInstanceProfile()

template<typename IamInstanceProfileT = IamInstanceProfileSpecification>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithIamInstanceProfile ( IamInstanceProfileT &&  value)

inline

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

Definition at line 949 of file RunInstancesRequest.h.

WithImageId()

template<typename ImageIdT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithImageId ( ImageIdT &&  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 100 of file RunInstancesRequest.h.

WithInstanceInitiatedShutdownBehavior()

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 842 of file RunInstancesRequest.h.

WithInstanceMarketOptions()

template<typename InstanceMarketOptionsT = InstanceMarketOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithInstanceMarketOptions ( InstanceMarketOptionsT &&  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 480 of file RunInstancesRequest.h.

WithInstanceType()

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

inline

The instance type. For more information, see Amazon EC2 Instance Types Guide.

Definition at line 118 of file RunInstancesRequest.h.

WithIpv6AddressCount()

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

inline

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 139 of file RunInstancesRequest.h.

WithIpv6Addresses()

template<typename Ipv6AddressesT = Aws::Vector<InstanceIpv6Address>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithIpv6Addresses ( Ipv6AddressesT &&  value)

inline

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 161 of file RunInstancesRequest.h.

WithKernelId()

template<typename KernelIdT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithKernelId ( KernelIdT &&  value)

inline

The ID of the kernel.

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

Definition at line 188 of file RunInstancesRequest.h.

WithKeyName()

template<typename KeyNameT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithKeyName ( KeyNameT &&  value)

inline

The name of the key pair. For more information, see Create a key pair for your EC2 instance.

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.

Definition at line 210 of file RunInstancesRequest.h.

WithLaunchTemplate()

template<typename LaunchTemplateT = LaunchTemplateSpecification>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithLaunchTemplate ( LaunchTemplateT &&  value)

inline

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

Definition at line 459 of file RunInstancesRequest.h.

WithLicenseSpecifications()

template<typename LicenseSpecificationsT = Aws::Vector<LicenseConfigurationRequest>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithLicenseSpecifications ( LicenseSpecificationsT &&  value)

inline

The license configurations.

Definition at line 592 of file RunInstancesRequest.h.

WithMaintenanceOptions()

template<typename MaintenanceOptionsT = InstanceMaintenanceOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithMaintenanceOptions ( MaintenanceOptionsT &&  value)

inline

The maintenance and recovery options for the instance.

Definition at line 678 of file RunInstancesRequest.h.

WithMaxCount()

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

inline

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

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

Definition at line 232 of file RunInstancesRequest.h.

WithMetadataOptions()

template<typename MetadataOptionsT = InstanceMetadataOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithMetadataOptions ( MetadataOptionsT &&  value)

inline

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options.

Definition at line 618 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 value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.

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

Definition at line 254 of file RunInstancesRequest.h.

WithMonitoring()

template<typename MonitoringT = RunInstancesMonitoringEnabled>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithMonitoring ( MonitoringT &&  value)

inline

Specifies whether detailed monitoring is enabled for the instance.

Definition at line 272 of file RunInstancesRequest.h.

WithNetworkInterfaces()

template<typename NetworkInterfacesT = Aws::Vector<InstanceNetworkInterfaceSpecification>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithNetworkInterfaces ( NetworkInterfacesT &&  value)

inline

The network interfaces to associate with the instance.

Definition at line 925 of file RunInstancesRequest.h.

WithNetworkPerformanceOptions()

template<typename NetworkPerformanceOptionsT = InstanceNetworkPerformanceOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithNetworkPerformanceOptions ( NetworkPerformanceOptionsT &&  value)

inline

Contains settings for the network performance options for the instance.

Definition at line 743 of file RunInstancesRequest.h.

WithOperator()

template<typename OperatorT = OperatorRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithOperator ( OperatorT &&  value)

inline

Reserved for internal use.

Definition at line 761 of file RunInstancesRequest.h.

WithPlacement()

template<typename PlacementT = Placement>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithPlacement ( PlacementT &&  value)

inline

The placement for the instance.

Definition at line 290 of file RunInstancesRequest.h.

WithPrivateDnsNameOptions()

template<typename PrivateDnsNameOptionsT = PrivateDnsNameOptionsRequest>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithPrivateDnsNameOptions ( PrivateDnsNameOptionsT &&  value)

inline

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

Definition at line 660 of file RunInstancesRequest.h.

WithPrivateIpAddress()

template<typename PrivateIpAddressT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithPrivateIpAddress ( PrivateIpAddressT &&  value)

inline

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 866 of file RunInstancesRequest.h.

WithRamdiskId()

template<typename RamdiskIdT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithRamdiskId ( RamdiskIdT &&  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 Amazon Web Services Resource Center and search for the kernel ID.

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

Definition at line 315 of file RunInstancesRequest.h.

WithSecondaryInterfaces()

template<typename SecondaryInterfacesT = Aws::Vector<InstanceSecondaryInterfaceSpecificationRequest>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithSecondaryInterfaces ( SecondaryInterfacesT &&  value)

inline

The secondary interfaces to associate with the instance.

Definition at line 779 of file RunInstancesRequest.h.

WithSecurityGroupIds()

template<typename SecurityGroupIdsT = Aws::Vector<Aws::String>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithSecurityGroupIds ( SecurityGroupIdsT &&  value)

inline

The IDs of the security groups.

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

Definition at line 335 of file RunInstancesRequest.h.

WithSecurityGroups()

template<typename SecurityGroupsT = Aws::Vector<Aws::String>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithSecurityGroups ( SecurityGroupsT &&  value)

inline

[Default VPC] The names of the security groups.

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

Default: Amazon EC2 uses the default security group.

Definition at line 362 of file RunInstancesRequest.h.

WithSubnetId()

template<typename SubnetIdT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithSubnetId ( SubnetIdT &&  value)

inline

The ID of the subnet to launch the instance into.

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

Definition at line 388 of file RunInstancesRequest.h.

WithTagSpecifications()

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithTagSpecifications ( TagSpecificationsT &&  value)

inline

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

You can specify tags for the following resources only:

• Instances

• Volumes

• Spot Instance requests

• Network interfaces

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

Definition at line 433 of file RunInstancesRequest.h.

WithUserData()

template<typename UserDataT = Aws::String>

RunInstancesRequest & Aws::EC2::Model::RunInstancesRequest::WithUserData ( UserDataT &&  value)

inline

The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data.

Definition at line 410 of file RunInstancesRequest.h.

---

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

• generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/RunInstancesRequest.h