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", # required
    },
  ],
  secondary_private_ip_address_count: 1,
  subnet_id: "String", # required
}

Contains the parameters for CreateNetworkInterface.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description for the network interface.

Returns:

  • (String) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_run ⇒ Boolean

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) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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

#groups ⇒ Array<String>

The IDs of one or more security groups.

Returns:

  • (Array<String>) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_count ⇒ Integer

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) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_addresses ⇒ Array<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:



3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_address ⇒ String

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) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_addresses ⇒ Array<Types::PrivateIpAddressSpecification>

One or more private IPv4 addresses.

Returns:



3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_count ⇒ Integer

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) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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_id ⇒ String

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

Returns:

  • (String) 


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/aws-sdk-ec2/types.rb', line 3271

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