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

Class: Aws::EC2::Types::AssignPrivateIpAddressesRequest

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 AssignPrivateIpAddressesRequest data as a hash:

{
  allow_reassignment: false,
  network_interface_id: "String", # required
  private_ip_addresses: ["String"],
  secondary_private_ip_address_count: 1,
}

Contains the parameters for AssignPrivateIpAddresses.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_reassignmentBoolean

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

  • (Boolean)


509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 509

class AssignPrivateIpAddressesRequest < Struct.new(
  :allow_reassignment,
  :network_interface_id,
  :private_ip_addresses,
  :secondary_private_ip_address_count)
  include Aws::Structure
end

#network_interface_idString

The ID of the network interface.

Returns:

  • (String)


509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 509

class AssignPrivateIpAddressesRequest < Struct.new(
  :allow_reassignment,
  :network_interface_id,
  :private_ip_addresses,
  :secondary_private_ip_address_count)
  include Aws::Structure
end

#private_ip_addressesArray<String>

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Returns:

  • (Array<String>)


509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 509

class AssignPrivateIpAddressesRequest < Struct.new(
  :allow_reassignment,
  :network_interface_id,
  :private_ip_addresses,
  :secondary_private_ip_address_count)
  include Aws::Structure
end

#secondary_private_ip_address_countInteger

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Returns:

  • (Integer)


509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 509

class AssignPrivateIpAddressesRequest < Struct.new(
  :allow_reassignment,
  :network_interface_id,
  :private_ip_addresses,
  :secondary_private_ip_address_count)
  include Aws::Structure
end