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: ["SecurityGroupId"],
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  network_interface_id: "NetworkInterfaceId",
  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,
  ipv_4_prefixes: [
    {
      ipv_4_prefix: "String",
    },
  ],
  ipv_4_prefix_count: 1,
  ipv_6_prefixes: [
    {
      ipv_6_prefix: "String",
    },
  ],
  ipv_6_prefix_count: 1,
}

Describes a network interface.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#associate_carrier_ip_addressBoolean

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 Amazon Web Services Wavelength Developer Guide.

Returns:

  • (Boolean)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

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


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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>)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#interface_typeString

The type of network interface.

Valid values: interface | efa

Returns:

  • (String)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_4_prefix_countInteger

The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

Returns:

  • (Integer)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_4_prefixesArray<Types::Ipv4PrefixSpecificationRequest>

One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.



41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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:



41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_prefix_countInteger

The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

Returns:

  • (Integer)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_prefixesArray<Types::Ipv6PrefixSpecificationRequest>

One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.



41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#network_card_indexInteger

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.

Returns:

  • (Integer)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_idString

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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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.



41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  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)


41054
41055
41056
41057
41058
41059
41060
41061
41062
41063
41064
41065
41066
41067
41068
41069
41070
41071
41072
41073
41074
41075
41076
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 41054

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,
  :associate_carrier_ip_address,
  :interface_type,
  :network_card_index,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count)
  SENSITIVE = []
  include Aws::Structure
end