Class: Aws::EC2::Types::CreateNetworkInterfaceRequest

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

Overview

Note:

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

{
  description: "String",
  dry_run: false,
  groups: ["String"],
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  private_ip_address: "String",
  private_ip_addresses: [
    {
      primary: false,
      private_ip_address: "String",
    },
  ],
  secondary_private_ip_address_count: 1,
  subnet_id: "String", # required
}

Contains the parameters for CreateNetworkInterface.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the network interface.

Returns:

  • (String)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

  • (Boolean)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#groupsArray<String>

The IDs of one or more security groups.

Returns:

  • (Array<String>)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#ipv_6_address_countInteger

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses. If your subnet has the ‘AssignIpv6AddressOnCreation` attribute set to `true`, you can specify `0` to override this setting.

Returns:

  • (Integer)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#ipv_6_addressesArray<Types::InstanceIpv6Address>

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.

Returns:



5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#private_ip_addressString

The primary private IPv4 address of the network interface. If you don’t specify an IPv4 address, Amazon EC2 selects one for you from the subnet’s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in ‘privateIpAddresses` as primary (only one IP address can be designated as primary).

Returns:

  • (String)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#private_ip_addressesArray<Types::PrivateIpAddressSpecification>

One or more private IPv4 addresses.



5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#secondary_private_ip_address_countInteger

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet’s IPv4 CIDR range. You can’t specify this option and specify more than one private IP address using ‘privateIpAddresses`.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see [IP Addresses Per ENI Per Instance Type] in the *Amazon Virtual Private Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI

Returns:

  • (Integer)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end

#subnet_idString

The ID of the subnet to associate with the network interface.

Returns:

  • (String)


5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
# File 'lib/aws-sdk-ec2/types.rb', line 5956

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :subnet_id)
  include Aws::Structure
end