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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass InstanceNetworkInterfaceSpecification data as a hash:

{
  associate_public_ip_address: false,
  delete_on_termination: false,
  description: "String",
  device_index: 1,
  groups: ["String"],
  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",
  interface_type: "String",
}

Describes a network interface.

Instance Attribute Summary collapse

Instance Attribute Details

#associate_public_ip_addressBoolean

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#delete_on_terminationBoolean

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#device_indexInteger

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#groupsArray<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>)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#interface_typeString

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#ipv_6_address_countInteger

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#ipv_6_addressesArray<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:



24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#network_interface_idString

The ID of the network interface.

Returns:

  • (String)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#private_ip_addressString

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#private_ip_addressesArray<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.



24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#secondary_private_ip_address_countInteger

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)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end

#subnet_idString

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

Returns:

  • (String)


24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 24847

class InstanceNetworkInterfaceSpecification < Struct.new(
  :associate_public_ip_address,
  :delete_on_termination,
  :description,
  :device_index,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :network_interface_id,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id,
  :interface_type)
  include Aws::Structure
end