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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::InstanceNetworkInterfaceSpecification

Includes:

Structure

Defined in:

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",
}

Describes a network interface.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #associate_public_ip_address ⇒ 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.

• #description ⇒ String

  The description of the network interface.

• #device_index ⇒ Integer

  The index of the device on the instance for the network interface attachment.

• #groups ⇒ Array<String>

  The IDs of the security groups for the network interface.

• #ipv_6_address_count ⇒ 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.

• #network_interface_id ⇒ String

  The ID of the network interface.

• #private_ip_address ⇒ 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.

• #secondary_private_ip_address_count ⇒ Integer

  The number of secondary private IPv4 addresses.

• #subnet_id ⇒ String

  The ID of the subnet associated with the network string.

Instance Attribute Details

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

#device_index ⇒ Integer

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

• (Array<Types::InstanceIpv6Address>)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

#network_interface_id ⇒ String

The ID of the network interface.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

• (Array<Types::PrivateIpAddressSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end

#subnet_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 23007

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)
  include Aws::Structure
end