You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::InstanceNetworkInterfaceSpecification

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InstanceNetworkInterfaceSpecification as input to an Aws::Client method, you can use a vanilla Hash:

{
  associate_public_ip_address: false,
  delete_on_termination: false,
  description: "String",
  device_index: 1,
  groups: ["SecurityGroupId"],
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  network_interface_id: "String",
  private_ip_address: "String",
  private_ip_addresses: [
    {
      primary: false,
      private_ip_address: "String",
    },
  ],
  secondary_private_ip_address_count: 1,
  subnet_id: "String",
  associate_carrier_ip_address: false,
  interface_type: "String",
  network_card_index: 1,
}

Describes a network interface.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#associate_carrier_ip_address ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#associate_public_ip_address ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.

#delete_on_termination ⇒ Boolean

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.

Returns:

  • (Boolean) —

    If set to true, the interface is deleted when the instance is terminated.

#description ⇒ String

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

Returns:

  • (String) —

    The description of the network interface.

#device_index ⇒ Integer

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.

Returns:

  • (Integer) —

    The position of the network interface in the attachment order.

#groups ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The IDs of the security groups for the network interface.

#interface_type ⇒ String

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

Returns:

  • (String) —

    The type of network interface.

#ipv_6_address_count ⇒ Integer

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.

Returns:

  • (Integer) —

    A number of IPv6 addresses to assign to the network interface.

#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

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.

Returns:

#network_card_index ⇒ Integer

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.

Returns:

  • (Integer) —

    The index of the network card.

#network_interface_id ⇒ String

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.

Returns:

  • (String) —

    The ID of the network interface.

#private_ip_address ⇒ String

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.

Returns:

  • (String) —

    The private IPv4 address of the network interface.

#private_ip_addresses ⇒ Array<Types::PrivateIpAddressSpecification>

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.

Returns:

#secondary_private_ip_address_count ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of secondary private IPv4 addresses.

#subnet_id ⇒ String

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

Returns:

  • (String) —

    The ID of the subnet associated with the network interface.