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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateNetworkInterfaceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  description: "String",
  dry_run: false,
  groups: ["SecurityGroupId"],
  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,
  interface_type: "efa", # accepts efa
  subnet_id: "SubnetId", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Contains the parameters for CreateNetworkInterface.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description for the network interface.

Returns:

  • (String) —

    A description for the network interface.

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#groups ⇒ Array<String>

The IDs of one or more security groups.

Returns:

  • (Array<String>) —

    The IDs of one or more security groups.

#interface_type ⇒ String

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String) —

    Indicates the type of network interface.

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

    The number of IPv6 addresses to assign to a network interface.

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

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

    The primary private IPv4 address of the network interface.

#private_ip_addresses ⇒ Array<Types::PrivateIpAddressSpecification>

One or more private IPv4 addresses.

Returns:

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

Returns:

  • (Integer) —

    The number of secondary private IPv4 addresses to assign to a network interface.

#subnet_id ⇒ String

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

Returns:

  • (String) —

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

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the new network interface.

Returns: