AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::InstanceNetworkInterfaceSpecification Class Reference

#include <InstanceNetworkInterfaceSpecification.h>

Public Member Functions

 InstanceNetworkInterfaceSpecification ()
 
 InstanceNetworkInterfaceSpecification (const Aws::Utils::Xml::XmlNode &xmlNode)
 
InstanceNetworkInterfaceSpecificationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
bool GetAssociatePublicIpAddress () const
 
bool AssociatePublicIpAddressHasBeenSet () const
 
void SetAssociatePublicIpAddress (bool value)
 
InstanceNetworkInterfaceSpecificationWithAssociatePublicIpAddress (bool value)
 
bool GetDeleteOnTermination () const
 
bool DeleteOnTerminationHasBeenSet () const
 
void SetDeleteOnTermination (bool value)
 
InstanceNetworkInterfaceSpecificationWithDeleteOnTermination (bool value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
InstanceNetworkInterfaceSpecificationWithDescription (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationWithDescription (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationWithDescription (const char *value)
 
int GetDeviceIndex () const
 
bool DeviceIndexHasBeenSet () const
 
void SetDeviceIndex (int value)
 
InstanceNetworkInterfaceSpecificationWithDeviceIndex (int value)
 
const Aws::Vector< Aws::String > & GetGroups () const
 
bool GroupsHasBeenSet () const
 
void SetGroups (const Aws::Vector< Aws::String > &value)
 
void SetGroups (Aws::Vector< Aws::String > &&value)
 
InstanceNetworkInterfaceSpecificationWithGroups (const Aws::Vector< Aws::String > &value)
 
InstanceNetworkInterfaceSpecificationWithGroups (Aws::Vector< Aws::String > &&value)
 
InstanceNetworkInterfaceSpecificationAddGroups (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationAddGroups (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationAddGroups (const char *value)
 
int GetIpv6AddressCount () const
 
bool Ipv6AddressCountHasBeenSet () const
 
void SetIpv6AddressCount (int value)
 
InstanceNetworkInterfaceSpecificationWithIpv6AddressCount (int value)
 
const Aws::Vector< InstanceIpv6Address > & GetIpv6Addresses () const
 
bool Ipv6AddressesHasBeenSet () const
 
void SetIpv6Addresses (const Aws::Vector< InstanceIpv6Address > &value)
 
void SetIpv6Addresses (Aws::Vector< InstanceIpv6Address > &&value)
 
InstanceNetworkInterfaceSpecificationWithIpv6Addresses (const Aws::Vector< InstanceIpv6Address > &value)
 
InstanceNetworkInterfaceSpecificationWithIpv6Addresses (Aws::Vector< InstanceIpv6Address > &&value)
 
InstanceNetworkInterfaceSpecificationAddIpv6Addresses (const InstanceIpv6Address &value)
 
InstanceNetworkInterfaceSpecificationAddIpv6Addresses (InstanceIpv6Address &&value)
 
const Aws::StringGetNetworkInterfaceId () const
 
bool NetworkInterfaceIdHasBeenSet () const
 
void SetNetworkInterfaceId (const Aws::String &value)
 
void SetNetworkInterfaceId (Aws::String &&value)
 
void SetNetworkInterfaceId (const char *value)
 
InstanceNetworkInterfaceSpecificationWithNetworkInterfaceId (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationWithNetworkInterfaceId (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationWithNetworkInterfaceId (const char *value)
 
const Aws::StringGetPrivateIpAddress () const
 
bool PrivateIpAddressHasBeenSet () const
 
void SetPrivateIpAddress (const Aws::String &value)
 
void SetPrivateIpAddress (Aws::String &&value)
 
void SetPrivateIpAddress (const char *value)
 
InstanceNetworkInterfaceSpecificationWithPrivateIpAddress (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationWithPrivateIpAddress (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationWithPrivateIpAddress (const char *value)
 
const Aws::Vector< PrivateIpAddressSpecification > & GetPrivateIpAddresses () const
 
bool PrivateIpAddressesHasBeenSet () const
 
void SetPrivateIpAddresses (const Aws::Vector< PrivateIpAddressSpecification > &value)
 
void SetPrivateIpAddresses (Aws::Vector< PrivateIpAddressSpecification > &&value)
 
InstanceNetworkInterfaceSpecificationWithPrivateIpAddresses (const Aws::Vector< PrivateIpAddressSpecification > &value)
 
InstanceNetworkInterfaceSpecificationWithPrivateIpAddresses (Aws::Vector< PrivateIpAddressSpecification > &&value)
 
InstanceNetworkInterfaceSpecificationAddPrivateIpAddresses (const PrivateIpAddressSpecification &value)
 
InstanceNetworkInterfaceSpecificationAddPrivateIpAddresses (PrivateIpAddressSpecification &&value)
 
int GetSecondaryPrivateIpAddressCount () const
 
bool SecondaryPrivateIpAddressCountHasBeenSet () const
 
void SetSecondaryPrivateIpAddressCount (int value)
 
InstanceNetworkInterfaceSpecificationWithSecondaryPrivateIpAddressCount (int value)
 
const Aws::StringGetSubnetId () const
 
bool SubnetIdHasBeenSet () const
 
void SetSubnetId (const Aws::String &value)
 
void SetSubnetId (Aws::String &&value)
 
void SetSubnetId (const char *value)
 
InstanceNetworkInterfaceSpecificationWithSubnetId (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationWithSubnetId (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationWithSubnetId (const char *value)
 
bool GetAssociateCarrierIpAddress () const
 
bool AssociateCarrierIpAddressHasBeenSet () const
 
void SetAssociateCarrierIpAddress (bool value)
 
InstanceNetworkInterfaceSpecificationWithAssociateCarrierIpAddress (bool value)
 
const Aws::StringGetInterfaceType () const
 
bool InterfaceTypeHasBeenSet () const
 
void SetInterfaceType (const Aws::String &value)
 
void SetInterfaceType (Aws::String &&value)
 
void SetInterfaceType (const char *value)
 
InstanceNetworkInterfaceSpecificationWithInterfaceType (const Aws::String &value)
 
InstanceNetworkInterfaceSpecificationWithInterfaceType (Aws::String &&value)
 
InstanceNetworkInterfaceSpecificationWithInterfaceType (const char *value)
 
int GetNetworkCardIndex () const
 
bool NetworkCardIndexHasBeenSet () const
 
void SetNetworkCardIndex (int value)
 
InstanceNetworkInterfaceSpecificationWithNetworkCardIndex (int value)
 

Detailed Description

Describes a network interface.

See Also:

AWS API Reference

Definition at line 34 of file InstanceNetworkInterfaceSpecification.h.

Constructor & Destructor Documentation

◆ InstanceNetworkInterfaceSpecification() [1/2]

Aws::EC2::Model::InstanceNetworkInterfaceSpecification::InstanceNetworkInterfaceSpecification ( )

◆ InstanceNetworkInterfaceSpecification() [2/2]

Aws::EC2::Model::InstanceNetworkInterfaceSpecification::InstanceNetworkInterfaceSpecification ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddGroups() [1/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AddGroups ( Aws::String &&  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 235 of file InstanceNetworkInterfaceSpecification.h.

◆ AddGroups() [2/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AddGroups ( const Aws::String value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 229 of file InstanceNetworkInterfaceSpecification.h.

◆ AddGroups() [3/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AddGroups ( const char *  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 241 of file InstanceNetworkInterfaceSpecification.h.

◆ AddIpv6Addresses() [1/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 335 of file InstanceNetworkInterfaceSpecification.h.

◆ AddIpv6Addresses() [2/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 343 of file InstanceNetworkInterfaceSpecification.h.

◆ AddPrivateIpAddresses() [1/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AddPrivateIpAddresses ( const PrivateIpAddressSpecification value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 537 of file InstanceNetworkInterfaceSpecification.h.

◆ AddPrivateIpAddresses() [2/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AddPrivateIpAddresses ( PrivateIpAddressSpecification &&  value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 546 of file InstanceNetworkInterfaceSpecification.h.

◆ AssociateCarrierIpAddressHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AssociateCarrierIpAddressHasBeenSet ( ) const
inline

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

Definition at line 655 of file InstanceNetworkInterfaceSpecification.h.

◆ AssociatePublicIpAddressHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::AssociatePublicIpAddressHasBeenSet ( ) const
inline

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Definition at line 61 of file InstanceNetworkInterfaceSpecification.h.

◆ DeleteOnTerminationHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::DeleteOnTerminationHasBeenSet ( ) const
inline

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Definition at line 94 of file InstanceNetworkInterfaceSpecification.h.

◆ DescriptionHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::DescriptionHasBeenSet ( ) const
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 121 of file InstanceNetworkInterfaceSpecification.h.

◆ DeviceIndexHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::DeviceIndexHasBeenSet ( ) const
inline

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

Definition at line 172 of file InstanceNetworkInterfaceSpecification.h.

◆ GetAssociateCarrierIpAddress()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetAssociateCarrierIpAddress ( ) const
inline

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

Definition at line 646 of file InstanceNetworkInterfaceSpecification.h.

◆ GetAssociatePublicIpAddress()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetAssociatePublicIpAddress ( ) const
inline

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Definition at line 52 of file InstanceNetworkInterfaceSpecification.h.

◆ GetDeleteOnTermination()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetDeleteOnTermination ( ) const
inline

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Definition at line 87 of file InstanceNetworkInterfaceSpecification.h.

◆ GetDescription()

const Aws::String& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetDescription ( ) const
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 115 of file InstanceNetworkInterfaceSpecification.h.

◆ GetDeviceIndex()

int Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetDeviceIndex ( ) const
inline

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

Definition at line 165 of file InstanceNetworkInterfaceSpecification.h.

◆ GetGroups()

const Aws::Vector<Aws::String>& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetGroups ( ) const
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 193 of file InstanceNetworkInterfaceSpecification.h.

◆ GetInterfaceType()

const Aws::String& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetInterfaceType ( ) const
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 684 of file InstanceNetworkInterfaceSpecification.h.

◆ GetIpv6AddressCount()

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

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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.

Definition at line 251 of file InstanceNetworkInterfaceSpecification.h.

◆ GetIpv6Addresses()

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

One or more IPv6 addresses to assign to the 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.

Definition at line 287 of file InstanceNetworkInterfaceSpecification.h.

◆ GetNetworkCardIndex()

int Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetNetworkCardIndex ( ) const
inline

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

Definition at line 762 of file InstanceNetworkInterfaceSpecification.h.

◆ GetNetworkInterfaceId()

const Aws::String& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetNetworkInterfaceId ( ) const
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 351 of file InstanceNetworkInterfaceSpecification.h.

◆ GetPrivateIpAddress()

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 410 of file InstanceNetworkInterfaceSpecification.h.

◆ GetPrivateIpAddresses()

const Aws::Vector<PrivateIpAddressSpecification>& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetPrivateIpAddresses ( ) const
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 483 of file InstanceNetworkInterfaceSpecification.h.

◆ GetSecondaryPrivateIpAddressCount()

int Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GetSecondaryPrivateIpAddressCount ( ) const
inline

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 557 of file InstanceNetworkInterfaceSpecification.h.

◆ GetSubnetId()

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 594 of file InstanceNetworkInterfaceSpecification.h.

◆ GroupsHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::GroupsHasBeenSet ( ) const
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 199 of file InstanceNetworkInterfaceSpecification.h.

◆ InterfaceTypeHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::InterfaceTypeHasBeenSet ( ) const
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 694 of file InstanceNetworkInterfaceSpecification.h.

◆ Ipv6AddressCountHasBeenSet()

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

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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.

Definition at line 260 of file InstanceNetworkInterfaceSpecification.h.

◆ Ipv6AddressesHasBeenSet()

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

One or more IPv6 addresses to assign to the 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.

Definition at line 295 of file InstanceNetworkInterfaceSpecification.h.

◆ NetworkCardIndexHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::NetworkCardIndexHasBeenSet ( ) const
inline

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

Definition at line 769 of file InstanceNetworkInterfaceSpecification.h.

◆ NetworkInterfaceIdHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::NetworkInterfaceIdHasBeenSet ( ) const
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 358 of file InstanceNetworkInterfaceSpecification.h.

◆ operator=()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PrivateIpAddressesHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::PrivateIpAddressesHasBeenSet ( ) const
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 492 of file InstanceNetworkInterfaceSpecification.h.

◆ PrivateIpAddressHasBeenSet()

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 419 of file InstanceNetworkInterfaceSpecification.h.

◆ SecondaryPrivateIpAddressCountHasBeenSet()

bool Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SecondaryPrivateIpAddressCountHasBeenSet ( ) const
inline

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 567 of file InstanceNetworkInterfaceSpecification.h.

◆ SetAssociateCarrierIpAddress()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetAssociateCarrierIpAddress ( bool  value)
inline

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

Definition at line 664 of file InstanceNetworkInterfaceSpecification.h.

◆ SetAssociatePublicIpAddress()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetAssociatePublicIpAddress ( bool  value)
inline

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Definition at line 70 of file InstanceNetworkInterfaceSpecification.h.

◆ SetDeleteOnTermination()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetDeleteOnTermination ( bool  value)
inline

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Definition at line 101 of file InstanceNetworkInterfaceSpecification.h.

◆ SetDescription() [1/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetDescription ( Aws::String &&  value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 133 of file InstanceNetworkInterfaceSpecification.h.

◆ SetDescription() [2/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetDescription ( const Aws::String value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 127 of file InstanceNetworkInterfaceSpecification.h.

◆ SetDescription() [3/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetDescription ( const char *  value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 139 of file InstanceNetworkInterfaceSpecification.h.

◆ SetDeviceIndex()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetDeviceIndex ( int  value)
inline

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

Definition at line 179 of file InstanceNetworkInterfaceSpecification.h.

◆ SetGroups() [1/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetGroups ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 211 of file InstanceNetworkInterfaceSpecification.h.

◆ SetGroups() [2/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetGroups ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 205 of file InstanceNetworkInterfaceSpecification.h.

◆ SetInterfaceType() [1/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetInterfaceType ( Aws::String &&  value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 714 of file InstanceNetworkInterfaceSpecification.h.

◆ SetInterfaceType() [2/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetInterfaceType ( const Aws::String value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 704 of file InstanceNetworkInterfaceSpecification.h.

◆ SetInterfaceType() [3/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetInterfaceType ( const char *  value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 724 of file InstanceNetworkInterfaceSpecification.h.

◆ SetIpv6AddressCount()

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

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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.

Definition at line 269 of file InstanceNetworkInterfaceSpecification.h.

◆ SetIpv6Addresses() [1/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 311 of file InstanceNetworkInterfaceSpecification.h.

◆ SetIpv6Addresses() [2/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 303 of file InstanceNetworkInterfaceSpecification.h.

◆ SetNetworkCardIndex()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetNetworkCardIndex ( int  value)
inline

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

Definition at line 776 of file InstanceNetworkInterfaceSpecification.h.

◆ SetNetworkInterfaceId() [1/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetNetworkInterfaceId ( Aws::String &&  value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 372 of file InstanceNetworkInterfaceSpecification.h.

◆ SetNetworkInterfaceId() [2/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetNetworkInterfaceId ( const Aws::String value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 365 of file InstanceNetworkInterfaceSpecification.h.

◆ SetNetworkInterfaceId() [3/3]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetNetworkInterfaceId ( const char *  value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 379 of file InstanceNetworkInterfaceSpecification.h.

◆ SetPrivateIpAddress() [1/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 437 of file InstanceNetworkInterfaceSpecification.h.

◆ SetPrivateIpAddress() [2/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 428 of file InstanceNetworkInterfaceSpecification.h.

◆ SetPrivateIpAddress() [3/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 446 of file InstanceNetworkInterfaceSpecification.h.

◆ SetPrivateIpAddresses() [1/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetPrivateIpAddresses ( Aws::Vector< PrivateIpAddressSpecification > &&  value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 510 of file InstanceNetworkInterfaceSpecification.h.

◆ SetPrivateIpAddresses() [2/2]

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetPrivateIpAddresses ( const Aws::Vector< PrivateIpAddressSpecification > &  value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 501 of file InstanceNetworkInterfaceSpecification.h.

◆ SetSecondaryPrivateIpAddressCount()

void Aws::EC2::Model::InstanceNetworkInterfaceSpecification::SetSecondaryPrivateIpAddressCount ( int  value)
inline

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 577 of file InstanceNetworkInterfaceSpecification.h.

◆ SetSubnetId() [1/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 612 of file InstanceNetworkInterfaceSpecification.h.

◆ SetSubnetId() [2/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 606 of file InstanceNetworkInterfaceSpecification.h.

◆ SetSubnetId() [3/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 618 of file InstanceNetworkInterfaceSpecification.h.

◆ SubnetIdHasBeenSet()

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 600 of file InstanceNetworkInterfaceSpecification.h.

◆ WithAssociateCarrierIpAddress()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithAssociateCarrierIpAddress ( bool  value)
inline

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

Definition at line 673 of file InstanceNetworkInterfaceSpecification.h.

◆ WithAssociatePublicIpAddress()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithAssociatePublicIpAddress ( bool  value)
inline

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Definition at line 79 of file InstanceNetworkInterfaceSpecification.h.

◆ WithDeleteOnTermination()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithDeleteOnTermination ( bool  value)
inline

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Definition at line 108 of file InstanceNetworkInterfaceSpecification.h.

◆ WithDescription() [1/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithDescription ( Aws::String &&  value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 151 of file InstanceNetworkInterfaceSpecification.h.

◆ WithDescription() [2/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithDescription ( const Aws::String value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 145 of file InstanceNetworkInterfaceSpecification.h.

◆ WithDescription() [3/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithDescription ( const char *  value)
inline

The description of the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 157 of file InstanceNetworkInterfaceSpecification.h.

◆ WithDeviceIndex()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithDeviceIndex ( int  value)
inline

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

Definition at line 186 of file InstanceNetworkInterfaceSpecification.h.

◆ WithGroups() [1/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithGroups ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 223 of file InstanceNetworkInterfaceSpecification.h.

◆ WithGroups() [2/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithGroups ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 217 of file InstanceNetworkInterfaceSpecification.h.

◆ WithInterfaceType() [1/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithInterfaceType ( Aws::String &&  value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 744 of file InstanceNetworkInterfaceSpecification.h.

◆ WithInterfaceType() [2/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithInterfaceType ( const Aws::String value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 734 of file InstanceNetworkInterfaceSpecification.h.

◆ WithInterfaceType() [3/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithInterfaceType ( const char *  value)
inline

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Definition at line 754 of file InstanceNetworkInterfaceSpecification.h.

◆ WithIpv6AddressCount()

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

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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.

Definition at line 278 of file InstanceNetworkInterfaceSpecification.h.

◆ WithIpv6Addresses() [1/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 327 of file InstanceNetworkInterfaceSpecification.h.

◆ WithIpv6Addresses() [2/2]

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

One or more IPv6 addresses to assign to the 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.

Definition at line 319 of file InstanceNetworkInterfaceSpecification.h.

◆ WithNetworkCardIndex()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithNetworkCardIndex ( int  value)
inline

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

Definition at line 783 of file InstanceNetworkInterfaceSpecification.h.

◆ WithNetworkInterfaceId() [1/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithNetworkInterfaceId ( Aws::String &&  value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 393 of file InstanceNetworkInterfaceSpecification.h.

◆ WithNetworkInterfaceId() [2/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithNetworkInterfaceId ( const Aws::String value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 386 of file InstanceNetworkInterfaceSpecification.h.

◆ WithNetworkInterfaceId() [3/3]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithNetworkInterfaceId ( const char *  value)
inline

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

Definition at line 400 of file InstanceNetworkInterfaceSpecification.h.

◆ WithPrivateIpAddress() [1/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 464 of file InstanceNetworkInterfaceSpecification.h.

◆ WithPrivateIpAddress() [2/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 455 of file InstanceNetworkInterfaceSpecification.h.

◆ WithPrivateIpAddress() [3/3]

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

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 473 of file InstanceNetworkInterfaceSpecification.h.

◆ WithPrivateIpAddresses() [1/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithPrivateIpAddresses ( Aws::Vector< PrivateIpAddressSpecification > &&  value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 528 of file InstanceNetworkInterfaceSpecification.h.

◆ WithPrivateIpAddresses() [2/2]

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithPrivateIpAddresses ( const Aws::Vector< PrivateIpAddressSpecification > &  value)
inline

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 519 of file InstanceNetworkInterfaceSpecification.h.

◆ WithSecondaryPrivateIpAddressCount()

InstanceNetworkInterfaceSpecification& Aws::EC2::Model::InstanceNetworkInterfaceSpecification::WithSecondaryPrivateIpAddressCount ( int  value)
inline

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Definition at line 587 of file InstanceNetworkInterfaceSpecification.h.

◆ WithSubnetId() [1/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 630 of file InstanceNetworkInterfaceSpecification.h.

◆ WithSubnetId() [2/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 624 of file InstanceNetworkInterfaceSpecification.h.

◆ WithSubnetId() [3/3]

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

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Definition at line 636 of file InstanceNetworkInterfaceSpecification.h.


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