/AWS1/CL_EC2INSTNETWORKINTER03¶
Describes a network interface.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_ASSOCIATEPUBLICIPADDRESS TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
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.Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
IV_DELETEONTERMINATION TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
If set to
true, the interface is deleted when the instance is terminated. You can specifytrueonly if creating a new network interface when launching an instance.
IV_DESCRIPTION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The description of the network interface. Applies only if creating a network interface when launching an instance.
IV_DEVICEINDEX TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
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.
IT_GROUPS TYPE /AWS1/CL_EC2SECGRPIDSTRLIST_W=>TT_SECURITYGROUPIDSTRINGLIST TT_SECURITYGROUPIDSTRINGLIST¶
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
IV_IPV6ADDRESSCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
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.
IT_IPV6ADDRESSES TYPE /AWS1/CL_EC2INSTIPV6ADDRESS=>TT_INSTANCEIPV6ADDRESSLIST TT_INSTANCEIPV6ADDRESSLIST¶
The 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.
IV_NETWORKINTERFACEID TYPE /AWS1/EC2NETWORKINTERFACEID /AWS1/EC2NETWORKINTERFACEID¶
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.
IV_PRIVATEIPADDRESS TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
IT_PRIVATEIPADDRESSES TYPE /AWS1/CL_EC2PVTIPADDRESSSPEC=>TT_PRIVATEIPADDRESSSPECLIST TT_PRIVATEIPADDRESSSPECLIST¶
The 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.
IV_SECPRIVATEIPADDRESSCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
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.
IV_SUBNETID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
IV_ASSOCIATECARRIERIPADDRESS TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
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 address in the Amazon Web Services Wavelength Developer Guide.
IV_INTERFACETYPE TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The type of network interface.
Valid values:
interface|efa
IV_NETWORKCARDINDEX TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
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.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
IT_IPV4PREFIXES TYPE /AWS1/CL_EC2IPV4PREFIXSPECREQ=>TT_IPV4PREFIXLIST TT_IPV4PREFIXLIST¶
The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCountoption.
IV_IPV4PREFIXCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv4Prefixoption.
IT_IPV6PREFIXES TYPE /AWS1/CL_EC2IPV6PREFIXSPECREQ=>TT_IPV6PREFIXLIST TT_IPV6PREFIXLIST¶
The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCountoption.
IV_IPV6PREFIXCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv6Prefixoption.
IV_PRIMARYIPV6 TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
The primary IPv6 address of the network interface. 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. For more information about primary IPv6 addresses, see RunInstances.
IO_ENASRDSPECIFICATION TYPE REF TO /AWS1/CL_EC2ENASRDSPECREQUEST /AWS1/CL_EC2ENASRDSPECREQUEST¶
Specifies the ENA Express settings for the network interface that's attached to the instance.
IO_CONNECTIONTRACKINGSPEC TYPE REF TO /AWS1/CL_EC2CONNTRKSPECREQUEST /AWS1/CL_EC2CONNTRKSPECREQUEST¶
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
Queryable Attributes¶
AssociatePublicIpAddress¶
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.Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCIATEPUBLICIPADDRESS() |
Getter for ASSOCIATEPUBLICIPADDRESS, with configurable defau |
ASK_ASSOCIATEPUBLICIPADDRESS() |
Getter for ASSOCIATEPUBLICIPADDRESS w/ exceptions if field h |
HAS_ASSOCIATEPUBLICIPADDRESS() |
Determine if ASSOCIATEPUBLICIPADDRESS has a value |
DeleteOnTermination¶
If set to
true, the interface is deleted when the instance is terminated. You can specifytrueonly if creating a new network interface when launching an instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELETEONTERMINATION() |
Getter for DELETEONTERMINATION, with configurable default |
ASK_DELETEONTERMINATION() |
Getter for DELETEONTERMINATION w/ exceptions if field has no |
HAS_DELETEONTERMINATION() |
Determine if DELETEONTERMINATION has a value |
Description¶
The description of the network interface. Applies only if creating a network interface when launching an instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
DeviceIndex¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEVICEINDEX() |
Getter for DEVICEINDEX, with configurable default |
ASK_DEVICEINDEX() |
Getter for DEVICEINDEX w/ exceptions if field has no value |
HAS_DEVICEINDEX() |
Determine if DEVICEINDEX has a value |
Groups¶
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GROUPS() |
Getter for GROUPS, with configurable default |
ASK_GROUPS() |
Getter for GROUPS w/ exceptions if field has no value |
HAS_GROUPS() |
Determine if GROUPS has a value |
Ipv6AddressCount¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV6ADDRESSCOUNT() |
Getter for IPV6ADDRESSCOUNT, with configurable default |
ASK_IPV6ADDRESSCOUNT() |
Getter for IPV6ADDRESSCOUNT w/ exceptions if field has no va |
HAS_IPV6ADDRESSCOUNT() |
Determine if IPV6ADDRESSCOUNT has a value |
Ipv6Addresses¶
The 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV6ADDRESSES() |
Getter for IPV6ADDRESSES, with configurable default |
ASK_IPV6ADDRESSES() |
Getter for IPV6ADDRESSES w/ exceptions if field has no value |
HAS_IPV6ADDRESSES() |
Determine if IPV6ADDRESSES has a value |
NetworkInterfaceId¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKINTERFACEID() |
Getter for NETWORKINTERFACEID, with configurable default |
ASK_NETWORKINTERFACEID() |
Getter for NETWORKINTERFACEID w/ exceptions if field has no |
HAS_NETWORKINTERFACEID() |
Determine if NETWORKINTERFACEID has a value |
PrivateIpAddress¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVATEIPADDRESS() |
Getter for PRIVATEIPADDRESS, with configurable default |
ASK_PRIVATEIPADDRESS() |
Getter for PRIVATEIPADDRESS w/ exceptions if field has no va |
HAS_PRIVATEIPADDRESS() |
Determine if PRIVATEIPADDRESS has a value |
PrivateIpAddresses¶
The 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVATEIPADDRESSES() |
Getter for PRIVATEIPADDRESSES, with configurable default |
ASK_PRIVATEIPADDRESSES() |
Getter for PRIVATEIPADDRESSES w/ exceptions if field has no |
HAS_PRIVATEIPADDRESSES() |
Determine if PRIVATEIPADDRESSES has a value |
SecondaryPrivateIpAddressCount¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECPRIVATEIPADDRESSCOUNT() |
Getter for SECPRIVATEIPADDRESSCOUNT, with configurable defau |
ASK_SECPRIVATEIPADDRESSCOUNT() |
Getter for SECPRIVATEIPADDRESSCOUNT w/ exceptions if field h |
HAS_SECPRIVATEIPADDRESSCOUNT() |
Determine if SECPRIVATEIPADDRESSCOUNT has a value |
SubnetId¶
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBNETID() |
Getter for SUBNETID, with configurable default |
ASK_SUBNETID() |
Getter for SUBNETID w/ exceptions if field has no value |
HAS_SUBNETID() |
Determine if SUBNETID has a value |
AssociateCarrierIpAddress¶
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 address in the Amazon Web Services Wavelength Developer Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCCARRIERIPADDRESS() |
Getter for ASSOCIATECARRIERIPADDRESS, with configurable defa |
ASK_ASSOCCARRIERIPADDRESS() |
Getter for ASSOCIATECARRIERIPADDRESS w/ exceptions if field |
HAS_ASSOCCARRIERIPADDRESS() |
Determine if ASSOCIATECARRIERIPADDRESS has a value |
InterfaceType¶
The type of network interface.
Valid values:
interface|efa
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INTERFACETYPE() |
Getter for INTERFACETYPE, with configurable default |
ASK_INTERFACETYPE() |
Getter for INTERFACETYPE w/ exceptions if field has no value |
HAS_INTERFACETYPE() |
Determine if INTERFACETYPE has a value |
NetworkCardIndex¶
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.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKCARDINDEX() |
Getter for NETWORKCARDINDEX, with configurable default |
ASK_NETWORKCARDINDEX() |
Getter for NETWORKCARDINDEX w/ exceptions if field has no va |
HAS_NETWORKCARDINDEX() |
Determine if NETWORKCARDINDEX has a value |
Ipv4Prefixes¶
The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCountoption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV4PREFIXES() |
Getter for IPV4PREFIXES, with configurable default |
ASK_IPV4PREFIXES() |
Getter for IPV4PREFIXES w/ exceptions if field has no value |
HAS_IPV4PREFIXES() |
Determine if IPV4PREFIXES has a value |
Ipv4PrefixCount¶
The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv4Prefixoption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV4PREFIXCOUNT() |
Getter for IPV4PREFIXCOUNT, with configurable default |
ASK_IPV4PREFIXCOUNT() |
Getter for IPV4PREFIXCOUNT w/ exceptions if field has no val |
HAS_IPV4PREFIXCOUNT() |
Determine if IPV4PREFIXCOUNT has a value |
Ipv6Prefixes¶
The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCountoption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV6PREFIXES() |
Getter for IPV6PREFIXES, with configurable default |
ASK_IPV6PREFIXES() |
Getter for IPV6PREFIXES w/ exceptions if field has no value |
HAS_IPV6PREFIXES() |
Determine if IPV6PREFIXES has a value |
Ipv6PrefixCount¶
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv6Prefixoption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPV6PREFIXCOUNT() |
Getter for IPV6PREFIXCOUNT, with configurable default |
ASK_IPV6PREFIXCOUNT() |
Getter for IPV6PREFIXCOUNT w/ exceptions if field has no val |
HAS_IPV6PREFIXCOUNT() |
Determine if IPV6PREFIXCOUNT has a value |
PrimaryIpv6¶
The primary IPv6 address of the network interface. 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. For more information about primary IPv6 addresses, see RunInstances.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIMARYIPV6() |
Getter for PRIMARYIPV6, with configurable default |
ASK_PRIMARYIPV6() |
Getter for PRIMARYIPV6 w/ exceptions if field has no value |
HAS_PRIMARYIPV6() |
Determine if PRIMARYIPV6 has a value |
EnaSrdSpecification¶
Specifies the ENA Express settings for the network interface that's attached to the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENASRDSPECIFICATION() |
Getter for ENASRDSPECIFICATION |
ConnectionTrackingSpecification¶
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTIONTRACKINGSPEC() |
Getter for CONNECTIONTRACKINGSPEC |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_INSTNETWORKINTERFACESPECLST¶
TYPES TT_INSTNETWORKINTERFACESPECLST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2INSTNETWORKINTER03 WITH DEFAULT KEY
.